configmgr/source/treemgr/roottreeimpl.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: roottreeimpl.hxx,v $
  10  * $Revision: 1.9 $
  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_ROOTTREEIMPL_HXX_
  32 #define CONFIGMGR_ROOTTREEIMPL_HXX_
  33
  34 #include "tree.hxx"
  35
  36 namespace configmgr
  37 {
  38 //-----------------------------------------------------------------------------
  39     namespace configuration
  40     {
  41 //-----------------------------------------------------------------------------
  42         /** is the Implementation class for class <type>Tree</type>.
  43             <p> Holds a list of <type>Node</type> which it allows to access by
  44                 <type>unsigned int</type> (which is basically a one-based index).
  45             </p>
  46             <p> Also provides for navigation to the context this tree is located in
  47             </p>
  48         */
  49         class RootTree : public Tree
  50         {
  51         public:
  52         //  Construction
  53             /// creates a Tree without a parent tree
  54             RootTree(   rtl::Reference<view::ViewStrategy> const& _xStrategy,
  55                             AbsolutePath const& aRootPath,
  56                             sharable::Node * cacheNode, unsigned int nDepth,
  57                             TemplateProvider const& aTemplateProvider);
  58
  59             // make it public
  60         private:
  61             virtual Path::Component doGetRootName() const;
  62             virtual void doFinishRootPath(Path::Rep& rPath) const;
  63
  64             AbsolutePath            m_aRootPath;
  65         };
  66 //-----------------------------------------------------------------------------
  67     }
  68 }
  69
  70 #endif // CONFIGMGR_ROOTTREEIMPL_HXX_