autodoc/inc/ary_i/disdocum.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: disdocum.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 ARY_DISDOCUM_HXX
  32 #define ARY_DISDOCUM_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39     // PARAMETERS
  40
  41
  42 namespace csi
  43 {
  44 namespace dsapi
  45 {
  46 class DT_TextToken;
  47 class DT_MupType;
  48 class DT_MupMember;
  49 class DT_MupConst;
  50 class DT_Style;
  51 class DT_EOL;
  52 class DT_StdAtTag;
  53 class DT_SeeAlsoAtTag;
  54 class DT_ParameterAtTag;
  55 class DT_SinceAtTag;
  56 }   // namespace dsapi
  57 }   // namespace csi
  58
  59
  60 namespace ary
  61 {
  62 namespace inf
  63 {
  64
  65
  66
  67 class DocumentationDisplay
  68 {
  69   public:
  70
  71     virtual                             ~DocumentationDisplay() { }
  72
  73     virtual void                Display_TextToken(
  74                             const csi::dsapi::DT_TextToken &
  75                                                 i_rToken ) = 0;
  76     virtual void                Display_White() = 0;
  77     virtual void                Display_MupType(
  78                             const csi::dsapi::DT_MupType &      i_rToken ) = 0;
  79     virtual void                Display_MupMember(
  80                             const csi::dsapi::DT_MupMember &
  81                                                 i_rToken ) = 0;
  82     virtual void                Display_MupConst(
  83                             const csi::dsapi::DT_MupConst &
  84                                                 i_rToken ) = 0;
  85     virtual void                Display_Style(
  86                             const csi::dsapi::DT_Style &        i_rToken ) = 0;
  87     virtual void                Display_EOL() = 0;
  88     virtual void                Display_StdAtTag(
  89                             const csi::dsapi::DT_StdAtTag &
  90                                                 i_rToken ) = 0;
  91     virtual void                Display_SeeAlsoAtTag(
  92                             const csi::dsapi::DT_SeeAlsoAtTag &
  93                                                 i_rToken ) = 0;
  94     virtual void                Display_ParameterAtTag(
  95                             const csi::dsapi::DT_ParameterAtTag &
  96                                                 i_rToken ) = 0;
  97     virtual void                Display_SinceAtTag(
  98                             const csi::dsapi::DT_SinceAtTag &
  99                                                 i_rToken ) = 0;
 100 };
 101
 102
 103 class DocuTag_Display : public DocumentationDisplay
 104 {
 105   public:
 106     // Dummies, implemented in source\ary_i\kernel\ci_atag2.cxx
 107     virtual void                Display_TextToken(
 108                             const csi::dsapi::DT_TextToken &
 109                                                 i_rToken );
 110     virtual void                Display_White();
 111     virtual void                Display_MupType(
 112                             const csi::dsapi::DT_MupType &      i_rToken );
 113     virtual void                Display_MupMember(
 114                             const csi::dsapi::DT_MupMember &
 115                                                 i_rToken );
 116     virtual void                Display_MupConst(
 117                             const csi::dsapi::DT_MupConst &
 118                                                 i_rToken );
 119     virtual void                Display_Style(
 120                             const csi::dsapi::DT_Style &        i_rToken );
 121     virtual void                Display_EOL();
 122 };
 123
 124 class DocuText_Display : public DocumentationDisplay
 125 {
 126   public:
 127     // Dummies, implemented in source\ary_i\kernel\ci_text2.cxx
 128     virtual void                Display_StdAtTag(
 129                             const csi::dsapi::DT_StdAtTag &
 130                                                 i_rToken );
 131     virtual void                Display_SeeAlsoAtTag(
 132                             const csi::dsapi::DT_SeeAlsoAtTag &
 133                                                 i_rToken );
 134     virtual void                Display_ParameterAtTag(
 135                             const csi::dsapi::DT_ParameterAtTag &
 136                                                 i_rToken );
 137     virtual void                Display_SinceAtTag(
 138                             const csi::dsapi::DT_SinceAtTag &
 139                                                 i_rToken );
 140 };
 141
 142
 143
 144 }   // namespace inf
 145 }   // namespace ary
 146
 147
 148 #endif
 149