autodoc/inc/ary/doc/d_docu.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: d_docu.hxx,v $
  10  * $Revision: 1.3 $
  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 ARY_DOC_D_DOCU_HXX
  32 #define ARY_DOC_D_DOCU_HXX
  33
  34 // BASE CLASSES
  35 #include <cosv/tpl/processor.hxx>
  36
  37 // USED SERVICES
  38 #include <ary/doc/d_node.hxx>
  39
  40
  41
  42
  43 namespace ary
  44 {
  45 namespace doc
  46 {
  47
  48
  49 /** Represents a documentation which is assigned to an Autodoc
  50     repository entity.
  51 */
  52 class Documentation : public csv::ConstProcessorClient
  53 {
  54   public:
  55                         Documentation();
  56                         ~Documentation();
  57     // OPERATIONS
  58     void                Clear();
  59
  60     // INQUIRY
  61     const Node *        Data() const;
  62
  63     // ACCESS
  64     Node *              Data();
  65     void                Set_Data(
  66                             ary::doc::Node &    i_data );
  67
  68   private:
  69     // Interface csv::ConstProcessorClient:
  70     virtual void        do_Accept(
  71                             csv::ProcessorIfc & io_processor ) const;
  72     // DATA
  73     Dyn<Node>           pData;
  74 };
  75
  76
  77
  78
  79 // IMPLEMENTATION
  80 inline void
  81 Documentation::Clear()
  82 {
  83     pData = 0;
  84 }
  85
  86 inline const Node *
  87 Documentation::Data() const
  88 {
  89     return pData.Ptr();
  90 }
  91
  92 inline Node *
  93 Documentation::Data()
  94 {
  95     return pData.Ptr();
  96 }
  97
  98 inline void
  99 Documentation::Set_Data(ary::doc::Node & i_data)
 100 {
 101     pData = &i_data;
 102 }
 103
 104
 105
 106
 107 }   // namespace doc
 108 }   // namespace ary
 109 #endif