<!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"> </head><body> <!-- Generated by Doxygen 1.3.9.1 --> <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="namespaces.html">Namespace List</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">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> <h1>Gnome::ModuleInfo Class Reference</h1><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#a0">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#a1">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#a2">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#a3">~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#a4">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#a5">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a5"></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#a6">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a6"></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#a7">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="#a7"></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#a8">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#a9">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="#a9"></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#a10">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#a11">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#a12">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#a13">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#a14">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#p0">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#m0">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="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#m1">wrap</a> (GnomeModuleInfo *object, bool take_copy=false)</td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="a0" doxytag="Gnome::ModuleInfo::ModuleInfo"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Gnome::ModuleInfo::ModuleInfo </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GnomeModuleInfo * </td> <td class="mdname" nowrap> <em>gobject</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>make_a_copy</em> = <code>true</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [explicit]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a1" doxytag="Gnome::ModuleInfo::ModuleInfo"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Gnome::ModuleInfo::ModuleInfo </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="mdname1" valign="top" nowrap> <em>other</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a3" doxytag="Gnome::ModuleInfo::~ModuleInfo"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Gnome::ModuleInfo::~<a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a8" doxytag="Gnome::ModuleInfo::ModuleInfo"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Gnome::ModuleInfo::ModuleInfo </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a9" doxytag="Gnome::ModuleInfo::ModuleInfo"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Gnome::ModuleInfo::ModuleInfo </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const gchar * </td> <td class="mdname" nowrap> <em>name</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>const gchar * </td> <td class="mdname" nowrap> <em>version</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>const gchar * </td> <td class="mdname" nowrap> <em>description</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> The strings must be statically allocated - i.e. string literals. <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a12" doxytag="Gnome::ModuleInfo::get_description"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Glib::ustring Gnome::ModuleInfo::get_description </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a10" doxytag="Gnome::ModuleInfo::get_name"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Glib::ustring Gnome::ModuleInfo::get_name </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a11" doxytag="Gnome::ModuleInfo::get_version"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">Glib::ustring Gnome::ModuleInfo::get_version </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a6" doxytag="Gnome::ModuleInfo::gobj"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">const GnomeModuleInfo* Gnome::ModuleInfo::gobj </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Provides access to the underlying C instance. <p> </td> </tr> </table> <a class="anchor" name="a5" doxytag="Gnome::ModuleInfo::gobj"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">GnomeModuleInfo* Gnome::ModuleInfo::gobj </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Provides access to the underlying C instance. <p> </td> </tr> </table> <a class="anchor" name="a7" doxytag="Gnome::ModuleInfo::gobj_copy"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">GnomeModuleInfo* Gnome::ModuleInfo::gobj_copy </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. <p> </td> </tr> </table> <a class="anchor" name="a2" doxytag="Gnome::ModuleInfo::operator="></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a>& Gnome::ModuleInfo::operator= </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="mdname1" valign="top" nowrap> <em>other</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a14" doxytag="Gnome::ModuleInfo::set_post_args_parse"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void Gnome::ModuleInfo::set_post_args_parse </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GnomeModuleHook </td> <td class="mdname1" valign="top" nowrap> <em>function</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a13" doxytag="Gnome::ModuleInfo::set_requirements"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void Gnome::ModuleInfo::set_requirements </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GnomeModuleRequirement * </td> <td class="mdname1" valign="top" nowrap> <em>requirements</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="a4" doxytag="Gnome::ModuleInfo::swap"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void Gnome::ModuleInfo::swap </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="mdname1" valign="top" nowrap> <em>other</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="m0" doxytag="Gnome::ModuleInfo::swap"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void swap </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="mdname" nowrap> <em>lhs</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td> <td class="mdname" nowrap> <em>rhs</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [related]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <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> <tr><td valign="top"></td><td valign="top"><em>rhs</em> </td><td>The right-hand side </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="m1" doxytag="Gnome::ModuleInfo::wrap"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"><a class="el" href="classGnome_1_1ModuleInfo.html">Gnome::ModuleInfo</a> wrap </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">GnomeModuleInfo * </td> <td class="mdname" nowrap> <em>object</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>take_copy</em> = <code>false</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"><code> [related]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <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 compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </td> </tr> </table> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="p0" doxytag="Gnome::ModuleInfo::gobject_"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">GnomeModuleInfo* <a class="el" href="classGnome_1_1ModuleInfo.html#p0">Gnome::ModuleInfo::gobject_</a><code> [protected]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> </td> </tr> </table> <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 Mon Mar 7 11:08:42 2005 for libgnomemm by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address> </body> </html>