1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gtk::IconTheme Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1IconTheme.html">IconTheme</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#pub-static-methods">Static Public Member Functions</a> |
51
<a href="#pro-methods">Protected Member Functions</a> |
52
<a href="#related">Related Functions</a> </div>
53
<div class="headertitle">
54
<h1>Gtk::IconTheme Class Reference</h1> </div>
56
<div class="contents">
57
<!-- doxytag: class="Gtk::IconTheme" --><!-- doxytag: inherits="Glib::Object" --><div class="dynheader">
58
Inheritance diagram for Gtk::IconTheme:</div>
59
<div class="dyncontent">
60
<div class="center"><img src="classGtk_1_1IconTheme__inherit__graph.png" border="0" usemap="#Gtk_1_1IconTheme_inherit__map" alt="Inheritance graph"/></div>
61
<map name="Gtk_1_1IconTheme_inherit__map" id="Gtk_1_1IconTheme_inherit__map">
62
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map>
63
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
64
<div class="dynheader">
65
Collaboration diagram for Gtk::IconTheme:</div>
66
<div class="dyncontent">
67
<div class="center"><img src="classGtk_1_1IconTheme__coll__graph.png" border="0" usemap="#Gtk_1_1IconTheme_coll__map" alt="Collaboration graph"/></div>
68
<map name="Gtk_1_1IconTheme_coll__map" id="Gtk_1_1IconTheme_coll__map">
69
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map>
70
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
72
<p><a href="classGtk_1_1IconTheme-members.html">List of all members.</a></p>
73
<table class="memberdecls">
74
<tr><td colspan="2"><h2><a name="pub-methods"></a>
75
Public Member Functions</h2></td></tr>
76
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a4db5d65d22433f58898baa6eef9947b9">~IconTheme</a> ()</td></tr>
77
<tr><td class="memItemLeft" align="right" valign="top">GtkIconTheme* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a9f62bce0b8426d984104ca65493ad65b">gobj</a> ()</td></tr>
78
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a9f62bce0b8426d984104ca65493ad65b"></a><br/></td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top">const GtkIconTheme* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#ab47f6ad780df65ae900862c469c1f45c">gobj</a> () const </td></tr>
80
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ab47f6ad780df65ae900862c469c1f45c"></a><br/></td></tr>
81
<tr><td class="memItemLeft" align="right" valign="top">GtkIconTheme* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a47f5d7d4be820bdec8e3ed111e04a174">gobj_copy</a> ()</td></tr>
82
<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="#a47f5d7d4be820bdec8e3ed111e04a174"></a><br/></td></tr>
83
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a101e27ca111105f250a7dccaa0407b52">set_screen</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Screen.html">Gdk::Screen</a> >& screen)</td></tr>
84
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the screen for an icon theme; the screen is used to track the user's currently configured icon theme, which might be different for different screens. <a href="#a101e27ca111105f250a7dccaa0407b52"></a><br/></td></tr>
85
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a59c3d4cee5fb4da8d00f885985a4db77">set_search_path</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> >& path)</td></tr>
86
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <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_1IconTheme.html#ac71e33fed05ddc2ea77be83358738019">get_search_path</a> () const </td></tr>
87
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a6d3cb198791d11293b53a6d72e86dd71">append_search_path</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& path)</td></tr>
88
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a directory to the search path. <a href="#a6d3cb198791d11293b53a6d72e86dd71"></a><br/></td></tr>
89
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a3a7691445c999cf3f49fff52e6ef62b1">prepend_search_path</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& path)</td></tr>
90
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prepends a directory to the search path. <a href="#a3a7691445c999cf3f49fff52e6ef62b1"></a><br/></td></tr>
91
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#acddc42b5b8c9731c3647953c5ab5196b">set_custom_theme</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& theme_name)</td></tr>
92
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the name of the icon theme that the <a class="el" href="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> object uses overriding system configuration. <a href="#acddc42b5b8c9731c3647953c5ab5196b"></a><br/></td></tr>
93
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#ac39844b977b82e670b88a693d619c624">has_icon</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& icon_name) const </td></tr>
94
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether an icon theme includes an icon for a particular name. <a href="#ac39844b977b82e670b88a693d619c624"></a><br/></td></tr>
95
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#ad22427840443ee29e1a8624b7d5467cd">get_icon_sizes</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& icon_name) const </td></tr>
96
<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_1IconTheme.html#add25d62c56474a4c0d3530240061c82f">lookup_icon</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& icon_name, int <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#ga445a43f417432dd1b9aed90ef239c700">size</a>, <a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a> flags) const </td></tr>
97
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up a named icon and returns a structure containing information such as the filename of the icon. <a href="#add25d62c56474a4c0d3530240061c82f"></a><br/></td></tr>
98
<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_1IconTheme.html#ab600162e67612d6c2e70fecda7217b1a">lookup_icon</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGio_1_1Icon.html">Gio::Icon</a> >& icon, int <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#ga445a43f417432dd1b9aed90ef239c700">size</a>, <a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a> flags) const </td></tr>
99
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up an icon and returns a structure containing information such as the filename of the icon. <a href="#ab600162e67612d6c2e70fecda7217b1a"></a><br/></td></tr>
100
<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_1IconTheme.html#a3f6475c7b851eff6fcf4392ac7defa50">choose_icon</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::StringArrayHandle</a>& icon_names, int <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#ga445a43f417432dd1b9aed90ef239c700">size</a>, <a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a> flags)</td></tr>
101
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up a named icon and returns a structure containing information such as the filename of the icon. <a href="#a3f6475c7b851eff6fcf4392ac7defa50"></a><br/></td></tr>
102
<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_1IconTheme.html#a9e9307cefa458eea1e8946d9def2e527">load_icon</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& icon_name, int <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#ga445a43f417432dd1b9aed90ef239c700">size</a>, <a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a> flags=(<a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a>) 0) const </td></tr>
103
<tr><td class="mdescLeft"> </td><td class="mdescRight">Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. <a href="#a9e9307cefa458eea1e8946d9def2e527"></a><br/></td></tr>
104
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a>< <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_1IconTheme.html#adc468224087b238d568dd2b47301341d">list_icons</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& context) const </td></tr>
105
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lists a subset of icons in the current icon theme, by providing a context string. <a href="#adc468224087b238d568dd2b47301341d"></a><br/></td></tr>
106
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a>< <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_1IconTheme.html#a6b0dabdc8269c78c81e6da20658f6b30">list_icons</a> () const </td></tr>
107
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lists the icons in the current icon theme. <a href="#a6b0dabdc8269c78c81e6da20658f6b30"></a><br/></td></tr>
108
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a>< <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_1IconTheme.html#ab1dfc7291396a5c48a24611f5072ba09">list_contexts</a> () const </td></tr>
109
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the list of contexts available within the current hierarchy of icon themes. <a href="#ab1dfc7291396a5c48a24611f5072ba09"></a><br/></td></tr>
110
<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_1IconTheme.html#aa2a1cca16c9b048e5b023d2212579d1a">get_example_icon_name</a> () const </td></tr>
111
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.) <a href="#aa2a1cca16c9b048e5b023d2212579d1a"></a><br/></td></tr>
112
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a5cb5c0e2c62d565995a4142ca93b65ed">rescan_if_needed</a> ()</td></tr>
113
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time <em>icon_theme</em> is accessed. <a href="#a5cb5c0e2c62d565995a4142ca93b65ed"></a><br/></td></tr>
114
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#ab50617ee892526a732de2659ecb7b79c">signal_changed</a> ()</td></tr>
115
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
116
Static Public Member Functions</h2></td></tr>
117
<tr><td class="memItemLeft" align="right" valign="top">static <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="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#ab5e19724cb84f116235ca256194d49df">create</a> ()</td></tr>
118
<tr><td class="memItemLeft" align="right" valign="top">static <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="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a3afdba1b52bd99e26cffae6bdc7746f2">get_default</a> ()</td></tr>
119
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the icon theme for the default screen. <a href="#a3afdba1b52bd99e26cffae6bdc7746f2"></a><br/></td></tr>
120
<tr><td class="memItemLeft" align="right" valign="top">static <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="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#ae345ef63d7ae954bfc290fb9ed708bbd">get_for_screen</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Screen.html">Gdk::Screen</a> >& screen)</td></tr>
121
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the icon theme object associated with <em>screen</em>; if this function has not previously been called for the given screen, a new icon theme object will be created and associated with the screen. <a href="#ae345ef63d7ae954bfc290fb9ed708bbd"></a><br/></td></tr>
122
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#aec6f8962cf59343dbc30e1ba40bc5e72">add_builtin_icon</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& icon_name, int <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01568.html#ga445a43f417432dd1b9aed90ef239c700">size</a>, 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>
123
<tr><td class="mdescLeft"> </td><td class="mdescRight">Registers a built-in icon for icon theme lookups. <a href="#aec6f8962cf59343dbc30e1ba40bc5e72"></a><br/></td></tr>
124
<tr><td colspan="2"><h2><a name="pro-methods"></a>
125
Protected Member Functions</h2></td></tr>
126
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a657508c71596013f27b6a7e71225d153">IconTheme</a> ()</td></tr>
127
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#ae19dff5d94f1e1f05c005c254a547e38">on_changed</a> ()</td></tr>
128
<tr><td colspan="2"><h2><a name="related"></a>
129
Related Functions</h2></td></tr>
130
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
131
<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="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1IconTheme.html#a54a6116e8b997b4e1f7489f6dd72dc29">wrap</a> (GtkIconTheme* object, bool take_copy=false)</td></tr>
132
<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="#a54a6116e8b997b4e1f7489f6dd72dc29"></a><br/></td></tr>
134
<hr/><h2>Constructor & Destructor Documentation</h2>
135
<a class="anchor" id="a4db5d65d22433f58898baa6eef9947b9"></a><!-- doxytag: member="Gtk::IconTheme::~IconTheme" ref="a4db5d65d22433f58898baa6eef9947b9" args="()" -->
136
<div class="memitem">
137
<div class="memproto">
138
<table class="memname">
140
<td class="memname">virtual Gtk::IconTheme::~IconTheme </td>
142
<td class="paramname"></td><td>)</td>
143
<td><code> [virtual]</code></td>
151
<a class="anchor" id="a657508c71596013f27b6a7e71225d153"></a><!-- doxytag: member="Gtk::IconTheme::IconTheme" ref="a657508c71596013f27b6a7e71225d153" args="()" -->
152
<div class="memitem">
153
<div class="memproto">
154
<table class="memname">
156
<td class="memname">Gtk::IconTheme::IconTheme </td>
158
<td class="paramname"></td><td>)</td>
159
<td><code> [protected]</code></td>
167
<hr/><h2>Member Function Documentation</h2>
168
<a class="anchor" id="aec6f8962cf59343dbc30e1ba40bc5e72"></a><!-- doxytag: member="Gtk::IconTheme::add_builtin_icon" ref="aec6f8962cf59343dbc30e1ba40bc5e72" args="(const Glib::ustring &icon_name, int size, const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)" -->
169
<div class="memitem">
170
<div class="memproto">
171
<table class="memname">
173
<td class="memname">static void Gtk::IconTheme::add_builtin_icon </td>
175
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
176
<td class="paramname"><em>icon_name</em>, </td>
179
<td class="paramkey"></td>
181
<td class="paramtype">int </td>
182
<td class="paramname"><em>size</em>, </td>
185
<td class="paramkey"></td>
187
<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>
188
<td class="paramname"><em>pixbuf</em> </td>
193
<td></td><td><code> [static]</code></td>
199
<p>Registers a built-in icon for icon theme lookups. </p>
200
<p>The idea of built-in icons is to allow an application or library that uses themed icons to function requiring files to be present in the file system. For instance, the default images for all of GTK+'s stock icons are registered as built-icons.</p>
201
<p>In general, if you use <a class="el" href="classGtk_1_1IconTheme.html#aec6f8962cf59343dbc30e1ba40bc5e72" title="Registers a built-in icon for icon theme lookups.">add_builtin_icon()</a> you should also install the icon in the icon theme, so that the icon is generally available.</p>
202
<p>This function will generally be used with pixbufs loaded via gdk_pixbuf_new_from_inline().</p>
203
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000208">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
204
<dl><dt><b>Parameters:</b></dt><dd>
205
<table class="params">
206
<tr><td class="paramname">icon_name</td><td>The name of the icon to register. </td></tr>
207
<tr><td class="paramname">size</td><td>The size at which to register the icon (different images can be registered for the same icon name at different sizes.). </td></tr>
208
<tr><td class="paramname">pixbuf</td><td><a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> that contains the image to use for <em>icon_name</em>. </td></tr>
215
<a class="anchor" id="a6d3cb198791d11293b53a6d72e86dd71"></a><!-- doxytag: member="Gtk::IconTheme::append_search_path" ref="a6d3cb198791d11293b53a6d72e86dd71" args="(const Glib::ustring &path)" -->
216
<div class="memitem">
217
<div class="memproto">
218
<table class="memname">
220
<td class="memname">void Gtk::IconTheme::append_search_path </td>
222
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
223
<td class="paramname"><em>path</em></td><td>)</td>
230
<p>Appends a directory to the search path. </p>
231
<p>See <a class="el" href="classGtk_1_1IconTheme.html#a59c3d4cee5fb4da8d00f885985a4db77">set_search_path()</a>.</p>
232
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000199">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
233
<dl><dt><b>Parameters:</b></dt><dd>
234
<table class="params">
235
<tr><td class="paramname">path</td><td>Directory name to append to the icon path. </td></tr>
242
<a class="anchor" id="a3f6475c7b851eff6fcf4392ac7defa50"></a><!-- doxytag: member="Gtk::IconTheme::choose_icon" ref="a3f6475c7b851eff6fcf4392ac7defa50" args="(const Glib::StringArrayHandle &icon_names, int size, IconLookupFlags flags)" -->
243
<div class="memitem">
244
<div class="memproto">
245
<table class="memname">
247
<td class="memname"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> Gtk::IconTheme::choose_icon </td>
249
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::StringArrayHandle</a> & </td>
250
<td class="paramname"><em>icon_names</em>, </td>
253
<td class="paramkey"></td>
255
<td class="paramtype">int </td>
256
<td class="paramname"><em>size</em>, </td>
259
<td class="paramkey"></td>
261
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a> </td>
262
<td class="paramname"><em>flags</em> </td>
273
<p>Looks up a named icon and returns a structure containing information such as the filename of the icon. </p>
274
<p>The icon can then be rendered into a pixbuf using <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...">Gtk::IconInfo::load_icon()</a>. (<a class="el" href="classGtk_1_1IconTheme.html#a9e9307cefa458eea1e8946d9def2e527" title="Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf...">load_icon()</a> combines these two steps if all you need is the pixbuf.)</p>
275
<p>If <em>icon_names</em> contains more than one name, this function tries them all in the given order before falling back to inherited icon themes. </p>
276
<dl><dt><b>Parameters:</b></dt><dd>
277
<table class="params">
278
<tr><td class="paramname">icon_names</td><td>Array of icon names to lookup. </td></tr>
279
<tr><td class="paramname">size</td><td>Desired icon size. </td></tr>
280
<tr><td class="paramname">flags</td><td>Flags modifying the behavior of the icon lookup. </td></tr>
284
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGtk_1_1IconInfo.html">Gtk::IconInfo</a> structure containing information about the icon. <a class="el" href="classGtk_1_1IconInfo.html#a4e0ff5422c708a3a5e451786190a6f07">IconInfo::operator bool()</a> will be false if the icon wasn't found - for instance, if (icon_info) { ... }.</dd></dl>
285
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000038">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
289
<a class="anchor" id="ab5e19724cb84f116235ca256194d49df"></a><!-- doxytag: member="Gtk::IconTheme::create" ref="ab5e19724cb84f116235ca256194d49df" args="()" -->
290
<div class="memitem">
291
<div class="memproto">
292
<table class="memname">
294
<td class="memname">static <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>> Gtk::IconTheme::create </td>
296
<td class="paramname"></td><td>)</td>
297
<td><code> [static]</code></td>
305
<a class="anchor" id="a3afdba1b52bd99e26cffae6bdc7746f2"></a><!-- doxytag: member="Gtk::IconTheme::get_default" ref="a3afdba1b52bd99e26cffae6bdc7746f2" args="()" -->
306
<div class="memitem">
307
<div class="memproto">
308
<table class="memname">
310
<td class="memname">static <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>> Gtk::IconTheme::get_default </td>
312
<td class="paramname"></td><td>)</td>
313
<td><code> [static]</code></td>
319
<p>Gets the icon theme for the default screen. </p>
320
<p>See <a class="el" href="classGtk_1_1IconTheme.html#ae345ef63d7ae954bfc290fb9ed708bbd" title="Gets the icon theme object associated with screen; if this function has not previously been called fo...">get_for_screen()</a>.</p>
321
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000196">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
322
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique <a class="el" href="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> associated with the default screen. This icon theme is associated with the screen and can be used as long as the screen is open. Do not ref or unref it. </dd></dl>
326
<a class="anchor" id="aa2a1cca16c9b048e5b023d2212579d1a"></a><!-- doxytag: member="Gtk::IconTheme::get_example_icon_name" ref="aa2a1cca16c9b048e5b023d2212579d1a" args="() const " -->
327
<div class="memitem">
328
<div class="memproto">
329
<table class="memname">
331
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::IconTheme::get_example_icon_name </td>
333
<td class="paramname"></td><td>)</td>
340
<p>Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.) </p>
341
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000206">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
345
<a class="anchor" id="ae345ef63d7ae954bfc290fb9ed708bbd"></a><!-- doxytag: member="Gtk::IconTheme::get_for_screen" ref="ae345ef63d7ae954bfc290fb9ed708bbd" args="(const Glib::RefPtr< Gdk::Screen > &screen)" -->
346
<div class="memitem">
347
<div class="memproto">
348
<table class="memname">
350
<td class="memname">static <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>> Gtk::IconTheme::get_for_screen </td>
352
<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_1Screen.html">Gdk::Screen</a> >& </td>
353
<td class="paramname"><em>screen</em></td><td>)</td>
354
<td><code> [static]</code></td>
360
<p>Gets the icon theme object associated with <em>screen</em>; if this function has not previously been called for the given screen, a new icon theme object will be created and associated with the screen. </p>
361
<p>Icon theme objects are fairly expensive to create, so using this function is usually a better choice than calling than new() and setting the screen yourself; by using this function a single icon theme object will be shared between users.</p>
362
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000197">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
363
<dl><dt><b>Parameters:</b></dt><dd>
364
<table class="params">
365
<tr><td class="paramname">screen</td><td>A <a class="el" href="classGdk_1_1Screen.html" title="Object representing a physical screen Gdk::Screen objects are the GDK representation of a physical sc...">Gdk::Screen</a>. </td></tr>
369
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique <a class="el" href="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> associated with the given screen. This icon theme is associated with the screen and can be used as long as the screen is open. Do not ref or unref it. </dd></dl>
373
<a class="anchor" id="ad22427840443ee29e1a8624b7d5467cd"></a><!-- doxytag: member="Gtk::IconTheme::get_icon_sizes" ref="ad22427840443ee29e1a8624b7d5467cd" args="(const Glib::ustring &icon_name) const " -->
374
<div class="memitem">
375
<div class="memproto">
376
<table class="memname">
378
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><int> Gtk::IconTheme::get_icon_sizes </td>
380
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
381
<td class="paramname"><em>icon_name</em></td><td>)</td>
390
<a class="anchor" id="ac71e33fed05ddc2ea77be83358738019"></a><!-- doxytag: member="Gtk::IconTheme::get_search_path" ref="ac71e33fed05ddc2ea77be83358738019" args="() const " -->
391
<div class="memitem">
392
<div class="memproto">
393
<table class="memname">
395
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gtk::IconTheme::get_search_path </td>
397
<td class="paramname"></td><td>)</td>
406
<a class="anchor" id="ab47f6ad780df65ae900862c469c1f45c"></a><!-- doxytag: member="Gtk::IconTheme::gobj" ref="ab47f6ad780df65ae900862c469c1f45c" args="() const " -->
407
<div class="memitem">
408
<div class="memproto">
409
<table class="memname">
411
<td class="memname">const GtkIconTheme* Gtk::IconTheme::gobj </td>
413
<td class="paramname"></td><td>)</td>
414
<td> const<code> [inline]</code></td>
420
<p>Provides access to the underlying C GObject. </p>
422
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
426
<a class="anchor" id="a9f62bce0b8426d984104ca65493ad65b"></a><!-- doxytag: member="Gtk::IconTheme::gobj" ref="a9f62bce0b8426d984104ca65493ad65b" args="()" -->
427
<div class="memitem">
428
<div class="memproto">
429
<table class="memname">
431
<td class="memname">GtkIconTheme* Gtk::IconTheme::gobj </td>
433
<td class="paramname"></td><td>)</td>
434
<td><code> [inline]</code></td>
440
<p>Provides access to the underlying C GObject. </p>
442
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
446
<a class="anchor" id="a47f5d7d4be820bdec8e3ed111e04a174"></a><!-- doxytag: member="Gtk::IconTheme::gobj_copy" ref="a47f5d7d4be820bdec8e3ed111e04a174" args="()" -->
447
<div class="memitem">
448
<div class="memproto">
449
<table class="memname">
451
<td class="memname">GtkIconTheme* Gtk::IconTheme::gobj_copy </td>
453
<td class="paramname"></td><td>)</td>
460
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
464
<a class="anchor" id="ac39844b977b82e670b88a693d619c624"></a><!-- doxytag: member="Gtk::IconTheme::has_icon" ref="ac39844b977b82e670b88a693d619c624" args="(const Glib::ustring &icon_name) const " -->
465
<div class="memitem">
466
<div class="memproto">
467
<table class="memname">
469
<td class="memname">bool Gtk::IconTheme::has_icon </td>
471
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
472
<td class="paramname"><em>icon_name</em></td><td>)</td>
479
<p>Checks whether an icon theme includes an icon for a particular name. </p>
480
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000202">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
481
<dl><dt><b>Parameters:</b></dt><dd>
482
<table class="params">
483
<tr><td class="paramname">icon_name</td><td>The name of an icon. </td></tr>
487
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>icon_theme</em> includes an icon for <em>icon_name</em>. </dd></dl>
491
<a class="anchor" id="ab1dfc7291396a5c48a24611f5072ba09"></a><!-- doxytag: member="Gtk::IconTheme::list_contexts" ref="ab1dfc7291396a5c48a24611f5072ba09" args="() const " -->
492
<div class="memitem">
493
<div class="memproto">
494
<table class="memname">
496
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gtk::IconTheme::list_contexts </td>
498
<td class="paramname"></td><td>)</td>
505
<p>Gets the list of contexts available within the current hierarchy of icon themes. </p>
506
<dl class="return"><dt><b>Returns:</b></dt><dd>A list holding the names of all the contexts in the theme.</dd></dl>
507
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000039">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
511
<a class="anchor" id="adc468224087b238d568dd2b47301341d"></a><!-- doxytag: member="Gtk::IconTheme::list_icons" ref="adc468224087b238d568dd2b47301341d" args="(const Glib::ustring &context) const " -->
512
<div class="memitem">
513
<div class="memproto">
514
<table class="memname">
516
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gtk::IconTheme::list_icons </td>
518
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
519
<td class="paramname"><em>context</em></td><td>)</td>
526
<p>Lists a subset of icons in the current icon theme, by providing a context string. </p>
527
<p>The set of values for the context string is system dependent, but will typically include such values as 'Applications' and 'MimeTypes'. </p>
528
<dl><dt><b>Parameters:</b></dt><dd>
529
<table class="params">
530
<tr><td class="paramname">context</td><td>A string identifying a particular type of icon. </td></tr>
534
<dl class="return"><dt><b>Returns:</b></dt><dd>The names of all the icons in the theme.</dd></dl>
535
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000205">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
539
<a class="anchor" id="a6b0dabdc8269c78c81e6da20658f6b30"></a><!-- doxytag: member="Gtk::IconTheme::list_icons" ref="a6b0dabdc8269c78c81e6da20658f6b30" args="() const " -->
540
<div class="memitem">
541
<div class="memproto">
542
<table class="memname">
544
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ListHandle.html">Glib::ListHandle</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gtk::IconTheme::list_icons </td>
546
<td class="paramname"></td><td>)</td>
553
<p>Lists the icons in the current icon theme. </p>
554
<dl class="return"><dt><b>Returns:</b></dt><dd>A list holding the names of all the icons in the theme.</dd></dl>
555
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000056">Since gtkmm 2.10:</a></b></dt><dd></dd></dl>
559
<a class="anchor" id="a9e9307cefa458eea1e8946d9def2e527"></a><!-- doxytag: member="Gtk::IconTheme::load_icon" ref="a9e9307cefa458eea1e8946d9def2e527" args="(const Glib::ustring &icon_name, int size, IconLookupFlags flags=(IconLookupFlags) 0) const " -->
560
<div class="memitem">
561
<div class="memproto">
562
<table class="memname">
564
<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::IconTheme::load_icon </td>
566
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
567
<td class="paramname"><em>icon_name</em>, </td>
570
<td class="paramkey"></td>
572
<td class="paramtype">int </td>
573
<td class="paramname"><em>size</em>, </td>
576
<td class="paramkey"></td>
578
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a> </td>
579
<td class="paramname"><em>flags</em> = <code>(<a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a>) 0</code> </td>
584
<td></td><td> const</td>
590
<p>Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. </p>
591
<p>This is a convenience function; if more details about the icon are needed, use <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...">lookup_icon()</a> followed 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...">Gtk::IconInfo::load_icon()</a>.</p>
592
<p>Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the GtkWidget::style-set signal. If for some reason you do not want to update the icon when the icon theme changes, you should consider using gdk_pixbuf_copy() to make a private copy of the pixbuf returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory.</p>
593
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000204">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
594
<dl><dt><b>Parameters:</b></dt><dd>
595
<table class="params">
596
<tr><td class="paramname">icon_name</td><td>The name of the icon to lookup. </td></tr>
597
<tr><td class="paramname">size</td><td>The desired icon size. The resulting icon may not be exactly this size; see <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...">Gtk::IconInfo::load_icon()</a>. </td></tr>
598
<tr><td class="paramname">flags</td><td>Flags modifying the behavior of the icon lookup. </td></tr>
602
<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. <code>0</code> if the icon isn't found. </dd></dl>
606
<a class="anchor" id="ab600162e67612d6c2e70fecda7217b1a"></a><!-- doxytag: member="Gtk::IconTheme::lookup_icon" ref="ab600162e67612d6c2e70fecda7217b1a" args="(const Glib::RefPtr< const Gio::Icon > &icon, int size, IconLookupFlags flags) const " -->
607
<div class="memitem">
608
<div class="memproto">
609
<table class="memname">
611
<td class="memname"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> Gtk::IconTheme::lookup_icon </td>
613
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGio_1_1Icon.html">Gio::Icon</a> > & </td>
614
<td class="paramname"><em>icon</em>, </td>
617
<td class="paramkey"></td>
619
<td class="paramtype">int </td>
620
<td class="paramname"><em>size</em>, </td>
623
<td class="paramkey"></td>
625
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a> </td>
626
<td class="paramname"><em>flags</em> </td>
631
<td></td><td> const</td>
637
<p>Looks up an icon and returns a structure containing information such as the filename of the icon. </p>
638
<p>The icon can then be rendered into a pixbuf using <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...">Gtk::IconInfo::load_icon()</a>.</p>
639
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000090">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
640
<dl><dt><b>Parameters:</b></dt><dd>
641
<table class="params">
642
<tr><td class="paramname">icon</td><td>The Icon to look up. </td></tr>
643
<tr><td class="paramname">size</td><td>Desired icon size. </td></tr>
644
<tr><td class="paramname">flags</td><td>Flags modifying the behavior of the icon lookup. </td></tr>
648
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGtk_1_1IconInfo.html">Gtk::IconInfo</a> structure containing information about the icon, or <code>0</code> if the icon wasn't found. Free with Gtk::IconInfo::free(). </dd></dl>
652
<a class="anchor" id="add25d62c56474a4c0d3530240061c82f"></a><!-- doxytag: member="Gtk::IconTheme::lookup_icon" ref="add25d62c56474a4c0d3530240061c82f" args="(const Glib::ustring &icon_name, int size, IconLookupFlags flags) const " -->
653
<div class="memitem">
654
<div class="memproto">
655
<table class="memname">
657
<td class="memname"><a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> Gtk::IconTheme::lookup_icon </td>
659
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
660
<td class="paramname"><em>icon_name</em>, </td>
663
<td class="paramkey"></td>
665
<td class="paramtype">int </td>
666
<td class="paramname"><em>size</em>, </td>
669
<td class="paramkey"></td>
671
<td class="paramtype"><a class="el" href="group__gtkmmEnums.html#ga6d0c2193613cfb97ab313746a5bacaa2">IconLookupFlags</a> </td>
672
<td class="paramname"><em>flags</em> </td>
677
<td></td><td> const</td>
683
<p>Looks up a named icon and returns a structure containing information such as the filename of the icon. </p>
684
<p>The icon can then be rendered into a pixbuf using <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...">Gtk::IconInfo::load_icon()</a>. (<a class="el" href="classGtk_1_1IconTheme.html#a9e9307cefa458eea1e8946d9def2e527" title="Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf...">load_icon()</a> combines these two steps if all you need is the pixbuf.) </p>
685
<dl><dt><b>Parameters:</b></dt><dd>
686
<table class="params">
687
<tr><td class="paramname">icon_name</td><td>The name of the icon to lookup. </td></tr>
688
<tr><td class="paramname">size</td><td>Desired icon size. </td></tr>
689
<tr><td class="paramname">flags</td><td>Flags modifying the behavior of the icon lookup. </td></tr>
693
<dl class="return"><dt><b>Returns:</b></dt><dd>An <a class="el" href="classGtk_1_1IconInfo.html">IconInfo</a> structure containing information about the icon. <a class="el" href="classGtk_1_1IconInfo.html#a4e0ff5422c708a3a5e451786190a6f07">IconInfo::operator bool()</a> will return false if the icon wasn't found. For instance, if (icon_info) { ... }.</dd></dl>
694
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000203">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
698
<a class="anchor" id="ae19dff5d94f1e1f05c005c254a547e38"></a><!-- doxytag: member="Gtk::IconTheme::on_changed" ref="ae19dff5d94f1e1f05c005c254a547e38" args="()" -->
699
<div class="memitem">
700
<div class="memproto">
701
<table class="memname">
703
<td class="memname">virtual void Gtk::IconTheme::on_changed </td>
705
<td class="paramname"></td><td>)</td>
706
<td><code> [protected, virtual]</code></td>
714
<a class="anchor" id="a3a7691445c999cf3f49fff52e6ef62b1"></a><!-- doxytag: member="Gtk::IconTheme::prepend_search_path" ref="a3a7691445c999cf3f49fff52e6ef62b1" args="(const Glib::ustring &path)" -->
715
<div class="memitem">
716
<div class="memproto">
717
<table class="memname">
719
<td class="memname">void Gtk::IconTheme::prepend_search_path </td>
721
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
722
<td class="paramname"><em>path</em></td><td>)</td>
729
<p>Prepends a directory to the search path. </p>
730
<p>See <a class="el" href="classGtk_1_1IconTheme.html#a59c3d4cee5fb4da8d00f885985a4db77">set_search_path()</a>.</p>
731
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000200">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
732
<dl><dt><b>Parameters:</b></dt><dd>
733
<table class="params">
734
<tr><td class="paramname">path</td><td>Directory name to prepend to the icon path. </td></tr>
741
<a class="anchor" id="a5cb5c0e2c62d565995a4142ca93b65ed"></a><!-- doxytag: member="Gtk::IconTheme::rescan_if_needed" ref="a5cb5c0e2c62d565995a4142ca93b65ed" args="()" -->
742
<div class="memitem">
743
<div class="memproto">
744
<table class="memname">
746
<td class="memname">bool Gtk::IconTheme::rescan_if_needed </td>
748
<td class="paramname"></td><td>)</td>
755
<p>Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time <em>icon_theme</em> is accessed. </p>
756
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000207">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
757
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the icon theme has changed and needed to be reloaded. </dd></dl>
761
<a class="anchor" id="acddc42b5b8c9731c3647953c5ab5196b"></a><!-- doxytag: member="Gtk::IconTheme::set_custom_theme" ref="acddc42b5b8c9731c3647953c5ab5196b" args="(const Glib::ustring &theme_name)" -->
762
<div class="memitem">
763
<div class="memproto">
764
<table class="memname">
766
<td class="memname">void Gtk::IconTheme::set_custom_theme </td>
768
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
769
<td class="paramname"><em>theme_name</em></td><td>)</td>
776
<p>Sets the name of the icon theme that the <a class="el" href="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> object uses overriding system configuration. </p>
777
<p>This function cannot be called on the icon theme objects returned from <a class="el" href="classGtk_1_1IconTheme.html#a3afdba1b52bd99e26cffae6bdc7746f2" title="Gets the icon theme for the default screen.">get_default()</a> and <a class="el" href="classGtk_1_1IconTheme.html#ae345ef63d7ae954bfc290fb9ed708bbd" title="Gets the icon theme object associated with screen; if this function has not previously been called fo...">get_for_screen()</a>.</p>
778
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000201">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
779
<dl><dt><b>Parameters:</b></dt><dd>
780
<table class="params">
781
<tr><td class="paramname">theme_name</td><td>Name of icon theme to use instead of configured theme, or <code>0</code> to unset a previously set custom theme. </td></tr>
788
<a class="anchor" id="a101e27ca111105f250a7dccaa0407b52"></a><!-- doxytag: member="Gtk::IconTheme::set_screen" ref="a101e27ca111105f250a7dccaa0407b52" args="(const Glib::RefPtr< Gdk::Screen > &screen)" -->
789
<div class="memitem">
790
<div class="memproto">
791
<table class="memname">
793
<td class="memname">void Gtk::IconTheme::set_screen </td>
795
<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_1Screen.html">Gdk::Screen</a> >& </td>
796
<td class="paramname"><em>screen</em></td><td>)</td>
803
<p>Sets the screen for an icon theme; the screen is used to track the user's currently configured icon theme, which might be different for different screens. </p>
804
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000198">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
805
<dl><dt><b>Parameters:</b></dt><dd>
806
<table class="params">
807
<tr><td class="paramname">screen</td><td>A <a class="el" href="classGdk_1_1Screen.html" title="Object representing a physical screen Gdk::Screen objects are the GDK representation of a physical sc...">Gdk::Screen</a>. </td></tr>
814
<a class="anchor" id="a59c3d4cee5fb4da8d00f885985a4db77"></a><!-- doxytag: member="Gtk::IconTheme::set_search_path" ref="a59c3d4cee5fb4da8d00f885985a4db77" args="(const Glib::ArrayHandle< Glib::ustring > &path)" -->
815
<div class="memitem">
816
<div class="memproto">
817
<table class="memname">
819
<td class="memname">void Gtk::IconTheme::set_search_path </td>
821
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> > & </td>
822
<td class="paramname"><em>path</em></td><td>)</td>
831
<a class="anchor" id="ab50617ee892526a732de2659ecb7b79c"></a><!-- doxytag: member="Gtk::IconTheme::signal_changed" ref="ab50617ee892526a732de2659ecb7b79c" args="()" -->
832
<div class="memitem">
833
<div class="memproto">
834
<table class="memname">
836
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gtk::IconTheme::signal_changed </td>
838
<td class="paramname"></td><td>)</td>
844
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_changed()</code> </dd></dl>
848
<hr/><h2>Friends And Related Function Documentation</h2>
849
<a class="anchor" id="a54a6116e8b997b4e1f7489f6dd72dc29"></a><!-- doxytag: member="Gtk::IconTheme::wrap" ref="a54a6116e8b997b4e1f7489f6dd72dc29" args="(GtkIconTheme *object, bool take_copy=false)" -->
850
<div class="memitem">
851
<div class="memproto">
852
<table class="memname">
854
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1IconTheme.html">Gtk::IconTheme</a> > wrap </td>
856
<td class="paramtype">GtkIconTheme * </td>
857
<td class="paramname"><em>object</em>, </td>
860
<td class="paramkey"></td>
862
<td class="paramtype">bool </td>
863
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
868
<td></td><td><code> [related]</code></td>
874
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
875
<dl><dt><b>Parameters:</b></dt><dd>
876
<table class="params">
877
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
878
<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>
882
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
886
<hr/>The documentation for this class was generated from the following file:<ul>
887
<li>gtkmm/icontheme.h</li>
890
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:45 for gtkmm by 
891
<a href="http://www.doxygen.org/index.html">
892
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGtk_1_1IconTheme.html
