configmgr/source/xml/elementformatter.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: elementformatter.hxx,v $
  10  * $Revision: 1.5 $
  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 CONFIGMGR_XML_ELEMENTFORMATTER_HXX
  32 #define CONFIGMGR_XML_ELEMENTFORMATTER_HXX
  33
  34 #include "elementinfo.hxx"
  35 #include <com/sun/star/xml/sax/XAttributeList.hpp>
  36
  37 #include <rtl/ref.hxx>
  38
  39 namespace comphelper {
  40     class AttributeList;
  41 }
  42
  43 namespace configmgr
  44 {
  45 // -----------------------------------------------------------------------------
  46     namespace xml
  47     {
  48 // -----------------------------------------------------------------------------
  49         namespace uno           = ::com::sun::star::uno;
  50         namespace sax           = ::com::sun::star::xml::sax;
  51
  52 // -----------------------------------------------------------------------------
  53         class ElementFormatter
  54         {
  55         public:
  56             ElementFormatter();
  57             ~ElementFormatter();
  58
  59             /// reset the formatter for a new document
  60             void reset();
  61
  62             /// resets the formatter for a new element type
  63             void prepareElement(ElementInfo const& _aInfo);
  64
  65             /// resets the formatter for a new element type
  66             void prepareSimpleElement(ElementType::Enum _eType);
  67
  68             /// sets the instantiated type of a set item,
  69             void addInstanceType(rtl::OUString const & _aElementType, rtl::OUString const & _aElementTypeModule);
  70
  71             /// retrieve element type and associated module name of a set,
  72             void addPropertyValueType(uno::Type const& _aType);
  73
  74             /// add a language for the current element
  75             void addLanguage(rtl::OUString const & _sLanguage);
  76
  77             /// adds a value attribute to the attribute list
  78             void addIsNull(bool _bIsNull = true);
  79
  80             /// adds a value attribute to the attribute list
  81             void addSeparator(rtl::OUString const& _sSeparator);
  82
  83             /// retrieve the tag to use for the current element
  84             rtl::OUString getElementTag() const;
  85
  86             /// retrieve the attributes to use for the current element
  87             uno::Reference< sax::XAttributeList > getElementAttributes() const;
  88
  89             /// retrieve the attributes to use for an element with associated component
  90         private:
  91             void addNamespaces();
  92             /// sets an attributes for a node
  93             void addName(rtl::OUString const & _aName);
  94             /// sets attributes for nodes from the flags
  95             void addNodeFlags(sal_Int16 _eFlags);
  96             /// sets attributes for nodes from the flags
  97             void addOperation(Operation::Enum _eOp);
  98             /// sets attributes for nodes from the flags
  99             void maybeAddFlag(sal_Int16 _eFlags, sal_Int16 _eSelect,
 100                                 rtl::OUString const & _anAttributeName, bool _bValue = true);
 101
 102             /// sets attributes for nodes
 103             void addAttribute(rtl::OUString const & _anAttributeName, rtl::OUString const & _aValue);
 104             void addAttribute(rtl::OUString const & _anAttributeName, bool _bValue);
 105
 106         private:
 107             ElementType::Enum                   m_aElementType;
 108             rtl::Reference< ::comphelper::AttributeList>   m_xAttributes;
 109         };
 110 // -----------------------------------------------------------------------------
 111
 112 // -----------------------------------------------------------------------------
 113     } // namespace xml
 114 // -----------------------------------------------------------------------------
 115 } // namespace configmgr
 116
 117 #endif
 118