diff options
Diffstat (limited to 'doc/api-documentation/html/class_utf8hebrewpoints.html')
| -rw-r--r-- | doc/api-documentation/html/class_utf8hebrewpoints.html | 278 |
1 files changed, 278 insertions, 0 deletions
diff --git a/doc/api-documentation/html/class_utf8hebrewpoints.html b/doc/api-documentation/html/class_utf8hebrewpoints.html new file mode 100644 index 0000000..9f948a7 --- /dev/null +++ b/doc/api-documentation/html/class_utf8hebrewpoints.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8HebrewPoints class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8HebrewPoints Class Reference</h1>This Filter shows/hides Hebrew vowel points in UTF8 text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>></code> +<p> +<p>Inheritance diagram for UTF8HebrewPoints:: +<p><center><img src="class_utf8hebrewpoints.gif" usemap="#UTF8HebrewPoints_map" border="0"></center> +<map name="UTF8HebrewPoints_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,120,24"> +</map> +<a href="class_utf8hebrewpoints-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8HebrewPoints::UTF8HebrewPoints"></a> + </td><td valign=bottom><b>UTF8HebrewPoints</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8HebrewPoints::~UTF8HebrewPoints"></a> +virtual </td><td valign=bottom><b>~UTF8HebrewPoints</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also <a class="el" href="class_utf8hebrewpoints.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="UTF8HebrewPoints::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="UTF8HebrewPoints::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="UTF8HebrewPoints::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="UTF8HebrewPoints::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="UTF8HebrewPoints::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="UTF8HebrewPoints::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="UTF8HebrewPoints::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides Hebrew vowel points in UTF8 text. +<p> + +<p> +Definition at line <a class="el" href="utf8hebrewpoints_h-source.html#l00029">29</a> of file <a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="UTF8HebrewPoints::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char UTF8HebrewPoints::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="UTF8HebrewPoints::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * UTF8HebrewPoints::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8hebrewpoints_h-source.html#l00041">41</a> of file <a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="UTF8HebrewPoints::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * UTF8HebrewPoints::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8hebrewpoints_h-source.html#l00045">45</a> of file <a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="UTF8HebrewPoints::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList UTF8HebrewPoints::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8hebrewpoints_h-source.html#l00051">51</a> of file <a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="UTF8HebrewPoints::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void UTF8HebrewPoints::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also <a class="el" href="class_utf8hebrewpoints.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |