mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

sw content controls, alias and tag: add ODT filter

Browse Source 
Map the Alias/Tag UNO properties to:

        <loext:content-control loext:alias="..." loext:tag="...">

on export, and do the opposite on import.

Change-Id: Icecbe9037ede0bf8d72d52f2db44328a8db1d83a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/141492
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
Tested-by: Jenkins
This commit is contained in:
Miklos Vajna 2022-10-18 11:33:20 +02:00
parent 36bffa3cb5
commit 888a8c3ca7
9 changed files with 134 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/xmloff/xmltoken.hxx
View File

@ -3508,6 +3508,8 @@ namespace xmloff::token {
XML_DATE_FORMAT,
XML_DATE_RFC_LANGUAGE_TAG,
XML_PLAIN_TEXT,
XML_ALIAS,
XML_TAG,
XML_FILL_USE_SLIDE_BACKGROUND,

10
schema/libreoffice/OpenDocument-v1.3+libreoffice-schema.rng
View File

@ -2992,6 +2992,16 @@ xmlns:loext="urn:org:documentfoundation:names:experimental:office:xmlns:loext:1.
<rng:ref name="boolean"/>
</rng:attribute>
</rng:optional>
<rng:optional>
<rng:attribute name="loext:alias">
<rng:ref name="string"/>
</rng:attribute>
</rng:optional>
<rng:optional>
<rng:attribute name="loext:tag">
<rng:ref name="string"/>
</rng:attribute>
</rng:optional>
<rng:zeroOrMore>
<rng:element name="loext:list-item">
<rng:attribute name="loext:display-text">

8
xmloff/qa/unit/data/content-control-alias.fodt Normal file
View File

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<office:document xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:loext="urn:org:documentfoundation:names:experimental:office:xmlns:loext:1.0" office:version="1.3" office:mimetype="application/vnd.oasis.opendocument.text">
<office:body>
<office:text>
<text:p><loext:content-control loext:alias="my alias" loext:tag="my tag">test</loext:content-control></text:p>
</office:text>
</office:body>
</office:document>

74
xmloff/qa/unit/text.cxx
View File

@ -935,6 +935,45 @@ CPPUNIT_TEST_FIXTURE(XmloffStyleTest, testComboBoxContentControlExport)
assertXPath(pXmlDoc, "//loext:content-control", "combobox", "true");
}
CPPUNIT_TEST_FIXTURE(XmloffStyleTest, testAliasContentControlExport)
{
// Given a document with a content control and its alias around a text portion:
getComponent() = loadFromDesktop("private:factory/swriter");
uno::Reference<lang::XMultiServiceFactory> xMSF(getComponent(), uno::UNO_QUERY);
uno::Reference<text::XTextDocument> xTextDocument(getComponent(), uno::UNO_QUERY);
uno::Reference<text::XText> xText = xTextDocument->getText();
uno::Reference<text::XTextCursor> xCursor = xText->createTextCursor();
xText->insertString(xCursor, "test", /*bAbsorb=*/false);
xCursor->gotoStart(/*bExpand=*/false);
xCursor->gotoEnd(/*bExpand=*/true);
uno::Reference<text::XTextContent> xContentControl(
xMSF->createInstance("com.sun.star.text.ContentControl"), uno::UNO_QUERY);
uno::Reference<beans::XPropertySet> xContentControlProps(xContentControl, uno::UNO_QUERY);
xContentControlProps->setPropertyValue("Alias", uno::Any(OUString("my alias")));
xContentControlProps->setPropertyValue("Tag", uno::Any(OUString("my tag")));
xText->insertTextContent(xCursor, xContentControl, /*bAbsorb=*/true);
// When exporting to ODT:
uno::Reference<frame::XStorable> xStorable(getComponent(), uno::UNO_QUERY);
uno::Sequence<beans::PropertyValue> aStoreProps = comphelper::InitPropertySequence({
{ "FilterName", uno::Any(OUString("writer8")) },
});
utl::TempFileNamed aTempFile;
aTempFile.EnableKillingFile();
xStorable->storeToURL(aTempFile.GetURL(), aStoreProps);
validate(aTempFile.GetFileName(), test::ODF);
// Then make sure the expected markup is used:
std::unique_ptr<SvStream> pStream = parseExportStream(aTempFile, "content.xml");
xmlDocUniquePtr pXmlDoc = parseXmlStream(pStream.get());
// Without the accompanying fix in place, this test would have failed with:
// - Expression: prop
// - XPath '//loext:content-control' no attribute 'alias' exist
// i.e. alias was lost on export.
assertXPath(pXmlDoc, "//loext:content-control", "alias", "my alias");
assertXPath(pXmlDoc, "//loext:content-control", "tag", "my tag");
}
CPPUNIT_TEST_FIXTURE(XmloffStyleTest, testComboBoxContentControlImport)
{
// Given an ODF document with a plain-text content control:
@ -965,6 +1004,41 @@ CPPUNIT_TEST_FIXTURE(XmloffStyleTest, testComboBoxContentControlImport)
CPPUNIT_ASSERT(bComboBox);
}
CPPUNIT_TEST_FIXTURE(XmloffStyleTest, testAliasContentControlImport)
{
// Given an ODF document with a content control and its alias/tag:
OUString aURL = m_directories.getURLFromSrc(DATA_DIRECTORY) + "content-control-alias.fodt";
// When loading that document:
getComponent() = loadFromDesktop(aURL);
// Then make sure that the content control is not lost on import:
uno::Reference<text::XTextDocument> xTextDocument(getComponent(), uno::UNO_QUERY);
uno::Reference<container::XEnumerationAccess> xParagraphsAccess(xTextDocument->getText(),
uno::UNO_QUERY);
uno::Reference<container::XEnumeration> xParagraphs = xParagraphsAccess->createEnumeration();
uno::Reference<container::XEnumerationAccess> xParagraph(xParagraphs->nextElement(),
uno::UNO_QUERY);
uno::Reference<container::XEnumeration> xPortions = xParagraph->createEnumeration();
uno::Reference<beans::XPropertySet> xTextPortion(xPortions->nextElement(), uno::UNO_QUERY);
OUString aPortionType;
xTextPortion->getPropertyValue("TextPortionType") >>= aPortionType;
CPPUNIT_ASSERT_EQUAL(OUString("ContentControl"), aPortionType);
uno::Reference<text::XTextContent> xContentControl;
xTextPortion->getPropertyValue("ContentControl") >>= xContentControl;
uno::Reference<beans::XPropertySet> xContentControlProps(xContentControl, uno::UNO_QUERY);
OUString aAlias;
xContentControlProps->getPropertyValue("Alias") >>= aAlias;
// Without the accompanying fix in place, this test would have failed with:
// - Expected: my alias
// - Actual :
// i.e. the alias was lost on import.
CPPUNIT_ASSERT_EQUAL(OUString("my alias"), aAlias);
OUString aTag;
xContentControlProps->getPropertyValue("Tag") >>= aTag;
CPPUNIT_ASSERT_EQUAL(OUString("my tag"), aTag);
}
CPPUNIT_TEST_FIXTURE(XmloffStyleTest, testDropdownContentControlAutostyleExport)
{
// Given a document with a dropdown content control, and formatting that forms an autostyle in

2
xmloff/source/core/xmltoken.cxx
View File

@ -3511,6 +3511,8 @@ namespace xmloff::token {
TOKEN("date-format", XML_DATE_FORMAT),
TOKEN("date-rfc-language-tag", XML_DATE_RFC_LANGUAGE_TAG),
TOKEN("plain-text", XML_PLAIN_TEXT),
TOKEN("alias", XML_ALIAS),
TOKEN("tag", XML_TAG),
TOKEN("fill-use-slide-background", XML_FILL_USE_SLIDE_BACKGROUND),

14
xmloff/source/text/txtparae.cxx
View File

@ -4036,6 +4036,20 @@ void XMLTextParagraphExport::ExportContentControl(
sax::Converter::convertBool(aBuffer, bComboBox);
GetExport().AddAttribute(XML_NAMESPACE_LO_EXT, XML_COMBOBOX, aBuffer.makeStringAndClear());
}
OUString aAlias;
xPropertySet->getPropertyValue("Alias") >>= aAlias;
if (!aAlias.isEmpty())
{
GetExport().AddAttribute(XML_NAMESPACE_LO_EXT, XML_ALIAS, aAlias);
}
OUString aTag;
xPropertySet->getPropertyValue("Tag") >>= aTag;
if (!aTag.isEmpty())
{
GetExport().AddAttribute(XML_NAMESPACE_LO_EXT, XML_TAG, aTag);
}
}
SvXMLElementExport aElem(GetExport(), bExport, XML_NAMESPACE_LO_EXT, XML_CONTENT_CONTROL, false,

20
xmloff/source/text/xmlcontentcontrolcontext.cxx
View File

@ -133,6 +133,16 @@ void XMLContentControlContext::startFastElement(
}
break;
}
case XML_ELEMENT(LO_EXT, XML_ALIAS):
{
m_aAlias = rIter.toString();
break;
}
case XML_ELEMENT(LO_EXT, XML_TAG):
{
m_aTag = rIter.toString();
break;
}
default:
XMLOFF_WARN_UNKNOWN("xmloff", rIter);
}
@ -228,6 +238,16 @@ void XMLContentControlContext::endFastElement(sal_Int32)
{
xPropertySet->setPropertyValue("ComboBox", uno::Any(m_bComboBox));
}
if (!m_aAlias.isEmpty())
{
xPropertySet->setPropertyValue("Alias", uno::Any(m_aAlias));
}
if (!m_aTag.isEmpty())
{
xPropertySet->setPropertyValue("Tag", uno::Any(m_aTag));
}
}
css::uno::Reference<css::xml::sax::XFastContextHandler>

2
xmloff/source/text/xmlcontentcontrolcontext.hxx
View File

@ -50,6 +50,8 @@ class XMLContentControlContext : public SvXMLImportContext
OUString m_aCurrentDate;
bool m_bPlainText = false;
bool m_bComboBox = false;
OUString m_aAlias;
OUString m_aTag;
public:
XMLContentControlContext(SvXMLImport& rImport, sal_Int32 nElement, XMLHints_Impl& rHints,

2
xmloff/source/token/tokens.txt
View File

@ -3254,5 +3254,7 @@ picture
date-format
date-rfc-language-tag
plain-text
alias
tag
fill-use-slide-background
TOKEN_END_DUMMY