autodoc/inc/ary_i/d_token.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_token.hxx,v $
  10  * $Revision: 1.10 $
  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 CSI_DSAPI_D_TOKEN_HXX
  32 #define CSI_DSAPI_D_TOKEN_HXX
  33
  34 // BASE CLASSES
  35 #include <ary_i/ci_text2.hxx>
  36 #include <ary_i/ci_atag2.hxx>
  37
  38
  39 namespace ary
  40 {
  41 namespace inf
  42 {
  43     class DocumentationDisplay;
  44 }
  45 }
  46
  47
  48
  49 namespace csi
  50 {
  51 namespace dsapi
  52 {
  53
  54 using ary::inf::DocumentationDisplay;
  55
  56
  57 class DT_Dsapi : public ary::inf::DocuToken
  58 {
  59   public:
  60     virtual void                DisplayAt(
  61                             DocumentationDisplay &
  62                                                 o_rDisplay ) const  = 0;
  63     virtual bool                IsWhiteOnly() const;
  64 };
  65
  66
  67
  68 class DT_TextToken : public DT_Dsapi
  69 {
  70   public:
  71     explicit                DT_TextToken(
  72                             const char *                i_sText )
  73                                                 :       sText(i_sText) {}
  74     explicit                DT_TextToken(
  75                             const String &      i_sText )
  76                                                 :       sText(i_sText) {}
  77     virtual             ~DT_TextToken();
  78
  79     virtual void                DisplayAt(
  80                             DocumentationDisplay &
  81                                                 o_rDisplay ) const;
  82     const char *                GetText() const                 { return sText; }
  83     const String &      GetTextStr() const              { return sText; }
  84
  85     String &            Access_Text()                   { return sText; }
  86
  87     virtual bool                IsWhiteOnly() const;
  88
  89   private:
  90     String                              sText;
  91 };
  92
  93 class DT_White : public DT_Dsapi
  94 {
  95   public:
  96                         DT_White() {}
  97     virtual             ~DT_White();
  98
  99     virtual void                DisplayAt(
 100                             DocumentationDisplay &
 101                                                 o_rDisplay ) const;
 102     virtual bool                IsWhiteOnly() const;
 103 };
 104
 105
 106 class DT_MLTag : public DT_Dsapi
 107 {
 108   public:
 109     enum E_Kind
 110     {
 111         k_unknown = 0,
 112         k_begin,
 113         k_end,
 114         k_single
 115     };
 116 };
 117
 118 class DT_MupType : public DT_MLTag
 119 {
 120   public:
 121     explicit                DT_MupType(             /// Constructor for End-Tag
 122                             bool                                )       /// Must be there, but is not evaluated.
 123                                                 :       bIsBegin(false) {}
 124     explicit                DT_MupType(             /// Constructor for Begin-Tag
 125                             const String &              i_sScope )
 126                                                 :       sScope(i_sScope), bIsBegin(true) {}
 127     virtual             ~DT_MupType();
 128
 129     virtual void                DisplayAt(
 130                             DocumentationDisplay &
 131                                                 o_rDisplay ) const;
 132     const String  &             Scope() const                   { return sScope; }
 133     bool                                IsBegin() const                 { return bIsBegin; }
 134
 135   private:
 136     String                              sScope;
 137     bool                                bIsBegin;
 138 };
 139
 140 class DT_MupMember : public DT_MLTag
 141 {
 142   public:
 143     explicit                DT_MupMember(           /// Constructor for End-Tag
 144                             bool                                )       /// Must be there, but is not evaluated.
 145                                                 :       bIsBegin(false) {}
 146                         DT_MupMember(           /// Constructor for Begin-Tag
 147                             const String &      i_sScope )
 148                                                 :       sScope(i_sScope), bIsBegin(true) {}
 149     virtual             ~DT_MupMember();
 150
 151     virtual void                DisplayAt(
 152                             DocumentationDisplay &
 153                                                 o_rDisplay ) const;
 154     const String  &             Scope() const                   { return sScope; }
 155     bool                                IsBegin() const                 { return bIsBegin; }
 156
 157   private:
 158     String                              sScope;
 159     bool                                bIsBegin;
 160 };
 161
 162 class DT_MupConst : public DT_Dsapi
 163 {
 164   public:
 165                         DT_MupConst(
 166                             const char *                i_sConstText )
 167                                                 :       sConstText(i_sConstText) {}
 168     virtual             ~DT_MupConst();
 169
 170     virtual void                DisplayAt(
 171                             DocumentationDisplay &
 172                                                 o_rDisplay ) const;
 173     const char *                GetText() const                 { return sConstText; }
 174
 175   private:
 176     String                              sConstText;                             /// Without HTML.
 177 };
 178
 179
 180 class DT_Style : public DT_MLTag
 181 {
 182   public:
 183                         DT_Style(
 184                             const char *                i_sPlainHtmlTag,
 185                             bool                i_bNewLine )
 186                                                 : sText(i_sPlainHtmlTag), bNewLine(i_bNewLine) {}
 187     virtual             ~DT_Style();
 188
 189     virtual void                DisplayAt(
 190                             DocumentationDisplay &
 191                                                 o_rDisplay ) const;
 192     const char *                GetText() const                 { return sText; }
 193     bool                                IsStartOfNewLine() const
 194                                                 { return bNewLine; }
 195   private:
 196     String                              sText;                                  /// With HTML.
 197     E_Kind              eKind;
 198     bool                                bNewLine;
 199 };
 200
 201 class DT_EOL : public DT_Dsapi
 202 {
 203   public:
 204                         DT_EOL() {}
 205     virtual             ~DT_EOL();
 206
 207     virtual void                DisplayAt(
 208                             DocumentationDisplay &
 209                                                 o_rDisplay ) const;
 210     virtual bool                IsWhiteOnly() const;
 211 };
 212
 213
 214 class DT_AtTag : public ary::inf::AtTag2
 215 {
 216   public:
 217     void                AddToken(
 218                             DYN ary::inf::DocuToken &
 219                                                 let_drToken )
 220                                                 {       aText.AddToken(let_drToken); }
 221     void                                SetName(
 222                             const char *                i_sName )
 223                                                 { sTitle = i_sName; }
 224
 225   protected:
 226                         DT_AtTag(
 227                             const char *                i_sTitle )
 228                                                 :       ary::inf::AtTag2(i_sTitle) {}
 229 };
 230
 231 class DT_StdAtTag : public DT_AtTag
 232 {
 233   public:
 234     explicit                    DT_StdAtTag(
 235                             const char *                i_sTitle )
 236                                                 :       DT_AtTag(i_sTitle) {}
 237     virtual             ~DT_StdAtTag();
 238
 239     virtual void                DisplayAt(
 240                             DocumentationDisplay &
 241                                                 o_rDisplay ) const;
 242 };
 243
 244 class DT_SeeAlsoAtTag : public DT_AtTag
 245 {
 246   public:
 247                         DT_SeeAlsoAtTag()               :       DT_AtTag("") {}
 248     virtual             ~DT_SeeAlsoAtTag();
 249
 250     virtual void                DisplayAt(
 251                             DocumentationDisplay &
 252                                                 o_rDisplay ) const;
 253     const String  &             LinkText() const                { return sTitle; }      // Missbrauch von sTitle
 254 };
 255
 256 class DT_ParameterAtTag : public DT_AtTag
 257 {
 258   public:
 259                         DT_ParameterAtTag()             :       DT_AtTag("") {}
 260     virtual             ~DT_ParameterAtTag();
 261
 262     void                                SetTitle(
 263                             const char *                i_sTitle );
 264     virtual void                DisplayAt(
 265                             DocumentationDisplay &
 266                                                 o_rDisplay ) const;
 267 };
 268
 269 class DT_SinceAtTag : public DT_AtTag
 270 {
 271   public:
 272                         DT_SinceAtTag()         :       DT_AtTag("Since version") {}
 273     virtual             ~DT_SinceAtTag();
 274
 275     virtual void                DisplayAt(
 276                             DocumentationDisplay &
 277                                                 o_rDisplay ) const;
 278 };
 279
 280
 281 }   // namespace dsapi
 282 }   // namespace csi
 283
 284 #endif
 285