<!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.6"/> <title>Open SCAP Library: oscap_text Struct 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">Open SCAP Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <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><a href="modules.html"><span>Modules</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</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>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">oscap_text Struct Reference<div class="ingroups"><a class="el" href="group__STRINGS.html">String manipulation</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Representation of internationalizable character strings. <a href="structoscap__text.html#details">More...</a></p> <p><code>#include <<a class="el" href="oscap__text_8h_source.html">oscap_text.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:gac6a9bf5401a4886e98f2904dcae24bad"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__text.html">oscap_text</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#gac6a9bf5401a4886e98f2904dcae24bad">oscap_text_new</a> (void)</td></tr> <tr class="memdesc:gac6a9bf5401a4886e98f2904dcae24bad"><td class="mdescLeft"> </td><td class="mdescRight">Create an internationalized text field. <a href="group__STRINGS.html#gac6a9bf5401a4886e98f2904dcae24bad">More...</a><br/></td></tr> <tr class="separator:gac6a9bf5401a4886e98f2904dcae24bad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2225487bec55cb7bdec0fa84ac630168"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__text.html">oscap_text</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga2225487bec55cb7bdec0fa84ac630168">oscap_text_clone</a> (const struct <a class="el" href="structoscap__text.html">oscap_text</a> *text)</td></tr> <tr class="memdesc:ga2225487bec55cb7bdec0fa84ac630168"><td class="mdescLeft"> </td><td class="mdescRight">Clone an internationalized text field. <a href="group__STRINGS.html#ga2225487bec55cb7bdec0fa84ac630168">More...</a><br/></td></tr> <tr class="separator:ga2225487bec55cb7bdec0fa84ac630168"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga58c7ce80ba2c0831e18f1bbdeaafa118"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structoscap__text.html">oscap_text</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga58c7ce80ba2c0831e18f1bbdeaafa118">oscap_text_new_html</a> (void)</td></tr> <tr class="memdesc:ga58c7ce80ba2c0831e18f1bbdeaafa118"><td class="mdescLeft"> </td><td class="mdescRight">Create an internationalized text field with HTML content. <a href="group__STRINGS.html#ga58c7ce80ba2c0831e18f1bbdeaafa118">More...</a><br/></td></tr> <tr class="separator:ga58c7ce80ba2c0831e18f1bbdeaafa118"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf5af70b1be049d2fe79e21e5d5310bb1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf5af70b1be049d2fe79e21e5d5310bb1"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#gaf5af70b1be049d2fe79e21e5d5310bb1">oscap_text_free</a> (struct <a class="el" href="structoscap__text.html">oscap_text</a> *)</td></tr> <tr class="memdesc:gaf5af70b1be049d2fe79e21e5d5310bb1"><td class="mdescLeft"> </td><td class="mdescRight">Release an internationalized text field. <br/></td></tr> <tr class="separator:gaf5af70b1be049d2fe79e21e5d5310bb1"><td class="memSeparator" colspan="2"> </td></tr> <tr><td colspan="2"><div class="groupHeader">Getters</div></td></tr> <tr><td colspan="2"><div class="groupText"><p>Return value is pointer to structure's member.</p> <p>Do not free unless you null the pointer in the structure. Use remove function otherwise. </p> </div></td></tr> <tr class="memitem:gaca2bb3cb75e8858295dd08c800ec810e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#gaca2bb3cb75e8858295dd08c800ec810e">oscap_text_get_text</a> (const struct <a class="el" href="structoscap__text.html">oscap_text</a> *text)</td></tr> <tr class="separator:gaca2bb3cb75e8858295dd08c800ec810e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga33302545c993d04c5640070f5ebcdf38"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga33302545c993d04c5640070f5ebcdf38">oscap_text_get_lang</a> (const struct <a class="el" href="structoscap__text.html">oscap_text</a> *text)</td></tr> <tr class="separator:ga33302545c993d04c5640070f5ebcdf38"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab02f75978463d8749b4f4585519d78ae"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#gab02f75978463d8749b4f4585519d78ae">oscap_text_get_plaintext</a> (const struct <a class="el" href="structoscap__text.html">oscap_text</a> *text)</td></tr> <tr class="memdesc:gab02f75978463d8749b4f4585519d78ae"><td class="mdescLeft"> </td><td class="mdescRight">Get plaintext representation of the text. <a href="group__STRINGS.html#gab02f75978463d8749b4f4585519d78ae">More...</a><br/></td></tr> <tr class="separator:gab02f75978463d8749b4f4585519d78ae"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac0759b0a3b3608446818b1ae3ded6410"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac0759b0a3b3608446818b1ae3ded6410"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#gac0759b0a3b3608446818b1ae3ded6410">oscap_text_get_is_html</a> (const struct <a class="el" href="structoscap__text.html">oscap_text</a> *text)</td></tr> <tr class="memdesc:gac0759b0a3b3608446818b1ae3ded6410"><td class="mdescLeft"> </td><td class="mdescRight">Does this text posses a HTML content? <br/></td></tr> <tr class="separator:gac0759b0a3b3608446818b1ae3ded6410"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3f239371f339469e8cc1ffc2bd93d573"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3f239371f339469e8cc1ffc2bd93d573"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga3f239371f339469e8cc1ffc2bd93d573">oscap_text_get_can_substitute</a> (const struct <a class="el" href="structoscap__text.html">oscap_text</a> *text)</td></tr> <tr class="memdesc:ga3f239371f339469e8cc1ffc2bd93d573"><td class="mdescLeft"> </td><td class="mdescRight">Can this text contain substitutions? <br/></td></tr> <tr class="separator:ga3f239371f339469e8cc1ffc2bd93d573"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga4b6bbeb0263f08c3428e23efd47822f1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4b6bbeb0263f08c3428e23efd47822f1"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga4b6bbeb0263f08c3428e23efd47822f1">oscap_text_get_can_override</a> (const struct <a class="el" href="structoscap__text.html">oscap_text</a> *text)</td></tr> <tr class="memdesc:ga4b6bbeb0263f08c3428e23efd47822f1"><td class="mdescLeft"> </td><td class="mdescRight">Can this text override parent content? <br/></td></tr> <tr class="separator:ga4b6bbeb0263f08c3428e23efd47822f1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga17bc03b25bddb5ed732031744c54ba7a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga17bc03b25bddb5ed732031744c54ba7a"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga17bc03b25bddb5ed732031744c54ba7a">oscap_text_get_overrides</a> (const struct <a class="el" href="structoscap__text.html">oscap_text</a> *text)</td></tr> <tr class="memdesc:ga17bc03b25bddb5ed732031744c54ba7a"><td class="mdescLeft"> </td><td class="mdescRight">Does this text override parent content? <br/></td></tr> <tr class="separator:ga17bc03b25bddb5ed732031744c54ba7a"><td class="memSeparator" colspan="2"> </td></tr> <tr><td colspan="2"><div class="groupHeader">Setters</div></td></tr> <tr><td colspan="2"><div class="groupText"><p>For lists use add functions.</p> <p>Parameters of set functions are duplicated in memory and need to be freed by caller. </p> </div></td></tr> <tr class="memitem:ga732452af164f4a21ad67c67603359d31"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga732452af164f4a21ad67c67603359d31"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga732452af164f4a21ad67c67603359d31">oscap_text_set_overrides</a> (struct <a class="el" href="structoscap__text.html">oscap_text</a> *text, bool overrides)</td></tr> <tr class="memdesc:ga732452af164f4a21ad67c67603359d31"><td class="mdescLeft"> </td><td class="mdescRight">Set whether this text overrides parent content. <br/></td></tr> <tr class="separator:ga732452af164f4a21ad67c67603359d31"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga22a6653f1f8237f3a7f6ad8cdb89a65e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga22a6653f1f8237f3a7f6ad8cdb89a65e">oscap_text_set_text</a> (struct <a class="el" href="structoscap__text.html">oscap_text</a> *text, const char *string)</td></tr> <tr class="separator:ga22a6653f1f8237f3a7f6ad8cdb89a65e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2b1c5275f76416de713f0234993c3475"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__STRINGS.html#ga2b1c5275f76416de713f0234993c3475">oscap_text_set_lang</a> (struct <a class="el" href="structoscap__text.html">oscap_text</a> *text, const char *string)</td></tr> <tr class="separator:ga2b1c5275f76416de713f0234993c3475"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:ac88de7b67317cfdaa14396ceb19ac93d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac88de7b67317cfdaa14396ceb19ac93d"></a> char * </td><td class="memItemRight" valign="bottom"><b>lang</b></td></tr> <tr class="separator:ac88de7b67317cfdaa14396ceb19ac93d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a179ab1f0213b44e48c624102b6ebb0d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a179ab1f0213b44e48c624102b6ebb0d4"></a> char * </td><td class="memItemRight" valign="bottom"><b>text</b></td></tr> <tr class="separator:a179ab1f0213b44e48c624102b6ebb0d4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeeefbb311de50144c40aa192bf5bed9e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeeefbb311de50144c40aa192bf5bed9e"></a> struct <a class="el" href="structoscap__text__traits.html">oscap_text_traits</a> </td><td class="memItemRight" valign="bottom"><b>traits</b></td></tr> <tr class="separator:aeeefbb311de50144c40aa192bf5bed9e"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Representation of internationalizable character strings. </p> </div><hr/>The documentation for this struct was generated from the following files:<ul> <li><a class="el" href="text__priv_8h_source.html">text_priv.h</a></li> <li><a class="el" href="oscap__text_8h_source.html">oscap_text.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.6 </small></address> </body> </html>