autodoc/inc/ary/doc/d_docu.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ARY_DOC_D_DOCU_HXX
  21 #define ARY_DOC_D_DOCU_HXX
  22
  23 // BASE CLASSES
  24 #include <cosv/tpl/processor.hxx>
  25
  26 // USED SERVICES
  27 #include <ary/doc/d_node.hxx>
  28
  29
  30
  31
  32 namespace ary
  33 {
  34 namespace doc
  35 {
  36
  37
  38 /** Represents a documentation which is assigned to an Autodoc
  39     repository entity.
  40 */
  41 class Documentation : public csv::ConstProcessorClient
  42 {
  43   public:
  44                         Documentation();
  45                         ~Documentation();
  46     // OPERATIONS
  47     void                Clear();
  48
  49     // INQUIRY
  50     const Node *        Data() const;
  51
  52     // ACCESS
  53     Node *              Data();
  54     void                Set_Data(
  55                             ary::doc::Node &    i_data );
  56
  57   private:
  58     // Interface csv::ConstProcessorClient:
  59     virtual void        do_Accept(
  60                             csv::ProcessorIfc & io_processor ) const;
  61     // DATA
  62     Dyn<Node>           pData;
  63 };
  64
  65
  66
  67
  68 // IMPLEMENTATION
  69 inline void
  70 Documentation::Clear()
  71 {
  72     pData = 0;
  73 }
  74
  75 inline const Node *
  76 Documentation::Data() const
  77 {
  78     return pData.Ptr();
  79 }
  80
  81 inline Node *
  82 Documentation::Data()
  83 {
  84     return pData.Ptr();
  85 }
  86
  87 inline void
  88 Documentation::Set_Data(ary::doc::Node & i_data)
  89 {
  90     pData = &i_data;
  91 }
  92
  93
  94
  95
  96 }   // namespace doc
  97 }   // namespace ary
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */