<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>libgnomemm: Gnome::ModuleInfo Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.1 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li id="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul></div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <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 class="nav"> <a class="el" href="namespaceGnome.html">Gnome</a>::<a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a></div> <h1>Gnome::ModuleInfo Class Reference</h1><!-- doxytag: class="Gnome::ModuleInfo" --><code>#include <<a class="el" href="moduleinfo_8h-source.html">moduleinfo.h</a>></code> <p> <a href="classGnome_1_1ModuleInfo-members.html">List of all members.</a><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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#3b644929c109c3192d016cfff88015d2">ModuleInfo</a> (GnomeModuleInfo *gobject, bool make_a_copy=true)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#27b2968d6a7d1ac9281ff36ae8a0f28c">ModuleInfo</a> (const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#0cad93a5d0390e78e25bb61d71333e7e">operator=</a> (const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#eff90d58e1fd6a547d8ae14a05c6fe71">~ModuleInfo</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#afa23c925b0d582fecd285abb9ad0ae9">swap</a> (<a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">GnomeModuleInfo * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#3aaedaf3ecd60ac561d173a1659e04e1">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#3aaedaf3ecd60ac561d173a1659e04e1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const GnomeModuleInfo * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#5f698763d419470324eb574f2d2320c2">gobj</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#5f698763d419470324eb574f2d2320c2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">GnomeModuleInfo * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#c0da4127abf2cd2710e2d3315c0f6632">gobj_copy</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. <a href="#c0da4127abf2cd2710e2d3315c0f6632"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#eed9cfc0df2e9c2b9c143e1b5a9a4b3d">ModuleInfo</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#287ad1e6107b2e3ccaf431783645dce6">ModuleInfo</a> (const gchar *name, const gchar *version, const gchar *description)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The strings must be statically allocated - i.e. string literals. <a href="#287ad1e6107b2e3ccaf431783645dce6"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#3f3c3ae048afc0c7efd5fdd1666aabea">get_name</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#74bf9bd912e83f0d63b9c2bde787b3f7">get_version</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#9ee04a51ec7aa02d09de8cf4add4633a">get_description</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#d06f7bf5e99e686ce3406ea6d3af91ac">set_requirements</a> (GnomeModuleRequirement *requirements)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#3803c0856ed7981e39d4112a48dbe7dc">set_post_args_parse</a> (GnomeModuleHook function)</td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">GnomeModuleInfo * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#30965713786f9e3de4d6f04ca7ce29af">gobject_</a></td></tr> <tr><td colspan="2"><br><h2>Related Functions</h2></td></tr> <tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#75729c32d7c603bbddf8514f48c98bcb">swap</a> (<a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &lhs, <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &rhs)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>lhs</em> </td><td>The left-hand side </td></tr> </table> </dl> <a href="#75729c32d7c603bbddf8514f48c98bcb"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGnome_1_1ModuleInfo.html">Gnome::ModuleInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1ModuleInfo.html#ef74a45361fe021a0cb7c7f8658765e6">wrap</a> (GnomeModuleInfo *object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A Glib::wrap() method for this object. <a href="#ef74a45361fe021a0cb7c7f8658765e6"></a><br></td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="3b644929c109c3192d016cfff88015d2"></a><!-- doxytag: member="Gnome::ModuleInfo::ModuleInfo" ref="3b644929c109c3192d016cfff88015d2" args="(GnomeModuleInfo *gobject, bool make_a_copy=true)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gnome::ModuleInfo::ModuleInfo </td> <td>(</td> <td class="paramtype">GnomeModuleInfo * </td> <td class="paramname"> <em>gobject</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>make_a_copy</em> = <code>true</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [explicit]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="27b2968d6a7d1ac9281ff36ae8a0f28c"></a><!-- doxytag: member="Gnome::ModuleInfo::ModuleInfo" ref="27b2968d6a7d1ac9281ff36ae8a0f28c" args="(const ModuleInfo &other)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gnome::ModuleInfo::ModuleInfo </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="paramname"> <em>other</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="eff90d58e1fd6a547d8ae14a05c6fe71"></a><!-- doxytag: member="Gnome::ModuleInfo::~ModuleInfo" ref="eff90d58e1fd6a547d8ae14a05c6fe71" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gnome::ModuleInfo::~ModuleInfo </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="eed9cfc0df2e9c2b9c143e1b5a9a4b3d"></a><!-- doxytag: member="Gnome::ModuleInfo::ModuleInfo" ref="eed9cfc0df2e9c2b9c143e1b5a9a4b3d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gnome::ModuleInfo::ModuleInfo </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="287ad1e6107b2e3ccaf431783645dce6"></a><!-- doxytag: member="Gnome::ModuleInfo::ModuleInfo" ref="287ad1e6107b2e3ccaf431783645dce6" args="(const gchar *name, const gchar *version, const gchar *description)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gnome::ModuleInfo::ModuleInfo </td> <td>(</td> <td class="paramtype">const gchar * </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const gchar * </td> <td class="paramname"> <em>version</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const gchar * </td> <td class="paramname"> <em>description</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> The strings must be statically allocated - i.e. string literals. <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="0cad93a5d0390e78e25bb61d71333e7e"></a><!-- doxytag: member="Gnome::ModuleInfo::operator=" ref="0cad93a5d0390e78e25bb61d71333e7e" args="(const ModuleInfo &other)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a>& Gnome::ModuleInfo::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="paramname"> <em>other</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="afa23c925b0d582fecd285abb9ad0ae9"></a><!-- doxytag: member="Gnome::ModuleInfo::swap" ref="afa23c925b0d582fecd285abb9ad0ae9" args="(ModuleInfo &other)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gnome::ModuleInfo::swap </td> <td>(</td> <td class="paramtype"><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="paramname"> <em>other</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="3aaedaf3ecd60ac561d173a1659e04e1"></a><!-- doxytag: member="Gnome::ModuleInfo::gobj" ref="3aaedaf3ecd60ac561d173a1659e04e1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GnomeModuleInfo* Gnome::ModuleInfo::gobj </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Provides access to the underlying C instance. <p> </div> </div><p> <a class="anchor" name="5f698763d419470324eb574f2d2320c2"></a><!-- doxytag: member="Gnome::ModuleInfo::gobj" ref="5f698763d419470324eb574f2d2320c2" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GnomeModuleInfo* Gnome::ModuleInfo::gobj </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Provides access to the underlying C instance. <p> </div> </div><p> <a class="anchor" name="c0da4127abf2cd2710e2d3315c0f6632"></a><!-- doxytag: member="Gnome::ModuleInfo::gobj_copy" ref="c0da4127abf2cd2710e2d3315c0f6632" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GnomeModuleInfo* Gnome::ModuleInfo::gobj_copy </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. <p> </div> </div><p> <a class="anchor" name="3f3c3ae048afc0c7efd5fdd1666aabea"></a><!-- doxytag: member="Gnome::ModuleInfo::get_name" ref="3f3c3ae048afc0c7efd5fdd1666aabea" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::ustring Gnome::ModuleInfo::get_name </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="74bf9bd912e83f0d63b9c2bde787b3f7"></a><!-- doxytag: member="Gnome::ModuleInfo::get_version" ref="74bf9bd912e83f0d63b9c2bde787b3f7" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::ustring Gnome::ModuleInfo::get_version </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="9ee04a51ec7aa02d09de8cf4add4633a"></a><!-- doxytag: member="Gnome::ModuleInfo::get_description" ref="9ee04a51ec7aa02d09de8cf4add4633a" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Glib::ustring Gnome::ModuleInfo::get_description </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="d06f7bf5e99e686ce3406ea6d3af91ac"></a><!-- doxytag: member="Gnome::ModuleInfo::set_requirements" ref="d06f7bf5e99e686ce3406ea6d3af91ac" args="(GnomeModuleRequirement *requirements)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gnome::ModuleInfo::set_requirements </td> <td>(</td> <td class="paramtype">GnomeModuleRequirement * </td> <td class="paramname"> <em>requirements</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="3803c0856ed7981e39d4112a48dbe7dc"></a><!-- doxytag: member="Gnome::ModuleInfo::set_post_args_parse" ref="3803c0856ed7981e39d4112a48dbe7dc" args="(GnomeModuleHook function)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gnome::ModuleInfo::set_post_args_parse </td> <td>(</td> <td class="paramtype">GnomeModuleHook </td> <td class="paramname"> <em>function</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="75729c32d7c603bbddf8514f48c98bcb"></a><!-- doxytag: member="Gnome::ModuleInfo::swap" ref="75729c32d7c603bbddf8514f48c98bcb" args="(ModuleInfo &lhs, ModuleInfo &rhs)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void swap </td> <td>(</td> <td class="paramtype"><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="paramname"> <em>lhs</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="paramname"> <em>rhs</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>lhs</em> </td><td>The left-hand side </td></tr> </table> </dl> <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>rhs</em> </td><td>The right-hand side </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="ef74a45361fe021a0cb7c7f8658765e6"></a><!-- doxytag: member="Gnome::ModuleInfo::wrap" ref="ef74a45361fe021a0cb7c7f8658765e6" args="(GnomeModuleInfo *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGnome_1_1ModuleInfo.html">Gnome::ModuleInfo</a> wrap </td> <td>(</td> <td class="paramtype">GnomeModuleInfo * </td> <td class="paramname"> <em>object</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p> A Glib::wrap() method for this object. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr> <tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="30965713786f9e3de4d6f04ca7ce29af"></a><!-- doxytag: member="Gnome::ModuleInfo::gobject_" ref="30965713786f9e3de4d6f04ca7ce29af" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GnomeModuleInfo* <a class="el" href="classGnome_1_1ModuleInfo.html#30965713786f9e3de4d6f04ca7ce29af">Gnome::ModuleInfo::gobject_</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="moduleinfo_8h-source.html">moduleinfo.h</a></ul> <hr size="1"><address style="align: right;"><small>Generated on Thu Jan 17 11:50:20 2008 for libgnomemm by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address> </body> </html>