autodoc/inc/ary/doc/d_parametrized.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_parametrized.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_PARAMETER_HXX
  32 #define ARY_DOC_D_PARAMETER_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include <ary/doc/d_node.hxx>
  37
  38 namespace ary
  39 {
  40 namespace doc
  41 {
  42
  43
  44 /** Documentation unit with Parameter.
  45 */
  46 template <class T>
  47 class Parametrized : public Node
  48 {
  49   public:
  50     // LIFECYCLE
  51     explicit                    Parametrized(
  52                             nodetype::id        i_id,
  53                             T                   i_Parameter );
  54     virtual                             ~Parametrized();
  55
  56     // INQUIRY
  57     const HyperText &   Doc() const;
  58     const T &           Parameter() const;
  59
  60     // ACESS
  61     HyperText &         Doc();
  62     void                Set_Parameter(
  63                             const T &           i_param );
  64   private:
  65     // Interface csv::ConstProcessorClient:
  66     virtual void        do_Accept(
  67                             csv::ProcessorIfc & io_processor ) const;
  68     // DATA
  69     HyperText           aDoc;
  70     T                   aParameter;
  71 };
  72
  73
  74
  75
  76 // IMPLEMENTATION
  77 template <class T>
  78 Parametrized<T>::Parametrized( nodetype::id     i_id,
  79                                T                i_Parameter )
  80     :   Node(i_id),
  81         aDoc(),
  82         aParameter(i_Parameter)
  83 {
  84 }
  85
  86 template <class T>
  87 Parametrized<T>::~Parametrized()
  88 {
  89 }
  90
  91 template <class T>
  92 const HyperText &
  93 Parametrized<T>::Doc() const
  94 {
  95     return aDoc;
  96 }
  97
  98 template <class T>
  99 const T &
 100 Parametrized<T>::Parameter() const
 101 {
 102     return aParameter;
 103 }
 104
 105 template <class T>
 106 HyperText &
 107 Parametrized<T>::Doc()
 108 {
 109     return aDoc;
 110 }
 111
 112 template <class T>
 113 inline void
 114 Parametrized<T>::Set_Parameter(const T & i_param)
 115 {
 116     aParameter = i_param;
 117 }
 118
 119
 120
 121
 122 }   // namespace doc
 123 }   // namespace ary
 124 #endif