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 <sal/types.h>
  24
  25 namespace com::sun::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     SvXMLExport& mrExport;
  39
  40 public:
  41     XMLImageMapExport(SvXMLExport& rExport);
  42
  43     ~XMLImageMapExport();
  44
  45     /**
  46      * Get the ImageMap object from the "ImageMap" property and subsequently
  47      * export the map (if present).
  48      */
  49     void Export(
  50         /// the property set containing the ImageMap property
  51         const css::uno::Reference< css::beans::XPropertySet> & rPropertySet);
  52     /**
  53      * Export an ImageMap (XIndexContainer).
  54      */
  55     void Export(
  56         /// the container containing the image map elements
  57         const css::uno::Reference< css::container::XIndexContainer> & rContainer);
  58
  59 private:
  60
  61     /**
  62      * Export a single, named map entry.
  63      * (as given by com.sun.star.image.ImageMapObject)
  64      * Calls methods for specific image map entries.
  65      */
  66     void ExportMapEntry(
  67         const css::uno::Reference< css::beans::XPropertySet> & rPropertySet);
  68
  69     /**
  70      * Export the specifics of a rectangular image map entry.
  71      * To be called by ExportMapEntry.
  72      */
  73     void ExportRectangle(
  74         const css::uno::Reference< css::beans::XPropertySet> & rPropertySet);
  75
  76     /**
  77      * Export the specifics of a circular image map entry.
  78      * To be called by ExportMapEntry.
  79      */
  80     void ExportCircle(
  81         const css::uno::Reference< css::beans::XPropertySet> & rPropertySet);
  82
  83     /**
  84      * Export the specifics of a polygonal image map entry;
  85      * To be called by ExportMapEntry.
  86      */
  87     void ExportPolygon(
  88         const css::uno::Reference< css::beans::XPropertySet> & rPropertySet);
  89 };
  90
  91 #endif
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */