<!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::Main 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::Main Class Reference</h1><code>#include <<a class="el" href="main_8h-source.html">main.h</a>></code>
<p>
<p>Inheritance diagram for Gnome::Main:
<p><center><img src="classGnome_1_1Main.png" usemap="#Gnome::Main_map" border="0" alt=""></center>
<map name="Gnome::Main_map">
<area href="classGtk_1_1Main.html" alt="Main" shape="rect" coords="0,0,85,24">
</map>
<a href="classGnome_1_1Main-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_1Main.html#a0">Main</a> (const Glib::ustring &app_id, const Glib::ustring &app_version, const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &module_info, int argc, char **argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialises the current GNOME libraries for use by the application. <a href="#a0"></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_1Main.html#a1">Main</a> (const Glib::ustring &app_id, const Glib::ustring &app_version, const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &module_info, int argc, char **argv, const struct poptOption *options, int flags, poptContext *return_ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialises the current GNOME libraries for use by the application, and takes a table of popt options (popt is the command line argument parsing library). <a href="#a1"></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_1Main.html#a2">~Main</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected 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_1Main.html#b0">Main</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_1Main.html#b1">set_ids</a> (const Glib::ustring &app_id, const Glib::ustring &app_version)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Glib::RefPtr< <a class="el" href="classGnome_1_1Program.html">Program</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#p0">m_refProgram</a></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#t0">app_id_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#t1">app_version_</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="Gnome::Main::Main"></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::Main::Main </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const Glib::ustring & </td>
<td class="mdname" nowrap> <em>app_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const Glib::ustring & </td>
<td class="mdname" nowrap> <em>app_version</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td>
<td class="mdname" nowrap> <em>module_info</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>argc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char ** </td>
<td class="mdname" nowrap> <em>argv</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>
Initialises the current GNOME libraries for use by the application.
<p>
Every GNOME application will need to use this early in its lifetime to initialize the various GNOME libraries in a consistent fashion. This function is very flexible in allowing the user to specify which modules should be initialised and any special parameter values that should be passed to these modules (along with processing commandline options). It loads the specified module_info, and pulls in all the dependencies. Programs that are not running in setuid or setgid mode will also load modules specified in the --load-modules and also in the GNOME_MODULES environment variable.<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>app_id</em> </td><td>Application ID string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>app_version</em> </td><td>Application Version String. This could be defined in your auto-generated config.h file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>The</em> </td><td>module to init with this program. This should come from a call such as <a class="el" href="namespaceGnome.html#a13">Gnome::UI::module_info_get()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argc</em> </td><td>The number of command line arguments contanied in <em>argv</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>A string array of command line arguments. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="Gnome::Main::Main"></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::Main::Main </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const Glib::ustring & </td>
<td class="mdname" nowrap> <em>app_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const Glib::ustring & </td>
<td class="mdname" nowrap> <em>app_version</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> & </td>
<td class="mdname" nowrap> <em>module_info</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>argc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char ** </td>
<td class="mdname" nowrap> <em>argv</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const struct poptOption * </td>
<td class="mdname" nowrap> <em>options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>flags</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>poptContext * </td>
<td class="mdname" nowrap> <em>return_ctx</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>
Initialises the current GNOME libraries for use by the application, and takes a table of popt options (popt is the command line argument parsing library).
<p>
Every GNOME application will need to use this early in its lifetime to initialize the various GNOME libraries in a consistent fashion. This function is very flexible in allowing the user to specify which modules should be initialised and any special parameter values that should be passed to these modules (along with processing commandline options). It loads the specified module_info, and pulls in all the dependencies. Programs that are not running in setuid or setgid mode will also load modules specified in the --load-modules and also in the GNOME_MODULES environment variable.<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>app_id</em> </td><td>Application ID string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>app_version</em> </td><td>Application Version String. This could be defined in your auto-generated config.h file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>The</em> </td><td>module to init with this program. This should come from a call such as <a class="el" href="namespaceGnome.html#a13">Gnome::UI::module_info_get()</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argc</em> </td><td>The number of command line arguments contanied in <em>argv</em>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>A string array of command line arguments. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>options</em> </td><td>poptOption table with options to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>popt</em> </td><td>flags. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>return_ctx</em> </td><td>The popt context is returned here. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="Gnome::Main::~Main"></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::Main::~<a class="el" href="classGnome_1_1Main.html">Main</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="b0" doxytag="Gnome::Main::Main"></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::Main::Main </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> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b1" doxytag="Gnome::Main::set_ids"></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::Main::set_ids </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const Glib::ustring & </td>
<td class="mdname" nowrap> <em>app_id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const Glib::ustring & </td>
<td class="mdname" nowrap> <em>app_version</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><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><h2>Member Data Documentation</h2>
<a class="anchor" name="t0" doxytag="Gnome::Main::app_id_"></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">char* <a class="el" href="classGnome_1_1Main.html#t0">Gnome::Main::app_id_</a><code> [static, protected]</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="t1" doxytag="Gnome::Main::app_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">char* <a class="el" href="classGnome_1_1Main.html#t1">Gnome::Main::app_version_</a><code> [static, protected]</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="p0" doxytag="Gnome::Main::m_refProgram"></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::RefPtr<<a class="el" href="classGnome_1_1Program.html">Program</a>> <a class="el" href="classGnome_1_1Main.html#p0">Gnome::Main::m_refProgram</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="main_8h-source.html">main.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>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
851aab158165f05e21cfa6e9c76026db
>
files
>
33
