EVOLUTION-MANAGER
Edit File: classOGRStyleTable.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>OGR: OGRStyleTable Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">OGR </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classOGRStyleTable-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">OGRStyleTable Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="ogr__featurestyle_8h_source.html">ogr_featurestyle.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aff722d3fc7c167259dd79986a2574993"><td class="memItemLeft" align="right" valign="top">GBool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#aff722d3fc7c167259dd79986a2574993">AddStyle</a> (const char *pszName, const char *pszStyleString)</td></tr> <tr class="memdesc:aff722d3fc7c167259dd79986a2574993"><td class="mdescLeft"> </td><td class="mdescRight">Add a new style in the table. No comparison will be done on the Style string, only on the name. <a href="#aff722d3fc7c167259dd79986a2574993">More...</a><br/></td></tr> <tr class="separator:aff722d3fc7c167259dd79986a2574993"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7ee6ed40960867c94f4b54ba6fdba2ef"><td class="memItemLeft" align="right" valign="top">GBool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#a7ee6ed40960867c94f4b54ba6fdba2ef">RemoveStyle</a> (const char *pszName)</td></tr> <tr class="memdesc:a7ee6ed40960867c94f4b54ba6fdba2ef"><td class="mdescLeft"> </td><td class="mdescRight">Remove a style in the table by its name. <a href="#a7ee6ed40960867c94f4b54ba6fdba2ef">More...</a><br/></td></tr> <tr class="separator:a7ee6ed40960867c94f4b54ba6fdba2ef"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a723a31a375fcff5bb0698268ddfbfd4f"><td class="memItemLeft" align="right" valign="top">GBool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#a723a31a375fcff5bb0698268ddfbfd4f">ModifyStyle</a> (const char *pszName, const char *pszStyleString)</td></tr> <tr class="memdesc:a723a31a375fcff5bb0698268ddfbfd4f"><td class="mdescLeft"> </td><td class="mdescRight">Modify a style in the table by its name If the style does not exist, it will be added. <a href="#a723a31a375fcff5bb0698268ddfbfd4f">More...</a><br/></td></tr> <tr class="separator:a723a31a375fcff5bb0698268ddfbfd4f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5395e712fa91a3d26f6aed779760983c"><td class="memItemLeft" align="right" valign="top">GBool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#a5395e712fa91a3d26f6aed779760983c">SaveStyleTable</a> (const char *pszFilename)</td></tr> <tr class="memdesc:a5395e712fa91a3d26f6aed779760983c"><td class="mdescLeft"> </td><td class="mdescRight">Save a style table to a file. <a href="#a5395e712fa91a3d26f6aed779760983c">More...</a><br/></td></tr> <tr class="separator:a5395e712fa91a3d26f6aed779760983c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1d8b2702ca6c6469d03316b6c9341739"><td class="memItemLeft" align="right" valign="top">GBool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#a1d8b2702ca6c6469d03316b6c9341739">LoadStyleTable</a> (const char *pszFilename)</td></tr> <tr class="memdesc:a1d8b2702ca6c6469d03316b6c9341739"><td class="mdescLeft"> </td><td class="mdescRight">Load a style table from a file. <a href="#a1d8b2702ca6c6469d03316b6c9341739">More...</a><br/></td></tr> <tr class="separator:a1d8b2702ca6c6469d03316b6c9341739"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a83347c8a447e454b825784c8f7ce1661"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#a83347c8a447e454b825784c8f7ce1661">Find</a> (const char *pszStyleString)</td></tr> <tr class="memdesc:a83347c8a447e454b825784c8f7ce1661"><td class="mdescLeft"> </td><td class="mdescRight">Get a style string by name. <a href="#a83347c8a447e454b825784c8f7ce1661">More...</a><br/></td></tr> <tr class="separator:a83347c8a447e454b825784c8f7ce1661"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad7371adb14faadb0c6e8011951712c23"><td class="memItemLeft" align="right" valign="top">GBool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#ad7371adb14faadb0c6e8011951712c23">IsExist</a> (const char *pszName)</td></tr> <tr class="memdesc:ad7371adb14faadb0c6e8011951712c23"><td class="mdescLeft"> </td><td class="mdescRight">Get the index of a style in the table by its name. <a href="#ad7371adb14faadb0c6e8011951712c23">More...</a><br/></td></tr> <tr class="separator:ad7371adb14faadb0c6e8011951712c23"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afc78310da48449b9f6a79d20d73e5944"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#afc78310da48449b9f6a79d20d73e5944">GetStyleName</a> (const char *pszName)</td></tr> <tr class="memdesc:afc78310da48449b9f6a79d20d73e5944"><td class="mdescLeft"> </td><td class="mdescRight">Get style name by style string. <a href="#afc78310da48449b9f6a79d20d73e5944">More...</a><br/></td></tr> <tr class="separator:afc78310da48449b9f6a79d20d73e5944"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab7d74884aac1af801cfedbffba8ef203"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#ab7d74884aac1af801cfedbffba8ef203">Print</a> (FILE *fpOut)</td></tr> <tr class="memdesc:ab7d74884aac1af801cfedbffba8ef203"><td class="mdescLeft"> </td><td class="mdescRight">Print a style table to a FILE pointer. <a href="#ab7d74884aac1af801cfedbffba8ef203">More...</a><br/></td></tr> <tr class="separator:ab7d74884aac1af801cfedbffba8ef203"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2e10074ef4c336e47dec90b0adf4b249"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e10074ef4c336e47dec90b0adf4b249"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#a2e10074ef4c336e47dec90b0adf4b249">Clear</a> ()</td></tr> <tr class="memdesc:a2e10074ef4c336e47dec90b0adf4b249"><td class="mdescLeft"> </td><td class="mdescRight">Clear a style table. <br/></td></tr> <tr class="separator:a2e10074ef4c336e47dec90b0adf4b249"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a238073729c346b514ec70a5f81ecd3df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOGRStyleTable.html">OGRStyleTable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOGRStyleTable.html#a238073729c346b514ec70a5f81ecd3df">Clone</a> ()</td></tr> <tr class="memdesc:a238073729c346b514ec70a5f81ecd3df"><td class="mdescLeft"> </td><td class="mdescRight">Duplicate style table. <a href="#a238073729c346b514ec70a5f81ecd3df">More...</a><br/></td></tr> <tr class="separator:a238073729c346b514ec70a5f81ecd3df"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This class represents a style table </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="aff722d3fc7c167259dd79986a2574993"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GBool OGRStyleTable::AddStyle </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszStyleString</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Add a new style in the table. No comparison will be done on the Style string, only on the name. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszName</td><td>the name the style to add. </td></tr> <tr><td class="paramname">pszStyleString</td><td>the style string to add.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE on success, FALSE on error </dd></dl> <p>References <a class="el" href="classOGRStyleTable.html#ad7371adb14faadb0c6e8011951712c23">IsExist()</a>.</p> <p>Referenced by <a class="el" href="classOGRStyleMgr.html#a7f6c3dcb19e0803ebc3aae61467e00f0">OGRStyleMgr::AddStyle()</a>, and <a class="el" href="classOGRStyleTable.html#a723a31a375fcff5bb0698268ddfbfd4f">ModifyStyle()</a>.</p> </div> </div> <a class="anchor" id="a238073729c346b514ec70a5f81ecd3df"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classOGRStyleTable.html">OGRStyleTable</a> * OGRStyleTable::Clone </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Duplicate style table. </p> <p>The newly created style table is owned by the caller, and will have it's own reference to the <a class="el" href="classOGRStyleTable.html">OGRStyleTable</a>.</p> <dl class="section return"><dt>Returns</dt><dd>new style table, exactly matching this style table. </dd></dl> <p>References <a class="el" href="cpl__string_8h.html#a8b9c9ad6c5a416c91f1fca55d9a91701">CSLDuplicate()</a>.</p> <p>Referenced by <a class="el" href="classOGRLayer.html#a33fa0802c0686fb0e6ca6337e11cd7d5">OGRLayer::SetStyleTable()</a>, and <a class="el" href="classOGRDataSource.html#a36054cdc7e65827c05d3a27c7290f8d2">OGRDataSource::SetStyleTable()</a>.</p> </div> </div> <a class="anchor" id="a83347c8a447e454b825784c8f7ce1661"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char * OGRStyleTable::Find </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszName</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get a style string by name. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszName</td><td>the name of the style string to find.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the style string matching the name, NULL if not found or error. </dd></dl> <p>References <a class="el" href="classOGRStyleTable.html#ad7371adb14faadb0c6e8011951712c23">IsExist()</a>.</p> <p>Referenced by <a class="el" href="classOGRStyleMgr.html#a731c9a3ac493f00e911f1879a45db4a2">OGRStyleMgr::GetStyleByName()</a>.</p> </div> </div> <a class="anchor" id="afc78310da48449b9f6a79d20d73e5944"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char * OGRStyleTable::GetStyleName </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszStyleString</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get style name by style string. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszStyleString</td><td>the style string to look up.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the Name of the matching style string or NULL on error. </dd></dl> <p>References <a class="el" href="cpl__string_8h.html#ac1ffd0e5baf9729f09388a38c07f5835">CSLCount()</a>.</p> <p>Referenced by <a class="el" href="classOGRStyleMgr.html#ad1dca451c9afa2da8075fbaa31fac68a">OGRStyleMgr::GetStyleName()</a>.</p> </div> </div> <a class="anchor" id="ad7371adb14faadb0c6e8011951712c23"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int OGRStyleTable::IsExist </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszName</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get the index of a style in the table by its name. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszName</td><td>the name to look for.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The index of the style if found, -1 if not found or error. </dd></dl> <p>References <a class="el" href="cpl__string_8h.html#ac1ffd0e5baf9729f09388a38c07f5835">CSLCount()</a>.</p> <p>Referenced by <a class="el" href="classOGRStyleTable.html#aff722d3fc7c167259dd79986a2574993">AddStyle()</a>, <a class="el" href="classOGRStyleTable.html#a83347c8a447e454b825784c8f7ce1661">Find()</a>, and <a class="el" href="classOGRStyleTable.html#a7ee6ed40960867c94f4b54ba6fdba2ef">RemoveStyle()</a>.</p> </div> </div> <a class="anchor" id="a1d8b2702ca6c6469d03316b6c9341739"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GBool OGRStyleTable::LoadStyleTable </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszFilename</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Load a style table from a file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszFilename</td><td>the name of the file to load from.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE on success, FALSE on error </dd></dl> <p>References <a class="el" href="cpl__string_8h.html#a5a39b9c5896a273cc6f06c1d5be93238">CSLDestroy()</a>, and <a class="el" href="cpl__string_8h.html#ad7af0a270dc019a17bf1326da8e6a970">CSLLoad()</a>.</p> </div> </div> <a class="anchor" id="a723a31a375fcff5bb0698268ddfbfd4f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GBool OGRStyleTable::ModifyStyle </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszStyleString</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Modify a style in the table by its name If the style does not exist, it will be added. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszName</td><td>the name of the style to modify. </td></tr> <tr><td class="paramname">pszStyleString</td><td>the style string.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE on success, FALSE on error </dd></dl> <p>References <a class="el" href="classOGRStyleTable.html#aff722d3fc7c167259dd79986a2574993">AddStyle()</a>, and <a class="el" href="classOGRStyleTable.html#a7ee6ed40960867c94f4b54ba6fdba2ef">RemoveStyle()</a>.</p> </div> </div> <a class="anchor" id="ab7d74884aac1af801cfedbffba8ef203"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void OGRStyleTable::Print </td> <td>(</td> <td class="paramtype">FILE * </td> <td class="paramname"><em>fpOut</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Print a style table to a FILE pointer. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">fpOut</td><td>the FILE pointer to print to. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a7ee6ed40960867c94f4b54ba6fdba2ef"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GBool OGRStyleTable::RemoveStyle </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszName</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Remove a style in the table by its name. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszName</td><td>the name of the style to remove.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE on success, FALSE on error </dd></dl> <p>References <a class="el" href="classOGRStyleTable.html#ad7371adb14faadb0c6e8011951712c23">IsExist()</a>.</p> <p>Referenced by <a class="el" href="classOGRStyleTable.html#a723a31a375fcff5bb0698268ddfbfd4f">ModifyStyle()</a>.</p> </div> </div> <a class="anchor" id="a5395e712fa91a3d26f6aed779760983c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GBool OGRStyleTable::SaveStyleTable </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>pszFilename</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Save a style table to a file. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pszFilename</td><td>the name of the file to save to.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE on success, FALSE on error </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="ogr__featurestyle_8h_source.html">ogr_featurestyle.h</a></li> <li>ogrfeaturestyle.cpp</li> </ul> </div><!-- contents --> <hr> Generated for GDAL by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.8.5. </body> </html>