xmloff/inc/XMLImageMapExport.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_XMLOFF_INC_XMLIMAGEMAPEXPORT_HXX
  21 #define INCLUDED_XMLOFF_INC_XMLIMAGEMAPEXPORT_HXX
  22
  23 #include <rtl/ustring.hxx>
  24
  25 namespace com { namespace sun { namespace star {
  26     namespace uno { template<class X> class Reference; }
  27     namespace beans { class XPropertySet; }
  28     namespace container { class XIndexContainer; }
  29 } } }
  30 class SvXMLExport;
  31
  32
  33 /**
  34  * Export an ImageMap as defined by service com.sun.star.image.ImageMap to XML.
  35  */
  36 class XMLImageMapExport
  37 {
  38     const OUString msBoundary;
  39     const OUString msCenter;
  40     const OUString msDescription;
  41     const OUString msImageMap;
  42     const OUString msIsActive;
  43     const OUString msName;
  44     const OUString msPolygon;
  45     const OUString msRadius;
  46     const OUString msTarget;
  47     const OUString msURL;
  48     const OUString msTitle;
  49
  50     SvXMLExport& mrExport;
  51
  52     bool mbWhiteSpace;  /// use whitespace between image map elements?
  53
  54 public:
  55     XMLImageMapExport(SvXMLExport& rExport);
  56
  57     ~XMLImageMapExport();
  58
  59     /**
  60      * Get the ImageMap object from the "ImageMap" property and subsequently
  61      * export the map (if present).
  62      */
  63     void Export(
  64         /// the property set containing the ImageMap property
  65         const ::com::sun::star::uno::Reference<
  66             ::com::sun::star::beans::XPropertySet> & rPropertySet);
  67     /**
  68      * Export an ImageMap (XIndexContainer).
  69      */
  70     void Export(
  71         /// the container containing the image map elements
  72         const ::com::sun::star::uno::Reference<
  73             ::com::sun::star::container::XIndexContainer> & rContainer);
  74
  75 protected:
  76
  77     /**
  78      * Export a single, named map entry.
  79      * (as given by com.sun.star.image.ImageMapObject)
  80      * Calls methods for specific image map entries.
  81      */
  82     void ExportMapEntry(
  83         const ::com::sun::star::uno::Reference<
  84             ::com::sun::star::beans::XPropertySet> & rPropertySet);
  85
  86     /**
  87      * Export the specifics of a rectangular image map entry.
  88      * To be called by ExportMapEntry.
  89      */
  90     void ExportRectangle(
  91         const ::com::sun::star::uno::Reference<
  92             ::com::sun::star::beans::XPropertySet> & rPropertySet);
  93
  94     /**
  95      * Export the specifics of a circular image map entry.
  96      * To be called by ExportMapEntry.
  97      */
  98     void ExportCircle(
  99         const ::com::sun::star::uno::Reference<
 100             ::com::sun::star::beans::XPropertySet> & rPropertySet);
 101
 102     /**
 103      * Export the specifics of a polygonal image map entry;
 104      * To be called by ExportMapEntry.
 105      */
 106     void ExportPolygon(
 107         const ::com::sun::star::uno::Reference<
 108             ::com::sun::star::beans::XPropertySet> & rPropertySet);
 109 };
 110
 111 #endif
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */