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