<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>Colorer-take5 Library: FileType Class Reference</title> <link href="../styles/styles.css" rel="stylesheet" type="text/css"> <link href="../styles/doc.css" rel="stylesheet" type="text/css"> <link rel="icon" href="../images/logo-small-api.png"/> </head> <body> <div align='center'> <a href="../index.html">Home</a> | <a href="modules.html">Modules</a> | <a href="hierarchy.html">Class Hierarchy</a> | <a href="classes.html">Alphabetical List</a> | <a href="annotated.html">Compound List</a> | <a href="pages.html">Related Pages</a> </div> <!-- Generated by Doxygen 1.4.6 --> <h1>FileType Class Reference<br> <small> [<a class="el" href="group__colorer.html">Colorer interfaces</a>]</small> </h1><!-- doxytag: class="FileType" --><p>Inheritance diagram for FileType: <p><center><img src="classFileType.png" usemap="#FileType_map" border="0" alt=""></center> <map name="FileType_map"> <area href="classFileTypeImpl.html" alt="FileTypeImpl" shape="rect" coords="0,56,83,80"> </map> <hr><a name="_details"></a><h2>Detailed Description</h2> HRC <a class="el" href="classFileType.html">FileType</a> (or prototype) instance. <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileType.html#1430413a2567ab4107e612ac5a2984b9">getName</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Public name of file type (HRC 'name' attribute). <a href="#1430413a2567ab4107e612ac5a2984b9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileType.html#8edaf29c308e32a702f4be51c3b586df">getGroup</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Public group name of file type (HRC 'group' attribute). <a href="#8edaf29c308e32a702f4be51c3b586df"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileType.html#f182c90e89c09137d407db3b59ae82c6">getDescription</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Public description of file type (HRC 'description' attribute). <a href="#f182c90e89c09137d407db3b59ae82c6"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classScheme.html">Scheme</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileType.html#c0958891d824f65c7e2586a4abee0e2f">getBaseScheme</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the base scheme of this file type. <a href="#c0958891d824f65c7e2586a4abee0e2f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileType.html#bbecaf39b82aa6d86ad167de57f38a48">enumerateParameters</a> (int idx)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Enumerates all available parameters, defined in this file type. <a href="#bbecaf39b82aa6d86ad167de57f38a48"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad0df4e3aa46452ee255dd932bbea5c8"></a><!-- doxytag: member="FileType::getParameterDescription" ref="ad0df4e3aa46452ee255dd932bbea5c8" args="(const String &name)=0" --> virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><b>getParameterDescription</b> (const <a class="el" href="classString.html">String</a> &name)=0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileType.html#a361f024712e0a05cdc02ac8df9c6b59">getParamValue</a> (const <a class="el" href="classString.html">String</a> &name)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns parameter's value of this file type. <a href="#a361f024712e0a05cdc02ac8df9c6b59"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classString.html">String</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileType.html#028c60a8690e9e09d07d0762525952b2">getParamDefaultValue</a> (const <a class="el" href="classString.html">String</a> &name)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns parameter's default value of this file type. <a href="#028c60a8690e9e09d07d0762525952b2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileType.html#715a91473cc046a2e97bc7a729f1c397">setParamValue</a> (const <a class="el" href="classString.html">String</a> &name, const <a class="el" href="classString.html">String</a> *value)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Changes value of the parameter with specified name. <a href="#715a91473cc046a2e97bc7a729f1c397"></a><br></td></tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="1430413a2567ab4107e612ac5a2984b9"></a><!-- doxytag: member="FileType::getName" ref="1430413a2567ab4107e612ac5a2984b9" args="()=0" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual const <a class="el" href="classString.html">String</a>* FileType::getName </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Public name of file type (HRC 'name' attribute). <p> <dl compact><dt><b>Returns:</b></dt><dd>File type Name </dd></dl> </td> </tr> </table> <a class="anchor" name="8edaf29c308e32a702f4be51c3b586df"></a><!-- doxytag: member="FileType::getGroup" ref="8edaf29c308e32a702f4be51c3b586df" args="()=0" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual const <a class="el" href="classString.html">String</a>* FileType::getGroup </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Public group name of file type (HRC 'group' attribute). <p> <dl compact><dt><b>Returns:</b></dt><dd>File type Group </dd></dl> </td> </tr> </table> <a class="anchor" name="f182c90e89c09137d407db3b59ae82c6"></a><!-- doxytag: member="FileType::getDescription" ref="f182c90e89c09137d407db3b59ae82c6" args="()=0" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual const <a class="el" href="classString.html">String</a>* FileType::getDescription </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Public description of file type (HRC 'description' attribute). <p> <dl compact><dt><b>Returns:</b></dt><dd>File type Description </dd></dl> </td> </tr> </table> <a class="anchor" name="c0958891d824f65c7e2586a4abee0e2f"></a><!-- doxytag: member="FileType::getBaseScheme" ref="c0958891d824f65c7e2586a4abee0e2f" args="()=0" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual <a class="el" href="classScheme.html">Scheme</a>* FileType::getBaseScheme </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Returns the base scheme of this file type. <p> Basically, this is the scheme with same public name, as it's type. If this <a class="el" href="classFileType.html">FileType</a> object is not yet loaded, it is loaded with this call. <dl compact><dt><b>Returns:</b></dt><dd>File type base scheme, to be used as root scheme of text parsing. </dd></dl> </td> </tr> </table> <a class="anchor" name="bbecaf39b82aa6d86ad167de57f38a48"></a><!-- doxytag: member="FileType::enumerateParameters" ref="bbecaf39b82aa6d86ad167de57f38a48" args="(int idx)=0" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual const <a class="el" href="classString.html">String</a>* FileType::enumerateParameters </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> <td class="mdname1" valign="top" nowrap> <em>idx</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Enumerates all available parameters, defined in this file type. <p> <dl compact><dt><b>Returns:</b></dt><dd>Parameter name with index <code>idx</code> or <code>null</code> if index is too large. </dd></dl> </td> </tr> </table> <a class="anchor" name="a361f024712e0a05cdc02ac8df9c6b59"></a><!-- doxytag: member="FileType::getParamValue" ref="a361f024712e0a05cdc02ac8df9c6b59" args="(const String &name)=0" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual const <a class="el" href="classString.html">String</a>* FileType::getParamValue </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classString.html">String</a> & </td> <td class="mdname1" valign="top" nowrap> <em>name</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Returns parameter's value of this file type. <p> Parameters are stored in prototypes as <pre> <parameters> <param name="name" value="value" description="..."/> </parameter> </pre> Parameters can be used to store application specific information about each type of file. Also parameters are accessible from the HRC definition using <code>if/unless</code> attributes of scheme elements. This allows portable customization of HRC loading. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Parameter's name </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>Value (changed or default) of this parameter </dd></dl> </td> </tr> </table> <a class="anchor" name="028c60a8690e9e09d07d0762525952b2"></a><!-- doxytag: member="FileType::getParamDefaultValue" ref="028c60a8690e9e09d07d0762525952b2" args="(const String &name)=0" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual const <a class="el" href="classString.html">String</a>* FileType::getParamDefaultValue </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classString.html">String</a> & </td> <td class="mdname1" valign="top" nowrap> <em>name</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Returns parameter's default value of this file type. <p> Default values are the values, explicitly pointed with <code>value</code> attribute. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Parameter's name </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>Default value of this parameter </dd></dl> </td> </tr> </table> <a class="anchor" name="715a91473cc046a2e97bc7a729f1c397"></a><!-- doxytag: member="FileType::setParamValue" ref="715a91473cc046a2e97bc7a729f1c397" args="(const String &name, const String *value)=0" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual void FileType::setParamValue </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classString.html">String</a> & </td> <td class="mdname" nowrap> <em>name</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>const <a class="el" href="classString.html">String</a> * </td> <td class="mdname" nowrap> <em>value</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [pure virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Changes value of the parameter with specified name. <p> Note, that changed parameter values are not stored in HRC base - they remains active only during this HRC session. Application should use its own mechanism to save these values between sessions (if needed). <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Parameter's name </td></tr> <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>New value of this parameter. </td></tr> </table> </dl> </td> </tr> </table> <br><br> <center><small> Colorer-take5 Library. Copyright © 1999-2006 Igor Russkih.<br> Generated at Fri Nov 24 17:13:12 2006 by doxygen 1.4.6. </small><center> </BODY> </HTML>