Sophie

Sophie

distrib > Mageia > 6 > i586 > media > core-release > by-pkgid > 87b2cbc2f2d1a1b27119c8c080679c13 > files > 33

libgnomemm2.6-devel-2.30.0-9.mga6.i586.rpm

<!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"/>
<title>libgnomemm: Gnome::Main Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceGnome.html">Gnome</a>::<a class="el" href="classGnome_1_1Main.html">Main</a>
  </div>
</div>
<div class="contents">
<h1>Gnome::Main Class Reference</h1><!-- doxytag: class="Gnome::Main" --><!-- doxytag: inherits="Gtk::Main" -->
<p><code>#include &lt;<a class="el" href="main_8h_source.html">main.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Gnome::Main:</div>
<div class="dynsection">
<div class="center"><img src="classGnome_1_1Main__inherit__graph.png" border="0" usemap="#Gnome_1_1Main_inherit__map" alt="Inheritance graph"/></div>
<map name="Gnome_1_1Main_inherit__map" id="Gnome_1_1Main_inherit__map">
<area shape="rect" href="classGtk_1_1Main.html" title="Gtk::Main" alt="" coords="16,5,93,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classGnome_1_1Main-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#a2634bffb0fffc675d690ce9013a18078">Main</a> (const Glib::ustring &amp;app_id, const Glib::ustring &amp;app_version, const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &amp;module_info, int argc, char **argv)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialises the current GNOME libraries for use by the application.  <a href="#a2634bffb0fffc675d690ce9013a18078"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#a6d282135070df719af1b16b9df31dc22">Main</a> (const Glib::ustring &amp;app_id, const Glib::ustring &amp;app_version, const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &amp;module_info, int argc, char **argv, const struct poptOption *options, int flags, poptContext *return_ctx)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="#a6d282135070df719af1b16b9df31dc22"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#a82061403b30fe46572e058fe659061a8">Main</a> (const Glib::ustring &amp;app_id, const Glib::ustring &amp;app_version, const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &amp;module_info, int argc, char **argv, Glib::OptionContext &amp;options)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialises the current GNOME libraries for use by the application, and takes an OptionContext for command line arguments.  <a href="#a82061403b30fe46572e058fe659061a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#a3a8d0b53a9988651cb22e22618da90d8">~Main</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#a676da7cd431912fa68e4f9d1f43a2589">Main</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#ade54889b940457c646d46e37b57a13cf">set_ids</a> (const Glib::ustring &amp;app_id, const Glib::ustring &amp;app_version)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Glib::RefPtr&lt; <a class="el" href="classGnome_1_1Program.html">Program</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#aa1390fe7570067b88c887f8f2c40b0d4">m_refProgram</a></td></tr>
<tr><td colspan="2"><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#a597f262c3022c40446a02acb75dbc7f7">app_id_</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Main.html#a269b840cb081f67230508c601300e5cc">app_version_</a></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2634bffb0fffc675d690ce9013a18078"></a><!-- doxytag: member="Gnome::Main::Main" ref="a2634bffb0fffc675d690ce9013a18078" args="(const Glib::ustring &amp;app_id, const Glib::ustring &amp;app_version, const ModuleInfo &amp;module_info, int argc, char **argv)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gnome::Main::Main </td>
          <td>(</td>
          <td class="paramtype">const Glib::ustring &amp;&nbsp;</td>
          <td class="paramname"> <em>app_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Glib::ustring &amp;&nbsp;</td>
          <td class="paramname"> <em>app_version</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>module_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&nbsp;</td>
          <td class="paramname"> <em>argv</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialises the current GNOME libraries for use by the application. </p>
<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><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>&nbsp;</td><td>Application ID string. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>app_version</em>&nbsp;</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>&nbsp;</td><td>module to init with this program. This should come from a call such as <a class="el" href="namespaceGnome.html#aae4a3a5913202ab92ab80e5161efa0b9">Gnome::UI::module_info_get()</a>. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>argc</em>&nbsp;</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>&nbsp;</td><td>A string array of command line arguments. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6d282135070df719af1b16b9df31dc22"></a><!-- doxytag: member="Gnome::Main::Main" ref="a6d282135070df719af1b16b9df31dc22" args="(const Glib::ustring &amp;app_id, const Glib::ustring &amp;app_version, const ModuleInfo &amp;module_info, int argc, char **argv, const struct poptOption *options, int flags, poptContext *return_ctx)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gnome::Main::Main </td>
          <td>(</td>
          <td class="paramtype">const Glib::ustring &amp;&nbsp;</td>
          <td class="paramname"> <em>app_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Glib::ustring &amp;&nbsp;</td>
          <td class="paramname"> <em>app_version</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>module_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&nbsp;</td>
          <td class="paramname"> <em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const struct poptOption *&nbsp;</td>
          <td class="paramname"> <em>options</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>flags</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">poptContext *&nbsp;</td>
          <td class="paramname"> <em>return_ctx</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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>
<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><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>&nbsp;</td><td>Application ID string. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>app_version</em>&nbsp;</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>&nbsp;</td><td>module to init with this program. This should come from a call such as <a class="el" href="namespaceGnome.html#aae4a3a5913202ab92ab80e5161efa0b9">Gnome::UI::module_info_get()</a>. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>argc</em>&nbsp;</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>&nbsp;</td><td>A string array of command line arguments. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>options</em>&nbsp;</td><td>poptOption table with options to parse. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>popt</em>&nbsp;</td><td>flags. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>return_ctx</em>&nbsp;</td><td>The popt context is returned here.</td></tr>
  </table>
  </dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use the constructor that takes a Glib::OptionContext instead. </dd></dl>

</div>
</div>
<a class="anchor" id="a82061403b30fe46572e058fe659061a8"></a><!-- doxytag: member="Gnome::Main::Main" ref="a82061403b30fe46572e058fe659061a8" args="(const Glib::ustring &amp;app_id, const Glib::ustring &amp;app_version, const ModuleInfo &amp;module_info, int argc, char **argv, Glib::OptionContext &amp;options)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gnome::Main::Main </td>
          <td>(</td>
          <td class="paramtype">const Glib::ustring &amp;&nbsp;</td>
          <td class="paramname"> <em>app_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Glib::ustring &amp;&nbsp;</td>
          <td class="paramname"> <em>app_version</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classGnome_1_1ModuleInfo.html">ModuleInfo</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>module_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&nbsp;</td>
          <td class="paramname"> <em>argv</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Glib::OptionContext &amp;&nbsp;</td>
          <td class="paramname"> <em>options</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialises the current GNOME libraries for use by the application, and takes an OptionContext for command line arguments. </p>
<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><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>&nbsp;</td><td>Application ID string. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>app_version</em>&nbsp;</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>&nbsp;</td><td>module to init with this program. This should come from a call such as <a class="el" href="namespaceGnome.html#aae4a3a5913202ab92ab80e5161efa0b9">Gnome::UI::module_info_get()</a>. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>argc</em>&nbsp;</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>&nbsp;</td><td>A string array of command line arguments. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>options</em>&nbsp;</td><td>Context with options to parse. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a3a8d0b53a9988651cb22e22618da90d8"></a><!-- doxytag: member="Gnome::Main::~Main" ref="a3a8d0b53a9988651cb22e22618da90d8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gnome::Main::~Main </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a676da7cd431912fa68e4f9d1f43a2589"></a><!-- doxytag: member="Gnome::Main::Main" ref="a676da7cd431912fa68e4f9d1f43a2589" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Gnome::Main::Main </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ade54889b940457c646d46e37b57a13cf"></a><!-- doxytag: member="Gnome::Main::set_ids" ref="ade54889b940457c646d46e37b57a13cf" args="(const Glib::ustring &amp;app_id, const Glib::ustring &amp;app_version)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Gnome::Main::set_ids </td>
          <td>(</td>
          <td class="paramtype">const Glib::ustring &amp;&nbsp;</td>
          <td class="paramname"> <em>app_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Glib::ustring &amp;&nbsp;</td>
          <td class="paramname"> <em>app_version</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a597f262c3022c40446a02acb75dbc7f7"></a><!-- doxytag: member="Gnome::Main::app_id_" ref="a597f262c3022c40446a02acb75dbc7f7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="classGnome_1_1Main.html#a597f262c3022c40446a02acb75dbc7f7">Gnome::Main::app_id_</a><code> [static, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a269b840cb081f67230508c601300e5cc"></a><!-- doxytag: member="Gnome::Main::app_version_" ref="a269b840cb081f67230508c601300e5cc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="classGnome_1_1Main.html#a269b840cb081f67230508c601300e5cc">Gnome::Main::app_version_</a><code> [static, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="aa1390fe7570067b88c887f8f2c40b0d4"></a><!-- doxytag: member="Gnome::Main::m_refProgram" ref="aa1390fe7570067b88c887f8f2c40b0d4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Glib::RefPtr&lt;<a class="el" href="classGnome_1_1Program.html">Program</a>&gt; <a class="el" href="classGnome_1_1Main.html#aa1390fe7570067b88c887f8f2c40b0d4">Gnome::Main::m_refProgram</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<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></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 13:16:46 2009 for libgnomemm by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>