<!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>libcomps: /home/ichiro/data/ssd/Momonga/trunk/pkgs/libcomps/BUILD/libcomps-475cba38b309cada09b0119f31bc0dc2a6fbd676/libcomps/src/comps_doccategory.h File 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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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">libcomps  <span id="projectnumber">..</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_75b82e7e4a5feb05200b9ad7adf06257.html">home</a></li><li class="navelem"><a class="el" href="dir_7c02739ef81c0485233693131238404a.html">ichiro</a></li><li class="navelem"><a class="el" href="dir_a7732ac979a450922d402ee5d7cfd147.html">data</a></li><li class="navelem"><a class="el" href="dir_2f95b435d99e6a2db860545f9af1163b.html">ssd</a></li><li class="navelem"><a class="el" href="dir_6f7c6b8180002a9261797965a15bd780.html">Momonga</a></li><li class="navelem"><a class="el" href="dir_0aee105f0b4152b3c194610088fbc072.html">trunk</a></li><li class="navelem"><a class="el" href="dir_52983f913545f7ba464eac1f2344e8cf.html">pkgs</a></li><li class="navelem"><a class="el" href="dir_eab8847f9f5b7cad8b3d45ab783f0cda.html">libcomps</a></li><li class="navelem"><a class="el" href="dir_84fef8e2c6efb6e6534a3219ccc4acba.html">BUILD</a></li><li class="navelem"><a class="el" href="dir_32b886d695150753126a77bfe6c4f5d4.html">libcomps-475cba38b309cada09b0119f31bc0dc2a6fbd676</a></li><li class="navelem"><a class="el" href="dir_8c958afafb809eb39ec60e41878b6115.html">libcomps</a></li><li class="navelem"><a class="el" href="dir_517e8baf7eb29cfa291db79554978abf.html">src</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">comps_doccategory.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> header file. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="comps__obj_8h_source.html">comps_obj.h</a>"</code><br/> <code>#include "<a class="el" href="comps__objdict_8h_source.html">comps_objdict.h</a>"</code><br/> <code>#include "<a class="el" href="comps__objlist_8h_source.html">comps_objlist.h</a>"</code><br/> <code>#include "comps_utils.h"</code><br/> <code>#include "<a class="el" href="comps__docgroupid_8h_source.html">comps_docgroupid.h</a>"</code><br/> <code>#include "comps_validate.h"</code><br/> <code>#include "comps_radix.h"</code><br/> <code>#include "comps_log.h"</code><br/> <code>#include "comps_default.h"</code><br/> <code>#include <stddef.h></code><br/> <code>#include <assert.h></code><br/> </div> <p><a href="comps__doccategory_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga219e951c229e9a40e45278995dda5e01"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__prop__setters.html#ga219e951c229e9a40e45278995dda5e01">comps_doccategory_set_id</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *category, char *id, char copy)</td></tr> <tr class="separator:ga219e951c229e9a40e45278995dda5e01"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga47d6629618885dee26f81266823e23c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__prop__setters.html#ga47d6629618885dee26f81266823e23c3">comps_doccategory_set_name</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *category, char *name, char copy)</td></tr> <tr class="separator:ga47d6629618885dee26f81266823e23c3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2e563a9ef05e592b84b5ef005387ec11"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__prop__setters.html#ga2e563a9ef05e592b84b5ef005387ec11">comps_doccategory_set_desc</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *category, char *desc, char copy)</td></tr> <tr class="separator:ga2e563a9ef05e592b84b5ef005387ec11"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac092c1ad631dededaf7c699bc937a7bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__prop__setters.html#gac092c1ad631dededaf7c699bc937a7bf">comps_doccategory_set_display_order</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *category, int display_order, bool unset)</td></tr> <tr class="separator:gac092c1ad631dededaf7c699bc937a7bf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8d2ab0f9b9b35e8089f236b1fcacb3e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__prop__getters.html#ga8d2ab0f9b9b35e8089f236b1fcacb3e8">comps_doccategory_get_id</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *category)</td></tr> <tr class="separator:ga8d2ab0f9b9b35e8089f236b1fcacb3e8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2419f583195eccbc369f8c943654a645"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__prop__getters.html#ga2419f583195eccbc369f8c943654a645">comps_doccategory_get_name</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *category)</td></tr> <tr class="separator:ga2419f583195eccbc369f8c943654a645"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga1bae0b5610ad955f3da234d58389ccd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__prop__getters.html#ga1bae0b5610ad955f3da234d58389ccd8">comps_doccategory_get_desc</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *category)</td></tr> <tr class="separator:ga1bae0b5610ad955f3da234d58389ccd8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9580879d43424fe4535e9864810ff97d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__prop__getters.html#ga9580879d43424fe4535e9864810ff97d">comps_doccategory_get_display_order</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *category)</td></tr> <tr class="separator:ga9580879d43424fe4535e9864810ff97d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6dbff59b6bba235b79539349c028a0e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__ObjList.html">COMPS_ObjList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__list__getters.html#ga6dbff59b6bba235b79539349c028a0e2">comps_doccategory_group_ids</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *obj)</td></tr> <tr class="separator:ga6dbff59b6bba235b79539349c028a0e2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0da1a02b7f02fc4fbcd6d6fb97c3dbfa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__COMPS__DocCategory__list__setters.html#ga0da1a02b7f02fc4fbcd6d6fb97c3dbfa">comps_doccategory_set_group_ids</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *obj, <a class="el" href="structCOMPS__ObjList.html">COMPS_ObjList</a> *list)</td></tr> <tr class="separator:ga0da1a02b7f02fc4fbcd6d6fb97c3dbfa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7868a20117eb11c8769cd05c0635bdf0"><td class="memItemLeft" align="right" valign="top">signed char </td><td class="memItemRight" valign="bottom"><a class="el" href="comps__doccategory_8h.html#a7868a20117eb11c8769cd05c0635bdf0">comps_doccategory_cmp_u</a> (<a class="el" href="structCOMPS__Object.html">COMPS_Object</a> *cat1, <a class="el" href="structCOMPS__Object.html">COMPS_Object</a> *cat2)</td></tr> <tr class="separator:a7868a20117eb11c8769cd05c0635bdf0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1596649bc82d0a3faaef03d47eabc150"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="comps__doccategory_8h.html#a1596649bc82d0a3faaef03d47eabc150">comps_doccategory_add_groupid</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *cat, <a class="el" href="structCOMPS__DocGroupId.html">COMPS_DocGroupId</a> *gid)</td></tr> <tr class="separator:a1596649bc82d0a3faaef03d47eabc150"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a92affe008017d92d939bba5b7f92fa21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="comps__doccategory_8h.html#a92affe008017d92d939bba5b7f92fa21">comps_doccategory_union</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *c1, <a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *c2)</td></tr> <tr class="separator:a92affe008017d92d939bba5b7f92fa21"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab138c4a11833306e74cfc37f7bfcf182"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="comps__doccategory_8h.html#ab138c4a11833306e74cfc37f7bfcf182">comps_doccategory_intersect</a> (<a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *c1, <a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> *c2)</td></tr> <tr class="separator:ab138c4a11833306e74cfc37f7bfcf182"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> header file. </p> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__COMPS__DocCategory__prop__setters.html">COMPS_DocCategory properties setters</a> </dd> <dd> <a class="el" href="group__COMPS__DocCategory__prop__getters.html">COMPS_CategoryGroup properties getters</a> </dd> <dd> <a class="el" href="group__COMPS__DocCategory__list__setters.html">COMPS_DocCategory list setters</a> </dd> <dd> <a class="el" href="group__COMPS__DocCategory__list__getters.html">COMPS_DocCategory list getters</a></dd></dl> <p><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object support union operation. Read more about <a class="el" href="">Libcomps objects unioning </a> </p> </div><h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="a1596649bc82d0a3faaef03d47eabc150"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void comps_doccategory_add_groupid </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> * </td> <td class="paramname"><em>cat</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structCOMPS__DocGroupId.html">COMPS_DocGroupId</a> * </td> <td class="paramname"><em>gid</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>add group_id to group_ids list in category </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">cat</td><td><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </td></tr> <tr><td class="paramname">gid</td><td><a class="el" href="structCOMPS__DocGroupId.html">COMPS_DocGroupId</a> object </td></tr> </table> </dd> </dl> <dl class="section warning"><dt>Warning</dt><dd><a class="el" href="structCOMPS__DocGroupId.html">COMPS_DocGroupId</a> reference counter isn't incremented </dd></dl> </div> </div> <a class="anchor" id="a7868a20117eb11c8769cd05c0635bdf0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">signed char comps_doccategory_cmp_u </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td> <td class="paramname"><em>cat1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structCOMPS__Object.html">COMPS_Object</a> * </td> <td class="paramname"><em>cat2</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> compare callback </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">cat1</td><td><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </td></tr> <tr><td class="paramname">cat2</td><td><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>non-zero if objects are equal, otherwise 0 </dd></dl> </div> </div> <a class="anchor" id="ab138c4a11833306e74cfc37f7bfcf182"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a>* comps_doccategory_intersect </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> * </td> <td class="paramname"><em>c1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> * </td> <td class="paramname"><em>c2</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>intersect two categories into one and return new <a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">c1</td><td><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </td></tr> <tr><td class="paramname">c2</td><td><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>new <a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </dd></dl> </div> </div> <a class="anchor" id="a92affe008017d92d939bba5b7f92fa21"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a>* comps_doccategory_union </td> <td>(</td> <td class="paramtype"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> * </td> <td class="paramname"><em>c1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> * </td> <td class="paramname"><em>c2</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>union two categories into one and return new <a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">c1</td><td><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </td></tr> <tr><td class="paramname">c2</td><td><a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>new <a class="el" href="structCOMPS__DocCategory.html">COMPS_DocCategory</a> object </dd></dl> </div> </div> </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>