<!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::Program 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 Page</span></a></li> <li><a href="pages.html"><span>Related 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 List</span></a></li> <li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceGnome.html">Gnome</a>::<a class="el" href="classGnome_1_1Program.html">Program</a> </div> </div> <div class="contents"> <h1>Gnome::Program Class Reference</h1><!-- doxytag: class="Gnome::Program" --><!-- doxytag: inherits="Glib::Object" --> <p>Initialize and retrieve information about a GNOME application. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="program_8h_source.html">program.h</a>></code></p> <div class="dynheader"> Inheritance diagram for Gnome::Program:</div> <div class="dynsection"> <div class="center"><img src="classGnome_1_1Program__inherit__graph.png" border="0" usemap="#Gnome_1_1Program_inherit__map" alt="Inheritance graph"/></div> <map name="Gnome_1_1Program_inherit__map" id="Gnome_1_1Program_inherit__map"> <area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,5,111,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGnome_1_1Program-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#ab6cf7e2555fb90a6dd0406730537638e">~Program</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">GnomeProgram * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#ac06431ade3671cb771809775feba7c77">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ac06431ade3671cb771809775feba7c77"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const GnomeProgram * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#ac082f2f617aae3856ddb95489402bc05">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ac082f2f617aae3856ddb95489402bc05"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">GnomeProgram * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#a82debd24d6a853af1ce8410378193121">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="#a82debd24d6a853af1ce8410378193121"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#ab6c07b7914dba2a5e7ca695e00566313">get_human_readable_name</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#aa19f83ca0f19639e9e457360f7e128f2">get_app_id</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#a9012d31bf114c584cc004aa681a919b5">get_app_version</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">Glib::ustring </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#a03d4c42c93faf182995cf7d1b15c069d">locate_file</a> (<a class="el" href="group__libgnomemmEnums.html#gae2c63af809e2668ed98afb62576af8ad">FileDomain</a> domain, const Glib::ustring &file_name, bool only_if_exists=true)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">Glib::SListHandle< Glib::ustring > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Program.html#a7baca240878733d2fe83ee060537da00">locate_file_multiple</a> (<a class="el" href="group__libgnomemmEnums.html#gae2c63af809e2668ed98afb62576af8ad">FileDomain</a> domain, const Glib::ustring &file_name, bool only_if_exists=true)</td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" 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#a1605200a229ca3ec7a3e39dbb17fdc91">get</a> ()</td></tr> <tr><td colspan="2"><h2>Related Functions</h2></td></tr> <tr><td colspan="2"><p>(Note that these are not member functions.) </p> <br/><br/></td></tr> <tr><td class="memItemLeft" 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#a770c827e04a460f4c97039d3f82c449c">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="#a770c827e04a460f4c97039d3f82c449c"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Initialize and retrieve information about a GNOME application. </p> <p>This is a singleton - Use <a class="el" href="classGnome_1_1Program.html#a1605200a229ca3ec7a3e39dbb17fdc91">Program::get()</a> to retrieve an instance on which to call the other methods. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ab6cf7e2555fb90a6dd0406730537638e"></a><!-- doxytag: member="Gnome::Program::~Program" ref="ab6cf7e2555fb90a6dd0406730537638e" 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><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a1605200a229ca3ec7a3e39dbb17fdc91"></a><!-- doxytag: member="Gnome::Program::get" ref="a1605200a229ca3ec7a3e39dbb17fdc91" 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><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="aa19f83ca0f19639e9e457360f7e128f2"></a><!-- doxytag: member="Gnome::Program::get_app_id" ref="aa19f83ca0f19639e9e457360f7e128f2" 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> const</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a9012d31bf114c584cc004aa681a919b5"></a><!-- doxytag: member="Gnome::Program::get_app_version" ref="a9012d31bf114c584cc004aa681a919b5" 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> const</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ab6c07b7914dba2a5e7ca695e00566313"></a><!-- doxytag: member="Gnome::Program::get_human_readable_name" ref="ab6c07b7914dba2a5e7ca695e00566313" 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> const</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ac082f2f617aae3856ddb95489402bc05"></a><!-- doxytag: member="Gnome::Program::gobj" ref="ac082f2f617aae3856ddb95489402bc05" 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> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> </div> </div> <a class="anchor" id="ac06431ade3671cb771809775feba7c77"></a><!-- doxytag: member="Gnome::Program::gobj" ref="ac06431ade3671cb771809775feba7c77" 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><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> </div> </div> <a class="anchor" id="a82debd24d6a853af1ce8410378193121"></a><!-- doxytag: member="Gnome::Program::gobj_copy" ref="a82debd24d6a853af1ce8410378193121" 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></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> <a class="anchor" id="a03d4c42c93faf182995cf7d1b15c069d"></a><!-- doxytag: member="Gnome::Program::locate_file" ref="a03d4c42c93faf182995cf7d1b15c069d" 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#gae2c63af809e2668ed98afb62576af8ad">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></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a7baca240878733d2fe83ee060537da00"></a><!-- doxytag: member="Gnome::Program::locate_file_multiple" ref="a7baca240878733d2fe83ee060537da00" 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#gae2c63af809e2668ed98afb62576af8ad">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></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a770c827e04a460f4c97039d3f82c449c"></a><!-- doxytag: member="Gnome::Program::wrap" ref="a770c827e04a460f4c97039d3f82c449c" 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><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A Glib::wrap() method for this object. </p> <dl><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> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> <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></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 13:16:46 2009 for libgnomemm by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>