Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Fl_XmlDocType Class Reference
[eFLTK XML module]

The Fl_XmlDocType represents tag <DOCTYPE ...> in XML document. More...

#include <Fl_XmlDoc.h>

List of all members.

Public Methods

 Fl_XmlDocType ()
 Fl_XmlDocType (const char *name, const char *public_id=0, const char *system_id=0)
const Fl_Stringname () const
 Returns the name of the document type as specified in the <!DOCTYPE name> tag.

const Fl_Stringpublic_id () const
 Returns the public identifier of the external DTD subset. More...

const Fl_Stringsystem_id () const
 Returns the system identifier of the external DTD subset. More...

Fl_XmlEntitiesentities ()
 Returns a map of all entities described in the DTD. More...

const Fl_XmlEntitiesentities () const
bool encode_entities (const char *str, Fl_String &ret)
 Encodes string to XML representation. More...

bool decode_entities (const char *str, Fl_String &ret)
 Decodes entities in string to their actual values. More...

bool has_entity (const char *name) const
 Search for entity with given name Returns true, if attribute is found. More...

bool remove_entity (const char *name)
 Remove named entity from entity map. More...

Fl_String get_replacement (const char *name) const
 Return replacement value for named entity. More...

void set_entity (const char *name, const char *replacement)
 Add entity to map, If entity named 'name' exists already in map, it's value is replaced with 'replacement'. More...


Friends

class Fl_XmlParser


Detailed Description

The Fl_XmlDocType represents tag <DOCTYPE ...> in XML document.

It can return a map of all entities(). This class provides the name(), public_id() and system_id() functions.

Definition at line 44 of file Fl_XmlDoc.h.


Member Function Documentation

bool Fl_XmlDocType::decode_entities const char *    str,
Fl_String   ret
 

Decodes entities in string to their actual values.

I.e. Converts "<test>" to "<test>" Returns true, any entities expanded.

Parameters:
str  string to convert
ret  converted string is stored to this.

bool Fl_XmlDocType::encode_entities const char *    str,
Fl_String   ret
 

Encodes string to XML representation.

I.e. Converts "<test>" to "<test>" Returns true, any entities replaced.

Parameters:
str  string to convert
ret  converted string is stored to this.

Fl_XmlEntities& Fl_XmlDocType::entities   [inline]
 

Returns a map of all entities described in the DTD.

NOTE: Map doesn't hold default entities.

Definition at line 72 of file Fl_XmlDoc.h.

Fl_String Fl_XmlDocType::get_replacement const char *    name const
 

Return replacement value for named entity.

If entity is not found, empty string is returned.

Parameters:
name  entity name

bool Fl_XmlDocType::has_entity const char *    name const
 

Search for entity with given name Returns true, if attribute is found.

Parameters:
name  entity to search

const Fl_String& Fl_XmlDocType::public_id   const [inline]
 

Returns the public identifier of the external DTD subset.

Returns empty string if there is no public identifier.

Definition at line 60 of file Fl_XmlDoc.h.

bool Fl_XmlDocType::remove_entity const char *    name [inline]
 

Remove named entity from entity map.

Returns true, if entity removed.

Parameters:
name  entity to remove

Definition at line 105 of file Fl_XmlDoc.h.

References Fl_XmlEntities::remove_entity().

void Fl_XmlDocType::set_entity const char *    name,
const char *    replacement
[inline]
 

Add entity to map, If entity named 'name' exists already in map, it's value is replaced with 'replacement'.

Parameters:
name  entity to add/change
replacement  value that represents entity

Definition at line 120 of file Fl_XmlDoc.h.

References Fl_XmlEntities::set_entity().

const Fl_String& Fl_XmlDocType::system_id   const [inline]
 

Returns the system identifier of the external DTD subset.

Returns empty string if there is no system identifier.

Definition at line 66 of file Fl_XmlDoc.h.


The documentation for this class was generated from the following file:
Generated on Thu Jul 31 15:33:58 2003 for eFLTK by doxygen1.2.15