configmgr/source/inc/treesegment.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: treesegment.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 INCLUDED_CONFIGMGR_SOURCE_INC_TREESEGMENT_HXX
  32 #define INCLUDED_CONFIGMGR_SOURCE_INC_TREESEGMENT_HXX
  33
  34 #include "sal/config.h"
  35
  36 #include <memory>
  37
  38 #include "rtl/ref.hxx"
  39 #include "salhelper/simplereferenceobject.hxx"
  40
  41 namespace rtl { class OUString; }
  42
  43 namespace configmgr {
  44     class INode;
  45     namespace sharable { struct TreeFragment; }
  46
  47     namespace data {
  48         // rtl::Reference< TreeSegment > is a reference counted
  49         // sharable::TreeFragment *.  A null reference is always modeled as an
  50         // empty rtl::Reference< TreeSegment >, never as a null fragment.
  51         class TreeSegment: public salhelper::SimpleReferenceObject {
  52         public:
  53             static rtl::Reference< TreeSegment > create(
  54                 std::auto_ptr< INode > tree, rtl::OUString const & type);
  55
  56             static rtl::Reference< TreeSegment > create(
  57                 rtl::OUString const & name, std::auto_ptr< INode > tree);
  58
  59             static rtl::Reference< TreeSegment > create(
  60                 sharable::TreeFragment * tree);
  61
  62             static rtl::Reference< TreeSegment > create(
  63                 rtl::Reference< TreeSegment > const & tree)
  64             { return create(tree.is() ? tree->fragment : 0); }
  65
  66             sharable::TreeFragment * const fragment; // non-null
  67
  68         private:
  69             TreeSegment(sharable::TreeFragment * tree);
  70
  71             virtual ~TreeSegment();
  72         };
  73     }
  74 }
  75
  76 #endif