office-gobmx/autodoc/inc/ary_i/d_token.hxx
Vladimir Glazounov bc25a010dc INTEGRATION: CWS adc17 (1.7.18); FILE MERGED
2007/08/10 10:37:09 np 1.7.18.1: #i23626 correct spacing in autodoc output#
2007-09-18 12:23:15 +00:00

295 lines
9.2 KiB
C++

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: d_token.hxx,v $
*
* $Revision: 1.8 $
*
* last change: $Author: vg $ $Date: 2007-09-18 13:23:15 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef CSI_DSAPI_D_TOKEN_HXX
#define CSI_DSAPI_D_TOKEN_HXX
// USED SERVICES
// BASE CLASSES
#include <ary_i/ci_text2.hxx>
#include <ary_i/ci_atag2.hxx>
// COMPONENTS
// PARAMETERS
#include <display/uidldisp.hxx>
namespace csi
{
namespace dsapi
{
using ary::info::DocumentationDisplay;
class DT_Dsapi : public ary::info::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 udmstri & Scope() const { return sScope; }
bool IsBegin() const { return bIsBegin; }
private:
udmstri 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 udmstri & Scope() const { return sScope; }
bool IsBegin() const { return bIsBegin; }
private:
udmstri 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:
udmstri 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:
udmstri 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::info::AtTag2
{
public:
void AddToken(
DYN ary::info::DocuToken &
let_drToken )
{ aText.AddToken(let_drToken); }
void SetName(
const char * i_sName )
{ sTitle = i_sName; }
protected:
DT_AtTag(
const char * i_sTitle )
: ary::info::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();
// void SetLinkText(
// const char * i_sLinkText )
// { sLinkText = i_sLinkText; }
virtual void DisplayAt(
DocumentationDisplay &
o_rDisplay ) const;
const udmstri & LinkText() const { return sTitle; } // Missbrauch von sTitle
private:
// udmstri sLinkText;
};
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