configmgr/source/inc/configdefaultprovider.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: configdefaultprovider.hxx,v $
  10  * $Revision: 1.8 $
  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_CONFIG_DEFAULTPROVIDER_HXX_
  32 #define CONFIGMGR_CONFIG_DEFAULTPROVIDER_HXX_
  33
  34 #include "utility.hxx"
  35 #include <com/sun/star/uno/Exception.hpp>
  36 #include <rtl/ref.hxx>
  37
  38 #ifndef INCLUDED_MEMORY
  39 #include <memory>
  40 #define INCLUDED_MEMORY
  41 #endif
  42
  43 namespace configmgr
  44 {
  45 //-----------------------------------------------------------------------------
  46     class ISubtree;
  47     class IDefaultableTreeManager;
  48     class RequestOptions;
  49     class TreeManager;
  50
  51     namespace uno = com::sun::star::uno;
  52 //-----------------------------------------------------------------------------
  53     namespace configuration
  54     {
  55 //-----------------------------------------------------------------------------
  56
  57         class Tree;
  58         class NodeRef;
  59 //-----------------------------------------------------------------------------
  60
  61         /// provides access to the default for a given request
  62         class DefaultProviderProxy;
  63
  64         class DefaultProvider
  65         {
  66             rtl::Reference< DefaultProviderProxy > m_aProxy;
  67         public:
  68             // factory methods
  69             static DefaultProvider createEmpty();
  70             static DefaultProvider create(rtl::Reference< Tree > const& _aRootTree,
  71                                           RequestOptions const& _xOptions,
  72                                           rtl::Reference< TreeManager > const & _xDefaultProvider,
  73                                           IDefaultableTreeManager* _pDefaultableTree);
  74
  75             // actual c'tor
  76             explicit
  77             DefaultProvider(rtl::Reference< DefaultProviderProxy > const& _xProviderProxy);
  78
  79         // standard c/d-tors to make compiler barrier
  80             DefaultProvider(DefaultProvider const& _aOther);
  81             DefaultProvider& operator=(DefaultProvider const& _aOther);
  82             ~DefaultProvider();
  83
  84             bool isValid() const { return !! m_aProxy.is(); }
  85
  86         /// tries to load a default instance of the specified node
  87             std::auto_ptr<ISubtree> getDefaultTree(rtl::Reference< Tree > const& _aTree, NodeRef const& _aNode) const SAL_THROW((com::sun::star::uno::Exception));
  88
  89         /// tries to load default data into the specified tree
  90             bool fetchDefaultData(rtl::Reference< Tree > const& _aTreeRef) const SAL_THROW((com::sun::star::uno::Exception));
  91         };
  92
  93 //-----------------------------------------------------------------------------
  94
  95     }
  96 }
  97
  98 #endif // CONFIGMGR_CONFIG_DEFAULTPROVIDER_HXX_