<!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::Program 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_1Program.html">Program</a></div>
<h1>Gnome::Program Class Reference</h1><!-- doxytag: class="Gnome::Program" --><!-- doxytag: inherits="Glib::Object" -->Initialize and retrieve information about a GNOME application.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="program_8h-source.html">program.h</a>></code>
<p>
Inheritance diagram for Gnome::Program:<p><center><img src="classGnome_1_1Program__inherit__graph.png" border="0" usemap="#Gnome_1_1Program__inherit__map" alt="Inheritance graph"></center>
<map name="Gnome_1_1Program__inherit__map">
<area href="classGlib_1_1Object.html" shape="rect" coords="25,7,119,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classGnome_1_1Program-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#b6cf7e2555fb90a6dd0406730537638e">~Program</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GnomeProgram * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#c06431ade3671cb771809775feba7c77">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#c06431ade3671cb771809775feba7c77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GnomeProgram * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#64c74d54eca9b959b2d3a76e51b613bf">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#64c74d54eca9b959b2d3a76e51b613bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GnomeProgram * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#82debd24d6a853af1ce8410378193121">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#82debd24d6a853af1ce8410378193121"></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_1Program.html#724a15319bdbbc872ff0205ff550dd77">get_human_readable_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_1Program.html#50fc203737d83e8f98a26282356fb413">get_app_id</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_1Program.html#c0a5bef8f4ca3150dc0023367370a374">get_app_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_1Program.html#03d4c42c93faf182995cf7d1b15c069d">locate_file</a> (<a class="el" href="group__libgnomemmEnums.html#ge2c63af809e2668ed98afb62576af8ad">FileDomain</a> domain, const Glib::ustring &file_name, bool only_if_exists=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Glib::SListHandle< Glib::ustring > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#7baca240878733d2fe83ee060537da00">locate_file_multiple</a> (<a class="el" href="group__libgnomemmEnums.html#ge2c63af809e2668ed98afb62576af8ad">FileDomain</a> domain, const Glib::ustring &file_name, bool only_if_exists=true)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static Glib::RefPtr< <a class="el" href="classGnome_1_1Program.html">Program</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#1605200a229ca3ec7a3e39dbb17fdc91">get</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">Glib::RefPtr< <a class="el" href="classGnome_1_1Program.html">Gnome::Program</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#770c827e04a460f4c97039d3f82c449c">wrap</a> (GnomeProgram *object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A Glib::wrap() method for this object. <a href="#770c827e04a460f4c97039d3f82c449c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Initialize and retrieve information about a GNOME application.
<p>
This is a singleton - Use <a class="el" href="classGnome_1_1Program.html#1605200a229ca3ec7a3e39dbb17fdc91">Program::get()</a> to retrieve an instance on which to call the other methods.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="b6cf7e2555fb90a6dd0406730537638e"></a><!-- doxytag: member="Gnome::Program::~Program" ref="b6cf7e2555fb90a6dd0406730537638e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gnome::Program::~Program </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c06431ade3671cb771809775feba7c77"></a><!-- doxytag: member="Gnome::Program::gobj" ref="c06431ade3671cb771809775feba7c77" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GnomeProgram* Gnome::Program::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 GObject.
<p>
</div>
</div><p>
<a class="anchor" name="64c74d54eca9b959b2d3a76e51b613bf"></a><!-- doxytag: member="Gnome::Program::gobj" ref="64c74d54eca9b959b2d3a76e51b613bf" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GnomeProgram* Gnome::Program::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 GObject.
<p>
</div>
</div><p>
<a class="anchor" name="82debd24d6a853af1ce8410378193121"></a><!-- doxytag: member="Gnome::Program::gobj_copy" ref="82debd24d6a853af1ce8410378193121" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GnomeProgram* Gnome::Program::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
<p>
</div>
</div><p>
<a class="anchor" name="1605200a229ca3ec7a3e39dbb17fdc91"></a><!-- doxytag: member="Gnome::Program::get" ref="1605200a229ca3ec7a3e39dbb17fdc91" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Glib::RefPtr<<a class="el" href="classGnome_1_1Program.html">Program</a>> Gnome::Program::get </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="724a15319bdbbc872ff0205ff550dd77"></a><!-- doxytag: member="Gnome::Program::get_human_readable_name" ref="724a15319bdbbc872ff0205ff550dd77" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::ustring Gnome::Program::get_human_readable_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="50fc203737d83e8f98a26282356fb413"></a><!-- doxytag: member="Gnome::Program::get_app_id" ref="50fc203737d83e8f98a26282356fb413" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::ustring Gnome::Program::get_app_id </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="c0a5bef8f4ca3150dc0023367370a374"></a><!-- doxytag: member="Gnome::Program::get_app_version" ref="c0a5bef8f4ca3150dc0023367370a374" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::ustring Gnome::Program::get_app_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="03d4c42c93faf182995cf7d1b15c069d"></a><!-- doxytag: member="Gnome::Program::locate_file" ref="03d4c42c93faf182995cf7d1b15c069d" args="(FileDomain domain, const Glib::ustring &file_name, bool only_if_exists=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::ustring Gnome::Program::locate_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libgnomemmEnums.html#ge2c63af809e2668ed98afb62576af8ad">FileDomain</a> </td>
<td class="paramname"> <em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>file_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>only_if_exists</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="7baca240878733d2fe83ee060537da00"></a><!-- doxytag: member="Gnome::Program::locate_file_multiple" ref="7baca240878733d2fe83ee060537da00" args="(FileDomain domain, const Glib::ustring &file_name, bool only_if_exists=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::SListHandle<Glib::ustring> Gnome::Program::locate_file_multiple </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libgnomemmEnums.html#ge2c63af809e2668ed98afb62576af8ad">FileDomain</a> </td>
<td class="paramname"> <em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Glib::ustring & </td>
<td class="paramname"> <em>file_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>only_if_exists</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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="770c827e04a460f4c97039d3f82c449c"></a><!-- doxytag: member="Gnome::Program::wrap" ref="770c827e04a460f4c97039d3f82c449c" args="(GnomeProgram *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Glib::RefPtr< <a class="el" href="classGnome_1_1Program.html">Gnome::Program</a> > wrap </td>
<td>(</td>
<td class="paramtype">GnomeProgram * </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>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="program_8h-source.html">program.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>
