configmgr/source/backend/layerupdatebuilder.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: layerupdatebuilder.hxx,v $
  10  * $Revision: 1.7 $
  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_BACKEND_LAYERUPDATEBUILDER_HXX
  32 #define CONFIGMGR_BACKEND_LAYERUPDATEBUILDER_HXX
  33
  34 #include "layerupdate.hxx"
  35 #include <com/sun/star/uno/Any.hxx>
  36 #include <com/sun/star/uno/Type.hxx>
  37 #include <rtl/ustring.hxx>
  38
  39 namespace com { namespace sun { namespace star { namespace configuration { namespace backend {
  40     struct TemplateIdentifier;
  41 } } } } }
  42
  43 namespace configmgr
  44 {
  45 // -----------------------------------------------------------------------------
  46     namespace backend
  47     {
  48 // -----------------------------------------------------------------------------
  49         namespace uno = ::com::sun::star::uno;
  50         namespace backenduno = ::com::sun::star::configuration::backend;
  51 // -----------------------------------------------------------------------------
  52         class NodeUpdate;
  53         class PropertyUpdate;
  54
  55         class LayerUpdateBuilder
  56         {
  57             LayerUpdate     m_aUpdate;
  58             NodeUpdate      * m_pCurrentNode;
  59             PropertyUpdate  * m_pCurrentProp;
  60         public:
  61             LayerUpdateBuilder();
  62
  63         public:
  64             /// initialize the update
  65             bool init();
  66
  67             bool modifyNode(rtl::OUString const & _aName, sal_Int16 _nFlags, sal_Int16 _nFlagsMask, sal_Bool _bReset);
  68             bool replaceNode(rtl::OUString const & _aName, sal_Int16 _nFlags, backenduno::TemplateIdentifier const * _pTemplate = NULL);
  69             bool finishNode();
  70
  71             bool removeNode(rtl::OUString const & _aName);
  72
  73             bool modifyProperty(rtl::OUString const & _aName, sal_Int16 _nFlags, sal_Int16 _nFlagsMask, uno::Type const & _aType);
  74             bool setPropertyValue(uno::Any const & _aValue);
  75             bool setPropertyValueForLocale(uno::Any const & _aValue, rtl::OUString const & _aLocale);
  76             bool resetPropertyValue();
  77             bool resetPropertyValueForLocale(rtl::OUString const & _aLocale);
  78             bool finishProperty();
  79
  80             bool addNullProperty(rtl::OUString const & _aName, sal_Int16 _nFlags, uno::Type const & _aType);
  81             bool addProperty(rtl::OUString const & _aName, sal_Int16 _nFlags, uno::Any const & _aValue);
  82             bool resetProperty(rtl::OUString const & _aName);
  83
  84             bool finish();
  85             void clear();
  86
  87             bool isEmpty()      const;
  88             bool isActive()     const;
  89 #if OSL_DEBUG_LEVEL > 0
  90             bool isComplete()   const;
  91 #endif
  92             bool isPropertyActive()     const;
  93
  94             LayerUpdate const & result() const;
  95         private:
  96             LayerUpdate & data();
  97         };
  98 // -----------------------------------------------------------------------------
  99
 100     } // namespace backend
 101 // -----------------------------------------------------------------------------
 102
 103 } // namespace configmgr
 104 #endif
 105
 106
 107
 108