Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

CEntityToken Class Reference

This class declares entity tokens, which always take the form . More...

#include <nsHTMLTokens.h>

Inheritance diagram for CEntityToken:
Collaboration diagram for CEntityToken:

List of all members.

Public Member Functions

 CEntityToken ()
 CEntityToken (const nsAString &aString)
virtual PRInt32 GetTokenType (void)
 Getter which retrieves type of token gess5/11/98.
PRInt32 TranslateToUnicodeStr (nsString_external &aString)
virtual nsresult Consume (PRUnichar aChar, nsScanner &aScanner, PRInt32 aMode)
 Causes token to consume data from given scanner.
virtual const nsSubstringGetStringValue (void)
 Retrieve string value of the token gess5/11/98.
virtual void GetSource (nsString_external &anOutputString)
virtual void AppendSourceTo (nsAString &anOutputString)
 harishd 03/23/00

Static Public Member Functions

static nsresult ConsumeEntity (PRUnichar aChar, nsString_external &aString, nsScanner &aScanner)
static PRInt32 TranslateToUnicodeStr (PRInt32 aValue, nsString_external &aString)

Protected Member Functions

virtual size_t SizeOf () const
 Returns the size of the token object.

Protected Attributes

nsString_external mTextValue

Detailed Description

This class declares entity tokens, which always take the form .

This class also offers a few utility methods that allow you to easily reduce entities.

gess 3/25/98


Constructor & Destructor Documentation

CEntityToken::CEntityToken (  ) 
CEntityToken::CEntityToken ( const nsAString aString  ) 

Member Function Documentation

virtual void CEntityToken::AppendSourceTo ( nsAString anOutputString  )  [virtual]

harishd 03/23/00

Returns:
reference to string containing string value

Reimplemented from CToken.

virtual nsresult CEntityToken::Consume ( PRUnichar  aChar,
nsScanner &  aScanner,
PRInt32  aMode 
) [virtual]

Causes token to consume data from given scanner.

Note that behavior varies wildly between CToken subclasses. gess5/11/98

Parameters:
aChar -- most recent char consumed
aScanner -- input source where token should get data
Returns:
error code (0 means ok)

Reimplemented from CToken.

static nsresult CEntityToken::ConsumeEntity ( PRUnichar  aChar,
nsString_external aString,
nsScanner &  aScanner 
) [static]
virtual void CEntityToken::GetSource ( nsString_external anOutputString  )  [virtual]
virtual const nsSubstring& CEntityToken::GetStringValue ( void   )  [virtual]

Retrieve string value of the token gess5/11/98.

Returns:
reference to string containing string value

Implements CToken.

virtual PRInt32 CEntityToken::GetTokenType ( void   )  [virtual]

Getter which retrieves type of token gess5/11/98.

Returns:
int containing token type

Reimplemented from CToken.

virtual size_t CEntityToken::SizeOf (  )  const [inline, protected, virtual]

Returns the size of the token object.

Implements CToken.

static PRInt32 CEntityToken::TranslateToUnicodeStr ( PRInt32  aValue,
nsString_external aString 
) [static]
PRInt32 CEntityToken::TranslateToUnicodeStr ( nsString_external aString  ) 

Member Data Documentation


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