[Libreoffice-commits] core.git: include/vcl

[Jan Holesovsky (via logerrit)]

 include/vcl/mtfxmldump.hxx |   17 +++++++++++++++++
 1 file changed, 17 insertions(+)

New commits:
commit 9067b827f013caafc61ef3d0d63305572a320ee2
Author:     Jan Holesovsky <ke...@collabora.com>
AuthorDate: Thu Jan 6 11:55:57 2022 +0100
Commit:     Miklos Vajna <vmik...@collabora.com>
CommitDate: Thu Jan 6 16:52:59 2022 +0100

    Add a comment how to use MetafileXmlDump in the tests
    
    Change-Id: I5088874be3fbf2ac114f5e5d0cd9571a3caf48dc
    Reviewed-on: https://gerrit.libreoffice.org/c/core/+/128040
    Reviewed-by: Miklos Vajna <vmik...@collabora.com>
    Tested-by: Jenkins

diff --git a/include/vcl/mtfxmldump.hxx b/include/vcl/mtfxmldump.hxx
index edfcaff55e4d..3425bccb710f 100644
--- a/include/vcl/mtfxmldump.hxx
+++ b/include/vcl/mtfxmldump.hxx
@@ -24,6 +24,23 @@ class SvStream;
 
 enum class MetaActionType;
 
+/**
+ * Class that is used for testing of the decomposition into shapes.  Used like
+ * this:
+ *
+ *   std::shared_ptr<GDIMetaFile> xMetaFile = xDocShRef->GetPreviewMetaFile();
+ *   MetafileXmlDump dumper;
+ *   xmlDocUniquePtr pXmlDoc = XmlTestTools::dumpAndParse(dumper, *xMetaFile);
+ *   CPPUNIT_ASSERT(pXmlDoc);
+ *
+ *   assertXPath(pXmlDoc, "/metafile/push[1]/push[1]/textarray[1]", "x", 
"2093");
+ *
+ * To see the dump to be able to create the assertXPath() call, use:
+ *
+ *   xMetaFile->dumpAsXml();
+ *
+ * and check the output in /tmp/metafile.xml
+ */
 class VCL_DLLPUBLIC MetafileXmlDump final
 {
     o3tl::enumarray<MetaActionType, bool> maFilter;