<!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>gtkmm: Gtk::IconInfo 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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gtkmm <span id="projectnumber">2.24.4</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
<li class="navelem"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Gtk::IconInfo Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Gtk::IconInfo" -->
<p><a href="classGtk_1_1IconInfo-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ad000ee1d628f675910d434921a4bb4b4">IconInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ac5df0aa15650ffbbf7bf8560fb13df9c">IconInfo</a> (GtkIconInfo* gobject, bool make_a_copy=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ab9bcacc37486ff2ded56ca4a6a9e2cac">IconInfo</a> (const <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a97b873870f84ffc61d4539aa291be36e">operator=</a> (const <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ad404781178414d4f7ef9422fa04731b3">~IconInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a88aac698e99e70ff2a87632debe26605">swap</a> (<a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkIconInfo* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a1159ab56328b1a410f06d86ef77d4ce1">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a1159ab56328b1a410f06d86ef77d4ce1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkIconInfo* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a3a935a8c376e729490ba66c0631685d8">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a3a935a8c376e729490ba66c0631685d8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkIconInfo* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a0bb1db80eedf7c85bd87a6f41ae59c5c">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="#a0bb1db80eedf7c85bd87a6f41ae59c5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ae0aa7f9a3058745cb147c511c97d9a99">IconInfo</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconTheme.html">IconTheme</a> >& icon_theme, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& pixbuf)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a4e0ff5422c708a3a5e451786190a6f07">operator bool</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#adf705ebac396ef663775182f3f028b97">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tests whether the <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> is valid. <a href="#adf705ebac396ef663775182f3f028b97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a360b401f202d85266d14c357884bc9ca">get_base_size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the base size for the icon. <a href="#a360b401f202d85266d14c357884bc9ca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a991fed1842e82757a693f6a607ce2150">get_filename</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the filename for the icon. <a href="#a991fed1842e82757a693f6a607ce2150"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#acbdf9a42ea5ae1a89bccd83719ecc3ed">get_builtin_pixbuf</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the built-in image for this icon, if any. <a href="#acbdf9a42ea5ae1a89bccd83719ecc3ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a237c51033cff74382f35103b4e6579b8">get_builtin_pixbuf</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the built-in image for this icon, if any. <a href="#a237c51033cff74382f35103b4e6579b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a5eec966046321610dba070b3c8d7e8e6">load_icon</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Renders an icon previously looked up in an icon theme using <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the filename of the icon...">Gtk::IconTheme::lookup_icon()</a>; the size will be based on the size passed to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the filename of the icon...">Gtk::IconTheme::lookup_icon()</a>. <a href="#a5eec966046321610dba070b3c8d7e8e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a529c4c1e8729c18e7c7b43feaaf63d67">set_raw_coordinates</a> (bool raw_coordinates=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the coordinates returned by <a class="el" href="classGtk_1_1IconInfo.html#a6737ad0cb2c087788393c6435570bfff" title="Gets the coordinates of a rectangle within the icon that can be used for display of information such ...">get_embedded_rect()</a> and <a class="el" href="classGtk_1_1IconInfo.html#ae6831618801c6e7771eaffcd6c79c902">get_attach_points()</a> should be returned in their original form as specified in the icon theme, instead of scaled appropriately for the pixbuf returned by <a class="el" href="classGtk_1_1IconInfo.html#a5eec966046321610dba070b3c8d7e8e6" title="Renders an icon previously looked up in an icon theme using Gtk::IconTheme::lookup_icon(); the size w...">load_icon()</a>. <a href="#a529c4c1e8729c18e7c7b43feaaf63d67"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a6737ad0cb2c087788393c6435570bfff">get_embedded_rect</a> (<a class="el" href="classGdk_1_1Rectangle.html">Gdk::Rectangle</a>& rectangle) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the coordinates of a rectangle within the icon that can be used for display of information such as a preview of the contents of a text file. <a href="#a6737ad0cb2c087788393c6435570bfff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#ae6831618801c6e7771eaffcd6c79c902">get_attach_points</a> (<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="el" href="classGdk_1_1Point.html">Gdk::Point</a> >& points) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#af340104bf0354439311f197ce88065c1">get_display_name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the display name for an icon. <a href="#af340104bf0354439311f197ce88065c1"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkIconInfo* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#adb0929f2020199570662394b264e5086">gobject_</a></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#a1aa64bb823bd5d7af212d633b8ffd2a5">swap</a> (<a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& lhs, <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1IconInfo.html">Gtk::IconInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconInfo.html#acdc54b26a982305d52967d4c99c0a0d1">wrap</a> (GtkIconInfo* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#acdc54b26a982305d52967d4c99c0a0d1"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad000ee1d628f675910d434921a4bb4b4"></a><!-- doxytag: member="Gtk::IconInfo::IconInfo" ref="ad000ee1d628f675910d434921a4bb4b4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::IconInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac5df0aa15650ffbbf7bf8560fb13df9c"></a><!-- doxytag: member="Gtk::IconInfo::IconInfo" ref="ac5df0aa15650ffbbf7bf8560fb13df9c" args="(GtkIconInfo *gobject, bool make_a_copy=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::IconInfo </td>
<td>(</td>
<td class="paramtype">GtkIconInfo * </td>
<td class="paramname"><em>gobject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>make_a_copy</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab9bcacc37486ff2ded56ca4a6a9e2cac"></a><!-- doxytag: member="Gtk::IconInfo::IconInfo" ref="ab9bcacc37486ff2ded56ca4a6a9e2cac" args="(const IconInfo &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::IconInfo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad404781178414d4f7ef9422fa04731b3"></a><!-- doxytag: member="Gtk::IconInfo::~IconInfo" ref="ad404781178414d4f7ef9422fa04731b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::~IconInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae0aa7f9a3058745cb147c511c97d9a99"></a><!-- doxytag: member="Gtk::IconInfo::IconInfo" ref="ae0aa7f9a3058745cb147c511c97d9a99" args="(const Glib::RefPtr< IconTheme > &icon_theme, const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::IconInfo </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconTheme.html">IconTheme</a> >& </td>
<td class="paramname"><em>icon_theme</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& </td>
<td class="paramname"><em>pixbuf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae6831618801c6e7771eaffcd6c79c902"></a><!-- doxytag: member="Gtk::IconInfo::get_attach_points" ref="ae6831618801c6e7771eaffcd6c79c902" args="(Glib::ArrayHandle< Gdk::Point > &points) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::IconInfo::get_attach_points </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="el" href="classGdk_1_1Point.html">Gdk::Point</a> >& </td>
<td class="paramname"><em>points</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a360b401f202d85266d14c357884bc9ca"></a><!-- doxytag: member="Gtk::IconInfo::get_base_size" ref="a360b401f202d85266d14c357884bc9ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Gtk::IconInfo::get_base_size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the base size for the icon. </p>
<p>The base size is a size for the icon that was specified by the icon theme creator. This may be different than the actual size of image; an example of this is small emblem icons that can be attached to a larger icon. These icons will be given the same base size as the larger icons to which they are attached.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000188">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The base size, or 0, if no base size is known for the icon. </dd></dl>
</div>
</div>
<a class="anchor" id="acbdf9a42ea5ae1a89bccd83719ecc3ed"></a><!-- doxytag: member="Gtk::IconInfo::get_builtin_pixbuf" ref="acbdf9a42ea5ae1a89bccd83719ecc3ed" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::IconInfo::get_builtin_pixbuf </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the built-in image for this icon, if any. </p>
<p>To allow GTK+ to use built in icon images, you must pass the Gtk::ICON_LOOKUP_USE_BUILTIN to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the filename of the icon...">Gtk::IconTheme::lookup_icon()</a>.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000190">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The built-in image pixbuf, or <code>0</code>. The returned image must not be modified. </dd></dl>
</div>
</div>
<a class="anchor" id="a237c51033cff74382f35103b4e6579b8"></a><!-- doxytag: member="Gtk::IconInfo::get_builtin_pixbuf" ref="a237c51033cff74382f35103b4e6579b8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::IconInfo::get_builtin_pixbuf </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the built-in image for this icon, if any. </p>
<p>To allow GTK+ to use built in icon images, you must pass the Gtk::ICON_LOOKUP_USE_BUILTIN to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the filename of the icon...">Gtk::IconTheme::lookup_icon()</a>.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000191">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The built-in image pixbuf, or <code>0</code>. The returned image must not be modified. </dd></dl>
</div>
</div>
<a class="anchor" id="af340104bf0354439311f197ce88065c1"></a><!-- doxytag: member="Gtk::IconInfo::get_display_name" ref="af340104bf0354439311f197ce88065c1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::IconInfo::get_display_name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the display name for an icon. </p>
<p>A display name is a string to be used in place of the icon name in a user visible context like a list of icons.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000195">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The display name for the icon or <code>0</code>, if the icon doesn't have a specified display name. This value is owned <em>icon_info</em> and must not be modified or free. </dd></dl>
</div>
</div>
<a class="anchor" id="a6737ad0cb2c087788393c6435570bfff"></a><!-- doxytag: member="Gtk::IconInfo::get_embedded_rect" ref="a6737ad0cb2c087788393c6435570bfff" args="(Gdk::Rectangle &rectangle) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gtk::IconInfo::get_embedded_rect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGdk_1_1Rectangle.html">Gdk::Rectangle</a>& </td>
<td class="paramname"><em>rectangle</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the coordinates of a rectangle within the icon that can be used for display of information such as a preview of the contents of a text file. </p>
<p>See <a class="el" href="classGtk_1_1IconInfo.html#a529c4c1e8729c18e7c7b43feaaf63d67" title="Sets whether the coordinates returned by get_embedded_rect() and get_attach_points() should be return...">set_raw_coordinates()</a> for further information about the coordinate system.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000194">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">rectangle</td><td><a class="el" href="classGdk_1_1Rectangle.html" title="Gdk::Rectangle is a structure holding the position and size of a rectangle.">Gdk::Rectangle</a> in which to store embedded rectangle coordinates; coordinates are only stored when this function returns <code>true</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the icon has an embedded rectangle. </dd></dl>
</div>
</div>
<a class="anchor" id="a991fed1842e82757a693f6a607ce2150"></a><!-- doxytag: member="Gtk::IconInfo::get_filename" ref="a991fed1842e82757a693f6a607ce2150" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::IconInfo::get_filename </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the filename for the icon. </p>
<p>If the Gtk::ICON_LOOKUP_USE_BUILTIN flag was passed to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the filename of the icon...">Gtk::IconTheme::lookup_icon()</a>, there may be no filename if a builtin icon is returned; in this case, you should use <a class="el" href="classGtk_1_1IconInfo.html#acbdf9a42ea5ae1a89bccd83719ecc3ed" title="Gets the built-in image for this icon, if any.">get_builtin_pixbuf()</a>.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000189">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The filename for the icon, or <code>0</code> if <a class="el" href="classGtk_1_1IconInfo.html#acbdf9a42ea5ae1a89bccd83719ecc3ed" title="Gets the built-in image for this icon, if any.">get_builtin_pixbuf()</a> should be used instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a1159ab56328b1a410f06d86ef77d4ce1"></a><!-- doxytag: member="Gtk::IconInfo::gobj" ref="a1159ab56328b1a410f06d86ef77d4ce1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkIconInfo* Gtk::IconInfo::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 instance. </p>
</div>
</div>
<a class="anchor" id="a3a935a8c376e729490ba66c0631685d8"></a><!-- doxytag: member="Gtk::IconInfo::gobj" ref="a3a935a8c376e729490ba66c0631685d8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkIconInfo* Gtk::IconInfo::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 instance. </p>
</div>
</div>
<a class="anchor" id="a0bb1db80eedf7c85bd87a6f41ae59c5c"></a><!-- doxytag: member="Gtk::IconInfo::gobj_copy" ref="a0bb1db80eedf7c85bd87a6f41ae59c5c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkIconInfo* Gtk::IconInfo::gobj_copy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. </p>
</div>
</div>
<a class="anchor" id="a5eec966046321610dba070b3c8d7e8e6"></a><!-- doxytag: member="Gtk::IconInfo::load_icon" ref="a5eec966046321610dba070b3c8d7e8e6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> Gtk::IconInfo::load_icon </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Renders an icon previously looked up in an icon theme using <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the filename of the icon...">Gtk::IconTheme::lookup_icon()</a>; the size will be based on the size passed to <a class="el" href="classGtk_1_1IconTheme.html#add25d62c56474a4c0d3530240061c82f" title="Looks up a named icon and returns a structure containing information such as the filename of the icon...">Gtk::IconTheme::lookup_icon()</a>. </p>
<p>Note that the resulting pixbuf may not be exactly this size; an icon theme may have icons that differ slightly from their nominal sizes, and in addition GTK+ will avoid scaling icons that it considers sufficiently close to the requested size or for which the source image would have to be scaled up too far. (This maintains sharpness.). This behaviour can be changed by passing the Gtk::ICON_LOOKUP_FORCE_SIZE flag when obtaining the <a class="el" href="classGtk_1_1IconInfo.html">Gtk::IconInfo</a>. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000192">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use Glib::object_unref() to release your reference to the icon. </dd></dl>
</div>
</div>
<a class="anchor" id="adf705ebac396ef663775182f3f028b97"></a><!-- doxytag: member="Gtk::IconInfo::operator bool" ref="adf705ebac396ef663775182f3f028b97" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tests whether the <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> is valid. </p>
</div>
</div>
<a class="anchor" id="a4e0ff5422c708a3a5e451786190a6f07"></a><!-- doxytag: member="Gtk::IconInfo::operator bool" ref="a4e0ff5422c708a3a5e451786190a6f07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::IconInfo::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000055">Deprecated:</a></b></dt><dd>Use the const version. </dd></dl>
</div>
</div>
<a class="anchor" id="a97b873870f84ffc61d4539aa291be36e"></a><!-- doxytag: member="Gtk::IconInfo::operator=" ref="a97b873870f84ffc61d4539aa291be36e" args="(const IconInfo &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& Gtk::IconInfo::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a529c4c1e8729c18e7c7b43feaaf63d67"></a><!-- doxytag: member="Gtk::IconInfo::set_raw_coordinates" ref="a529c4c1e8729c18e7c7b43feaaf63d67" args="(bool raw_coordinates=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::IconInfo::set_raw_coordinates </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>raw_coordinates</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether the coordinates returned by <a class="el" href="classGtk_1_1IconInfo.html#a6737ad0cb2c087788393c6435570bfff" title="Gets the coordinates of a rectangle within the icon that can be used for display of information such ...">get_embedded_rect()</a> and <a class="el" href="classGtk_1_1IconInfo.html#ae6831618801c6e7771eaffcd6c79c902">get_attach_points()</a> should be returned in their original form as specified in the icon theme, instead of scaled appropriately for the pixbuf returned by <a class="el" href="classGtk_1_1IconInfo.html#a5eec966046321610dba070b3c8d7e8e6" title="Renders an icon previously looked up in an icon theme using Gtk::IconTheme::lookup_icon(); the size w...">load_icon()</a>. </p>
<p>Raw coordinates are somewhat strange; they are specified to be with respect to the unscaled pixmap for PNG and XPM icons, but for SVG icons, they are in a 1000x1000 coordinate space that is scaled to the final size of the icon. You can determine if the icon is an SVG icon by using <a class="el" href="classGtk_1_1IconInfo.html#a991fed1842e82757a693f6a607ce2150" title="Gets the filename for the icon.">get_filename()</a>, and seeing if it is non-<code>0</code> and ends in '.svg'.</p>
<p>This function is provided primarily to allow compatibility wrappers for older API's, and is not expected to be useful for applications.</p>
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000193">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">raw_coordinates</td><td>Whether the coordinates of embedded rectangles and attached points should be returned in their original (unscaled) form. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a88aac698e99e70ff2a87632debe26605"></a><!-- doxytag: member="Gtk::IconInfo::swap" ref="a88aac698e99e70ff2a87632debe26605" args="(IconInfo &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::IconInfo::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td>
<td class="paramname"><em>other</em></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="a1aa64bb823bd5d7af212d633b8ffd2a5"></a><!-- doxytag: member="Gtk::IconInfo::swap" ref="a1aa64bb823bd5d7af212d633b8ffd2a5" args="(IconInfo &lhs, IconInfo &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td>
<td class="paramname"><em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a>& </td>
<td class="paramname"><em>rhs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">lhs</td><td>The left-hand side </td></tr>
<tr><td class="paramname">rhs</td><td>The right-hand side </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acdc54b26a982305d52967d4c99c0a0d1"></a><!-- doxytag: member="Gtk::IconInfo::wrap" ref="acdc54b26a982305d52967d4c99c0a0d1" args="(GtkIconInfo *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1IconInfo.html">Gtk::IconInfo</a> wrap </td>
<td>(</td>
<td class="paramtype">GtkIconInfo * </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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</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/><h2>Member Data Documentation</h2>
<a class="anchor" id="adb0929f2020199570662394b264e5086"></a><!-- doxytag: member="Gtk::IconInfo::gobject_" ref="adb0929f2020199570662394b264e5086" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkIconInfo* <a class="el" href="classGtk_1_1IconInfo.html#adb0929f2020199570662394b264e5086">Gtk::IconInfo::gobject_</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>gtkmm/iconinfo.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Jun 25 2013 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
