Home | Modules | Class Hierarchy | Alphabetical List | Compound List | Related Pages

FileType Class Reference
[Colorer interfaces]

Inheritance diagram for FileType:

FileTypeImpl

Detailed Description

HRC FileType (or prototype) instance.


Public Methods

virtual bool isLoaded () const=0
 Is this type already loaded.

virtual const String * getName () const=0
 Public name of file type (HRC 'name' attribute).

virtual const String * getGroup () const=0
 Public group name of file type (HRC 'group' attribute).

virtual const String * getDescription () const=0
 Public description of file type (HRC 'description' attribute).

virtual const Scheme * getBaseScheme () const=0
 Returns the base scheme of this file type.

virtual const String * getParameter (const String &name) const=0
 Returns parameter value of this file type.

Member Function Documentation

virtual bool FileType::isLoaded (    )  const [pure virtual]
 

Is this type already loaded.

All types could be loaded with #HRCParser::loadFileType()

virtual const String* FileType::getName (    )  const [pure virtual]
 

Public name of file type (HRC 'name' attribute).

Returns:
File type Name

virtual const String* FileType::getGroup (    )  const [pure virtual]
 

Public group name of file type (HRC 'group' attribute).

Returns:
File type Group

virtual const String* FileType::getDescription (    )  const [pure virtual]
 

Public description of file type (HRC 'description' attribute).

Returns:
File type Description

virtual const Scheme* FileType::getBaseScheme (    )  const [pure virtual]
 

Returns the base scheme of this file type.

Basically, this is the scheme with same public name, as it's type.

Returns:
File type base scheme, to be used as root scheme of text parsing.

virtual const String* FileType::getParameter (  const String &    name )  const [pure virtual]
 

Returns parameter value of this file type.

Parameters are stored in prototypes as 

      <parameters>
        <param name="name" value="value"/>
      </parameter>
Note:
Parameters could be used to store client-application specific information about each type of file.
Parameters:
name Parameter's name


Colorer Library version take5. Copyright © 1999-2003 Cail Lomecb.
Generated at Sun Mar 2 23:57:45 2003 by doxygen 1.3-rc2.