xmloff/inc/XMLImageMapExport.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XMLImageMapExport.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _XMLOFF_XMLIMAGEMAPEXPORT_HXX_
  32 #define _XMLOFF_XMLIMAGEMAPEXPORT_HXX_
  33
  34 #include <rtl/ustring.hxx>
  35
  36 namespace com { namespace sun { namespace star {
  37     namespace uno { template<class X> class Reference; }
  38     namespace beans { class XPropertySet; }
  39     namespace container { class XIndexContainer; }
  40 } } }
  41 class SvXMLExport;
  42
  43
  44 /**
  45  * Export an ImageMap as defined by service com.sun.star.image.ImageMap to XML.
  46  */
  47 class XMLImageMapExport
  48 {
  49     const ::rtl::OUString msBoundary;
  50     const ::rtl::OUString msCenter;
  51     const ::rtl::OUString msDescription;
  52     const ::rtl::OUString msImageMap;
  53     const ::rtl::OUString msIsActive;
  54     const ::rtl::OUString msName;
  55     const ::rtl::OUString msPolygon;
  56     const ::rtl::OUString msRadius;
  57     const ::rtl::OUString msTarget;
  58     const ::rtl::OUString msURL;
  59     const ::rtl::OUString msTitle;
  60
  61     SvXMLExport& mrExport;
  62
  63     sal_Bool mbWhiteSpace;      /// use whitespace between image map elements?
  64
  65 public:
  66     XMLImageMapExport(SvXMLExport& rExport);
  67
  68     ~XMLImageMapExport();
  69
  70     /**
  71      * Get the ImageMap object from the "ImageMap" property and subsequently
  72      * export the map (if present).
  73      */
  74     void Export(
  75         /// the property set containing the ImageMap property
  76         const ::com::sun::star::uno::Reference<
  77             ::com::sun::star::beans::XPropertySet> & rPropertySet);
  78     /**
  79      * Export an ImageMap (XIndexContainer).
  80      */
  81     void Export(
  82         /// the container containing the image map elements
  83         const ::com::sun::star::uno::Reference<
  84             ::com::sun::star::container::XIndexContainer> & rContainer);
  85
  86 protected:
  87
  88     /**
  89      * Export a single, named map entry.
  90      * (as given by com.sun.star.image.ImageMapObject)
  91      * Calls methods for specific image map entries.
  92      */
  93     void ExportMapEntry(
  94         const ::com::sun::star::uno::Reference<
  95             ::com::sun::star::beans::XPropertySet> & rPropertySet);
  96
  97     /**
  98      * Export the specifics of a rectangular image map entry.
  99      * To be called by ExportMapEntry.
 100      */
 101     void ExportRectangle(
 102         const ::com::sun::star::uno::Reference<
 103             ::com::sun::star::beans::XPropertySet> & rPropertySet);
 104
 105     /**
 106      * Export the specifics of a circular image map entry.
 107      * To be called by ExportMapEntry.
 108      */
 109     void ExportCircle(
 110         const ::com::sun::star::uno::Reference<
 111             ::com::sun::star::beans::XPropertySet> & rPropertySet);
 112
 113     /**
 114      * Export the specifics of a polygonal image map entry;
 115      * To be called by ExportMapEntry.
 116      */
 117     void ExportPolygon(
 118         const ::com::sun::star::uno::Reference<
 119             ::com::sun::star::beans::XPropertySet> & rPropertySet);
 120 };
 121
 122 #endif