configmgr/source/inc/treechangefactory.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: treechangefactory.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_TREE_CHANGEFACTORY_HXX
  32 #define CONFIGMGR_TREE_CHANGEFACTORY_HXX
  33
  34 #include "change.hxx"
  35
  36 #ifndef INCLUDED_MEMORY
  37 #include <memory>
  38 #define INCLUDED_MEMORY
  39 #endif
  40
  41
  42 namespace configmgr
  43 {
  44
  45     namespace uno = ::com::sun::star::uno;
  46
  47     //==========================================================================
  48
  49     class OTreeChangeFactory
  50     {
  51     public:
  52         //-----------------------------------------------
  53         std::auto_ptr<SubtreeChange> createSetNodeChange(
  54                                         rtl::OUString const& _aName,
  55                                         rtl::OUString const& _aTemplateName,
  56                                         rtl::OUString const& _aTemplateModule,
  57                                         node::Attributes _aAttrs,
  58                                         bool _bToDefault = false);
  59         //-----------------------------------------------
  60
  61     //= Set Changes ============================================================
  62         std::auto_ptr<AddNode>      createAddNodeChange(
  63             rtl::Reference< data::TreeSegment > const & _aNewTree,
  64                                         rtl::OUString const& _aName,
  65                                         bool _bToDefault = false);
  66
  67         //-----------------------------------------------
  68         std::auto_ptr<RemoveNode>   createRemoveNodeChange(
  69                                         rtl::OUString const& _aName,
  70                                         bool _bToDefault = false);
  71
  72     //= special case: Dummy ISubtree ============================================================
  73         static std::auto_ptr<SubtreeChange> createDummyChange(
  74             rtl::OUString const& _aName,
  75             rtl::OUString const& _aElementTypeName);
  76
  77     //-----------------------------------------------
  78     };
  79
  80     OTreeChangeFactory& getDefaultTreeChangeFactory();
  81     //==========================================================================
  82     inline
  83     std::auto_ptr<Change> base_ptr(std::auto_ptr<SubtreeChange> pChange)
  84     { return std::auto_ptr<Change>(pChange.release()); }
  85     //==========================================================================
  86     inline
  87     std::auto_ptr<Change> base_ptr(std::auto_ptr<ValueChange> pChange)
  88     { return std::auto_ptr<Change>(pChange.release()); }
  89     //==========================================================================
  90     inline
  91     std::auto_ptr<Change> base_ptr(std::auto_ptr<AddNode> pChange)
  92     { return std::auto_ptr<Change>(pChange.release()); }
  93     //==========================================================================
  94     inline
  95     std::auto_ptr<Change> base_ptr(std::auto_ptr<RemoveNode> pChange)
  96     { return std::auto_ptr<Change>(pChange.release()); }
  97     //==========================================================================
  98
  99     bool isGenericSetElementType(rtl::OUString const& _aElementType);
 100     bool isDummySetElementModule(rtl::OUString const& _aElementModule);
 101     rtl::OUString getGenericSetElementType();
 102     rtl::OUString getDummySetElementModule();
 103     //==========================================================================
 104
 105 } // namespace configmgr
 106
 107 #endif