1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef CSI_DSAPI_D_TOKEN_HXX
#define CSI_DSAPI_D_TOKEN_HXX
// BASE CLASSES
#include <ary_i/ci_text2.hxx>
#include <ary_i/ci_atag2.hxx>
namespace ary
{
namespace inf
{
class DocumentationDisplay;
}
}
namespace csi
{
namespace dsapi
{
using ary::inf::DocumentationDisplay;
class DT_Dsapi : public ary::inf::DocuToken
{
public:
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const = 0;
virtual bool IsWhiteOnly() const;
};
class DT_TextToken : public DT_Dsapi
{
public:
explicit DT_TextToken(
const char * i_sText )
: sText(i_sText) {}
explicit DT_TextToken(
const String & i_sText )
: sText(i_sText) {}
virtual ~DT_TextToken();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
const char * GetText() const { return sText; }
const String & GetTextStr() const { return sText; }
String & Access_Text() { return sText; }
virtual bool IsWhiteOnly() const;
private:
String sText;
};
class DT_White : public DT_Dsapi
{
public:
DT_White() {}
virtual ~DT_White();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
virtual bool IsWhiteOnly() const;
};
class DT_MLTag : public DT_Dsapi
{
public:
enum E_Kind
{
k_unknown = 0,
k_begin,
k_end,
k_single
};
};
class DT_MupType : public DT_MLTag
{
public:
explicit DT_MupType( /// Constructor for End-Tag
bool ) /// Must be there, but is not evaluated.
: bIsBegin(false) {}
explicit DT_MupType( /// Constructor for Begin-Tag
const String & i_sScope )
: sScope(i_sScope), bIsBegin(true) {}
virtual ~DT_MupType();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
const String & Scope() const { return sScope; }
bool IsBegin() const { return bIsBegin; }
private:
String sScope;
bool bIsBegin;
};
class DT_MupMember : public DT_MLTag
{
public:
explicit DT_MupMember( /// Constructor for End-Tag
bool ) /// Must be there, but is not evaluated.
: bIsBegin(false) {}
DT_MupMember( /// Constructor for Begin-Tag
const String & i_sScope )
: sScope(i_sScope), bIsBegin(true) {}
virtual ~DT_MupMember();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
const String & Scope() const { return sScope; }
bool IsBegin() const { return bIsBegin; }
private:
String sScope;
bool bIsBegin;
};
class DT_MupConst : public DT_Dsapi
{
public:
DT_MupConst(
const char * i_sConstText )
: sConstText(i_sConstText) {}
virtual ~DT_MupConst();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
const char * GetText() const { return sConstText; }
private:
String sConstText; /// Without HTML.
};
class DT_Style : public DT_MLTag
{
public:
DT_Style(
const char * i_sPlainHtmlTag,
bool i_bNewLine )
: sText(i_sPlainHtmlTag), bNewLine(i_bNewLine) {}
virtual ~DT_Style();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
const char * GetText() const { return sText; }
bool IsStartOfNewLine() const
{ return bNewLine; }
private:
String sText; /// With HTML.
E_Kind eKind;
bool bNewLine;
};
class DT_EOL : public DT_Dsapi
{
public:
DT_EOL() {}
virtual ~DT_EOL();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
virtual bool IsWhiteOnly() const;
};
class DT_AtTag : public ary::inf::AtTag2
{
public:
void AddToken(
DYN ary::inf::DocuToken &
let_drToken )
{ aText.AddToken(let_drToken); }
void SetName(
const char * i_sName )
{ sTitle = i_sName; }
protected:
DT_AtTag(
const char * i_sTitle )
: ary::inf::AtTag2(i_sTitle) {}
};
class DT_StdAtTag : public DT_AtTag
{
public:
explicit DT_StdAtTag(
const char * i_sTitle )
: DT_AtTag(i_sTitle) {}
virtual ~DT_StdAtTag();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
};
class DT_SeeAlsoAtTag : public DT_AtTag
{
public:
DT_SeeAlsoAtTag() : DT_AtTag("") {}
virtual ~DT_SeeAlsoAtTag();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
const String & LinkText() const { return sTitle; } // abuse of sTitle
};
class DT_ParameterAtTag : public DT_AtTag
{
public:
DT_ParameterAtTag() : DT_AtTag("") {}
virtual ~DT_ParameterAtTag();
void SetTitle(
const char * i_sTitle );
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
};
class DT_SinceAtTag : public DT_AtTag
{
public:
DT_SinceAtTag() : DT_AtTag("Since version") {}
virtual ~DT_SinceAtTag();
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
};
} // namespace dsapi
} // namespace csi
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|