SML::DOCCODES Class Reference

class SML::DOCCODES More...

#include <sml/doccodes.h>

Inheritance diagram for SML::DOCCODES:

[legend]

List of all members.

Public Types
enum	CLASS {   CLASS_Normal = 0, CLASS_FuncGroupDiv, CLASS_ItemNameDiv, CLASS_Prototype,   CLASS_ShortDesc, CLASS_BoldDiv, CLASS_Warning, CLASS_Inheritance }
Public Member Functions
	DOCCODES ()
virtual	~DOCCODES ()
virtual void	Append (const MIUNICODE *)=0
virtual void	Append (const char *)
virtual void	AppendHyperAnchor (const char *)
virtual void	AppendHyperLink (const char *, const MIUNICODE *text)
void	AppendML (const MISTRING &str, bool bIndent=false)
void	AppendMsg (TEXTID)
void	AppendRes (const char *str)
virtual void	BlankLine ()
virtual void	Clear ()=0
virtual void	EndBold ()
virtual void	EndCodeBlock ()
virtual void	EndCodeFont ()
virtual void	EndDiv ()
virtual void	EndDoc ()
virtual void	EndIndent ()
virtual void	EndItalic ()
virtual void	EndKeyword ()
virtual void	EndLine ()
virtual void	EndMainHead ()
virtual void	EndNormalFont ()
virtual void	EndPrototypeDiv ()
virtual void	EndSectionHead ()
virtual void	EndTitle ()
virtual void	EndWarning ()
virtual void	InsertHRule ()
virtual bool	IsHTML ()
DOCCODES &	operator+= (const MIUNICODE *text)
DOCCODES &	operator+= (const char *text)
virtual void	SetTextColorBlue ()
virtual void	SetTextColorGreen ()
virtual void	SetTextColorNormal ()
virtual void	SetTextColorRed ()
virtual void	StartBold ()
virtual void	StartCodeBlock ()
virtual void	StartCodeFont ()
virtual void	StartDiv (CLASS)
virtual void	StartDoc (const char *)
virtual void	StartIndent ()
virtual void	StartItalic ()
virtual void	StartKeyword ()
virtual void	StartLine ()
virtual void	StartMainHead ()
virtual void	StartNormalFont ()
virtual void	StartPrototypeDiv ()
virtual void	StartSectionHead ()
virtual void	StartTitle ()
virtual void	StartWarning ()

---

Detailed Description

class SML::DOCCODES

This class can be passed to SML::GetFuncDoc() so that the output string is plain text. All the methods return the string which should be inserted into the output to switch to the mode indicated by the name (for plain text, they all return empty strings)

There are derived classes for outputting ANSI or HTML.

---

Member Enumeration Documentation

enum SML::DOCCODES::CLASS

Enumerator:

CLASS_Normal
CLASS_FuncGroupDiv
CLASS_ItemNameDiv
CLASS_Prototype
CLASS_ShortDesc
CLASS_BoldDiv
CLASS_Warning
CLASS_Inheritance

---

Constructor & Destructor Documentation

SML::DOCCODES::DOCCODES

(

)

[inline]

virtual SML::DOCCODES::~DOCCODES

(

)

[inline, virtual]

---

Member Function Documentation

virtual void SML::DOCCODES::Append

(

const MIUNICODE *

)

[pure virtual]

Default converts to UC.

Implemented in SML::DOCCODES_MISTRING.

virtual void SML::DOCCODES::Append

(

const char *

)

[virtual]

Reimplemented in SML::DOCCODES_MISTRING.

virtual void SML::DOCCODES::AppendHyperAnchor

(

const char *

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::AppendHyperLink	(	const char *	,
		const MIUNICODE *	text
	)			[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

void SML::DOCCODES::AppendML	(	const MISTRING &	str,
		bool	bIndent = false
	)

void SML::DOCCODES::AppendMsg

(

TEXTID

)

void SML::DOCCODES::AppendRes

(

const char *

str

)

From messages.txt [sml] section.

virtual void SML::DOCCODES::BlankLine

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::Clear

(

)

[pure virtual]

Implemented in SML::DOCCODES_MISTRING.

virtual void SML::DOCCODES::EndBold

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndCodeBlock

(

)

[inline, virtual]

For HTML, use <pre>.

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndCodeFont

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndDiv

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndDoc

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndIndent

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndItalic

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndKeyword

(

)

[inline, virtual]

virtual void SML::DOCCODES::EndLine

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndMainHead

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndNormalFont

(

)

[inline, virtual]

virtual void SML::DOCCODES::EndPrototypeDiv

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndSectionHead

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndTitle

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::EndWarning

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::InsertHRule

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual bool SML::DOCCODES::IsHTML

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

DOCCODES& SML::DOCCODES::operator+=

(

const MIUNICODE *

text

)

[inline]

DOCCODES& SML::DOCCODES::operator+=

(

const char *

text

)

[inline]

From tntxres.txt.

virtual void SML::DOCCODES::SetTextColorBlue

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::SetTextColorGreen

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::SetTextColorNormal

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::SetTextColorRed

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartBold

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartCodeBlock

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartCodeFont

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartDiv

(

CLASS

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartDoc

(

const char *

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartIndent

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartItalic

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartKeyword

(

)

[inline, virtual]

virtual void SML::DOCCODES::StartLine

(

)

[virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartMainHead

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartNormalFont

(

)

[inline, virtual]

virtual void SML::DOCCODES::StartPrototypeDiv

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartSectionHead

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartTitle

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_ANSI, and SML::DOCCODES_HTML.

virtual void SML::DOCCODES::StartWarning

(

)

[inline, virtual]

Reimplemented in SML::DOCCODES_HTML.

---

The documentation for this class was generated from the following file:

• sml/doccodes.h