sw/source/filter/xml/xmlexpit.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: xmlexpit.hxx,v $
  10  * $Revision: 1.12 $
  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 _XMLITMPR_HXX
  32 #define _XMLITMPR_HXX
  33
  34 #include <tools/solar.h>
  35 #include <tools/ref.hxx>
  36 #include "xmlitmap.hxx"
  37
  38 #define XML_EXPORT_FLAG_DEFAULTS        0x0001          // export also default items
  39 #define XML_EXPORT_FLAG_DEEP            0x0002          // export also items from
  40                                                 // parent item sets
  41 #define XML_EXPORT_FLAG_EMPTY           0x0004          // export attribs element
  42                                                 // even if its empty
  43 #define XML_EXPORT_FLAG_IGN_WS          0x0008
  44
  45 namespace rtl { class OUString; }
  46 class SvXMLUnitConverter;
  47 class SfxPoolItem;
  48 class SfxItemSet;
  49 class SvXMLAttributeList;
  50 class SvXMLNamespaceMap;
  51 class SvUShorts;
  52 class SvXMLExport;
  53
  54
  55 class SvXMLExportItemMapper
  56 {
  57 protected:
  58     SvXMLItemMapEntriesRef mrMapEntries;
  59
  60     /** fills the given attribute list with the items in the given set */
  61     void exportXML( const SvXMLExport& rExport,
  62                     SvXMLAttributeList& rAttrList,
  63                     const SfxItemSet& rSet,
  64                     const SvXMLUnitConverter& rUnitConverter,
  65                     const SvXMLNamespaceMap& rNamespaceMap,
  66                     sal_uInt16 nFlags,
  67                     SvUShorts* pIndexArray ) const;
  68
  69     void exportXML( const SvXMLExport& rExport,
  70                     SvXMLAttributeList& rAttrList,
  71                     const SfxPoolItem& rItem,
  72                     const SvXMLItemMapEntry &rEntry,
  73                     const SvXMLUnitConverter& rUnitConverter,
  74                     const SvXMLNamespaceMap& rNamespaceMap,
  75                     sal_uInt16 nFlags,
  76                     const SfxItemSet *pSet ) const;
  77
  78
  79     void exportElementItems(  SvXMLExport& rExport,
  80                               const SvXMLUnitConverter& rUnitConverter,
  81                               const SfxItemSet &rSet,
  82                               sal_uInt16 nFlags,
  83                               const SvUShorts& rIndexArray ) const;
  84
  85     static const SfxPoolItem* GetItem( const SfxItemSet &rSet,
  86                                        sal_uInt16 nWhichId,
  87                                        sal_uInt16 nFlags );
  88
  89 public:
  90     SvXMLExportItemMapper( SvXMLItemMapEntriesRef rMapEntries );
  91     virtual ~SvXMLExportItemMapper();
  92
  93     void exportXML( SvXMLExport& rExport,
  94                     const SfxItemSet& rSet,
  95                     const SvXMLUnitConverter& rUnitConverter,
  96                     ::xmloff::token::XMLTokenEnum ePropToken,
  97                     sal_uInt16 nFlags = 0 ) const;
  98
  99     /** this method is called for every item that has the
 100         MID_SW_FLAG_SPECIAL_ITEM_EXPORT flag set */
 101     virtual void handleSpecialItem( SvXMLAttributeList& rAttrList,
 102                                     const SvXMLItemMapEntry& rEntry,
 103                                     const SfxPoolItem& rItem,
 104                                     const SvXMLUnitConverter& rUnitConverter,
 105                                     const SvXMLNamespaceMap& rNamespaceMap,
 106                                     const SfxItemSet *pSet = NULL ) const;
 107
 108
 109     /** this method is called for every item that has the
 110         MID_SW_FLAG_NO_ITEM_EXPORT flag set */
 111     virtual void handleNoItem( SvXMLAttributeList& rAttrList,
 112                                const SvXMLItemMapEntry& rEntry,
 113                                const SvXMLUnitConverter& rUnitConverter,
 114                                const SvXMLNamespaceMap& rNamespaceMap,
 115                                const SfxItemSet& rSet ) const;
 116
 117     /** this method is called for every item that has the
 118         MID_SW_FLAG_ELEMENT_EXPORT flag set */
 119     virtual void handleElementItem( SvXMLExport& rExport,
 120                                     const SvXMLItemMapEntry& rEntry,
 121                                     const SfxPoolItem& rItem,
 122                                     const SvXMLUnitConverter& rUnitConverter,
 123                                     const SfxItemSet& rSet,
 124                                     sal_uInt16 nFlags ) const;
 125
 126     inline void setMapEntries( SvXMLItemMapEntriesRef rMapEntries );
 127
 128     static sal_Bool QueryXMLValue( const SfxPoolItem& rItem,
 129                                  ::rtl::OUString& rValue, sal_uInt16 nMemberId,
 130                                  const SvXMLUnitConverter& rUnitConverter );
 131 };
 132
 133 inline void
 134 SvXMLExportItemMapper::setMapEntries( SvXMLItemMapEntriesRef rMapEntries )
 135 {
 136     mrMapEntries = rMapEntries;
 137 }
 138
 139 #endif  //  _XMLITMPR_HXX