~inkscape.dev/inkscape-devlibs/devlibs-gtk3

« back to all changes in this revision

Viewing changes to share/doc/gtkmm-2.4/reference/html/classGtk_1_1FileFilter.html

  • Committer: JazzyNico
  • Date: 2013-01-21 10:11:05 UTC
  • Revision ID: nicoduf@yahoo.fr-20130121101105-i8d8slkq9ng4olx8
Adding gtk2 libraries.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>gtkmm: Gtk::FileFilter Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.3 -->
 
11
<div id="top">
 
12
<div id="titlearea">
 
13
<table cellspacing="0" cellpadding="0">
 
14
 <tbody>
 
15
 <tr style="height: 56px;">
 
16
  <td style="padding-left: 0.5em;">
 
17
   <div id="projectname">gtkmm&#160;<span id="projectnumber">2.24.2</span></div>
 
18
  </td>
 
19
 </tr>
 
20
 </tbody>
 
21
</table>
 
22
</div>
 
23
  <div id="navrow1" class="tabs">
 
24
    <ul class="tablist">
 
25
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
26
      <li><a href="pages.html"><span>Related&#160;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>
 
30
    </ul>
 
31
  </div>
 
32
  <div id="navrow2" class="tabs2">
 
33
    <ul class="tablist">
 
34
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
35
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
36
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
 
37
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
38
    </ul>
 
39
  </div>
 
40
  <div id="nav-path" class="navpath">
 
41
    <ul>
 
42
      <li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
 
43
      <li class="navelem"><a class="el" href="classGtk_1_1FileFilter.html">FileFilter</a> </li>
 
44
    </ul>
 
45
  </div>
 
46
</div>
 
47
<div class="header">
 
48
  <div class="summary">
 
49
<a href="#nested-classes">Classes</a> &#124;
 
50
<a href="#pub-types">Public Types</a> &#124;
 
51
<a href="#pub-methods">Public Member Functions</a> &#124;
 
52
<a href="#related">Related Functions</a> </div>
 
53
  <div class="headertitle">
 
54
<h1>Gtk::FileFilter Class Reference</h1> </div>
 
55
</div>
 
56
<div class="contents">
 
57
<!-- doxytag: class="Gtk::FileFilter" --><!-- doxytag: inherits="Gtk::Object" -->
 
58
<p>A filter for selecting a file subset. <a href="#_details">More...</a></p>
 
59
<div class="dynheader">
 
60
Inheritance diagram for Gtk::FileFilter:</div>
 
61
<div class="dyncontent">
 
62
<div class="center"><img src="classGtk_1_1FileFilter__inherit__graph.png" border="0" usemap="#Gtk_1_1FileFilter_inherit__map" alt="Inheritance graph"/></div>
 
63
<map name="Gtk_1_1FileFilter_inherit__map" id="Gtk_1_1FileFilter_inherit__map">
 
64
<area shape="rect" id="node2" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non&#45;widget objects such as Gtk::Adjustme..." alt="" coords="21,246,109,277"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node6" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node8" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map>
 
65
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
66
<div class="dynheader">
 
67
Collaboration diagram for Gtk::FileFilter:</div>
 
68
<div class="dyncontent">
 
69
<div class="center"><img src="classGtk_1_1FileFilter__coll__graph.png" border="0" usemap="#Gtk_1_1FileFilter_coll__map" alt="Collaboration graph"/></div>
 
70
<map name="Gtk_1_1FileFilter_coll__map" id="Gtk_1_1FileFilter_coll__map">
 
71
<area shape="rect" id="node2" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non&#45;widget objects such as Gtk::Adjustme..." alt="" coords="21,246,109,277"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,166,111,197"/><area shape="rect" id="node6" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,86,125,117"/><area shape="rect" id="node8" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,6,119,37"/></map>
 
72
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
73
 
 
74
<p><a href="classGtk_1_1FileFilter-members.html">List of all members.</a></p>
 
75
<table class="memberdecls">
 
76
<tr><td colspan="2"><h2><a name="nested-classes"></a>
 
77
Classes</h2></td></tr>
 
78
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter_1_1Info.html">Info</a></td></tr>
 
79
<tr><td colspan="2"><h2><a name="pub-types"></a>
 
80
Public Types</h2></td></tr>
 
81
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">sigc::slot</a>&lt; bool, <br class="typebreak"/>
 
82
const <a class="el" href="classGtk_1_1FileFilter_1_1Info.html">Info</a>&amp; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a4c3cb21b5cbdb93d6f9415bd59173436">SlotCustom</a></td></tr>
 
83
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">For instance, bool on_custom(const Gtk::FileFilter::Info&amp; filter_info);. <a href="#a4c3cb21b5cbdb93d6f9415bd59173436"></a><br/></td></tr>
 
84
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
85
Public Member Functions</h2></td></tr>
 
86
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a50eee8641cdbe65c4350d4ba4849743e">~FileFilter</a> ()</td></tr>
 
87
<tr><td class="memItemLeft" align="right" valign="top">GtkFileFilter*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a66e9c0496e9160dac00dc4084b7546bc">gobj</a> ()</td></tr>
 
88
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a66e9c0496e9160dac00dc4084b7546bc"></a><br/></td></tr>
 
89
<tr><td class="memItemLeft" align="right" valign="top">const GtkFileFilter*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a7d46093351ec372a672a3be88646005a">gobj</a> () const </td></tr>
 
90
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a7d46093351ec372a672a3be88646005a"></a><br/></td></tr>
 
91
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a542b0bc5fd456766db2b91c502a05603">FileFilter</a> ()</td></tr>
 
92
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#ac192ae4b6a0d24ab00c2d2d434550813">set_name</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&amp; name)</td></tr>
 
93
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the human-readable name of the filter; this is the string that will be displayed in the file selector user interface if there is a selectable list of filters. <a href="#ac192ae4b6a0d24ab00c2d2d434550813"></a><br/></td></tr>
 
94
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#af2f9f2895ad22fe94a878f26c594658c">get_name</a> () const </td></tr>
 
95
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the human-readable name for the filter. <a href="#af2f9f2895ad22fe94a878f26c594658c"></a><br/></td></tr>
 
96
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#af0a289b2b4576672f4ce46de1a84f0be">add_mime_type</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&amp; mime_type)</td></tr>
 
97
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a rule allowing a given mime type to <em>filter</em>. <a href="#af0a289b2b4576672f4ce46de1a84f0be"></a><br/></td></tr>
 
98
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a9b49e4a03afffc2806d17abf33b26cad">add_pattern</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&amp; pattern)</td></tr>
 
99
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a rule allowing a shell style glob to a filter. <a href="#a9b49e4a03afffc2806d17abf33b26cad"></a><br/></td></tr>
 
100
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a7ed1bdf8a077b87b66efbc9fd308a367">add_pixbuf_formats</a> ()</td></tr>
 
101
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a rule allowing image files in the formats supported by GdkPixbuf. <a href="#a7ed1bdf8a077b87b66efbc9fd308a367"></a><br/></td></tr>
 
102
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#ae42878237330a437191f61df28094208">add_custom</a> (<a class="el" href="group__gtkmmEnums.html#gaf8205a61123bc5013c12d13335623959">FileFilterFlags</a> needed, const <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">SlotCustom</a>&amp; slot)</td></tr>
 
103
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gtkmmEnums.html#gaf8205a61123bc5013c12d13335623959">FileFilterFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a82c0d157fded98f2d5a40a637227d120">get_needed</a> () const </td></tr>
 
104
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the fields that need to be filled in for the structure passed to filter() <a href="#a82c0d157fded98f2d5a40a637227d120"></a><br/></td></tr>
 
105
<tr><td colspan="2"><h2><a name="related"></a>
 
106
Related Functions</h2></td></tr>
 
107
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
 
108
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1FileFilter.html">Gtk::FileFilter</a>*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1FileFilter.html#a1d316df58a9cd0b8b872bb159caa81ce">wrap</a> (GtkFileFilter* object, bool take_copy=false)</td></tr>
 
109
<tr><td class="mdescLeft">&#160;</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="#a1d316df58a9cd0b8b872bb159caa81ce"></a><br/></td></tr>
 
110
</table>
 
111
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
112
<div class="textblock"><p>A filter for selecting a file subset. </p>
 
113
<p>A <a class="el" href="classGtk_1_1FileFilter.html" title="A filter for selecting a file subset.">Gtk::FileFilter</a> can be used to restrict the files being shown in a <a class="el" href="classGtk_1_1FileChooser.html" title="Gtk::FileChooser is an interface that can be implemented by file selection widgets.">Gtk::FileChooser</a>. Files can be filtered based on their name (with <a class="el" href="classGtk_1_1FileFilter.html#a9b49e4a03afffc2806d17abf33b26cad" title="Adds a rule allowing a shell style glob to a filter.">add_pattern()</a>), on their mime type (with <a class="el" href="classGtk_1_1FileFilter.html#af0a289b2b4576672f4ce46de1a84f0be" title="Adds a rule allowing a given mime type to filter.">add_mime_type()</a>), or by a custom filter function (with <a class="el" href="classGtk_1_1FileFilter.html#ae42878237330a437191f61df28094208">add_custom()</a>).</p>
 
114
<p>Filtering by mime types handles aliasing and subclassing of mime types; e.g. a filter for text/plain also matches a file with mime type application/rtf, since application/rtf is a subclass of text/plain. Note that <a class="el" href="classGtk_1_1FileFilter.html" title="A filter for selecting a file subset.">Gtk::FileFilter</a> allows wildcards for the subtype of a mime type, so you can e.g. filter for image/*.</p>
 
115
<p>Normally, filters are used by adding them to a <a class="el" href="classGtk_1_1FileChooser.html" title="Gtk::FileChooser is an interface that can be implemented by file selection widgets.">Gtk::FileChooser</a>. See <a class="el" href="classGtk_1_1FileChooser.html#af02ec2b5004b16fc0e65c96603087597" title="Adds filter to the list of filters that the user can select between.">Gtk::FileChooser::add_filter()</a>. But it is also possible to manually use a filter on a file with filter(). </p>
 
116
</div><hr/><h2>Member Typedef Documentation</h2>
 
117
<a class="anchor" id="a4c3cb21b5cbdb93d6f9415bd59173436"></a><!-- doxytag: member="Gtk::FileFilter::SlotCustom" ref="a4c3cb21b5cbdb93d6f9415bd59173436" args="" -->
 
118
<div class="memitem">
 
119
<div class="memproto">
 
120
      <table class="memname">
 
121
        <tr>
 
122
          <td class="memname">typedef <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">sigc::slot</a>&lt;bool, const <a class="el" href="classGtk_1_1FileFilter_1_1Info.html">Info</a>&amp;&gt; <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">Gtk::FileFilter::SlotCustom</a></td>
 
123
        </tr>
 
124
      </table>
 
125
</div>
 
126
<div class="memdoc">
 
127
 
 
128
<p>For instance, bool on_custom(const Gtk::FileFilter::Info&amp; filter_info);. </p>
 
129
 
 
130
</div>
 
131
</div>
 
132
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
133
<a class="anchor" id="a50eee8641cdbe65c4350d4ba4849743e"></a><!-- doxytag: member="Gtk::FileFilter::~FileFilter" ref="a50eee8641cdbe65c4350d4ba4849743e" args="()" -->
 
134
<div class="memitem">
 
135
<div class="memproto">
 
136
      <table class="memname">
 
137
        <tr>
 
138
          <td class="memname">virtual Gtk::FileFilter::~FileFilter </td>
 
139
          <td>(</td>
 
140
          <td class="paramname"></td><td>)</td>
 
141
          <td><code> [virtual]</code></td>
 
142
        </tr>
 
143
      </table>
 
144
</div>
 
145
<div class="memdoc">
 
146
 
 
147
</div>
 
148
</div>
 
149
<a class="anchor" id="a542b0bc5fd456766db2b91c502a05603"></a><!-- doxytag: member="Gtk::FileFilter::FileFilter" ref="a542b0bc5fd456766db2b91c502a05603" args="()" -->
 
150
<div class="memitem">
 
151
<div class="memproto">
 
152
      <table class="memname">
 
153
        <tr>
 
154
          <td class="memname">Gtk::FileFilter::FileFilter </td>
 
155
          <td>(</td>
 
156
          <td class="paramname"></td><td>)</td>
 
157
          <td></td>
 
158
        </tr>
 
159
      </table>
 
160
</div>
 
161
<div class="memdoc">
 
162
 
 
163
</div>
 
164
</div>
 
165
<hr/><h2>Member Function Documentation</h2>
 
166
<a class="anchor" id="ae42878237330a437191f61df28094208"></a><!-- doxytag: member="Gtk::FileFilter::add_custom" ref="ae42878237330a437191f61df28094208" args="(FileFilterFlags needed, const SlotCustom &amp;slot)" -->
 
167
<div class="memitem">
 
168
<div class="memproto">
 
169
      <table class="memname">
 
170
        <tr>
 
171
          <td class="memname">void Gtk::FileFilter::add_custom </td>
 
172
          <td>(</td>
 
173
          <td class="paramtype"><a class="el" href="group__gtkmmEnums.html#gaf8205a61123bc5013c12d13335623959">FileFilterFlags</a>&#160;</td>
 
174
          <td class="paramname"><em>needed</em>, </td>
 
175
        </tr>
 
176
        <tr>
 
177
          <td class="paramkey"></td>
 
178
          <td></td>
 
179
          <td class="paramtype">const <a class="elRef" href="../../../libsigc++-2.0/reference/html/classsigc_1_1slot.html">SlotCustom</a> &amp;&#160;</td>
 
180
          <td class="paramname"><em>slot</em>&#160;</td>
 
181
        </tr>
 
182
        <tr>
 
183
          <td></td>
 
184
          <td>)</td>
 
185
          <td></td><td></td>
 
186
        </tr>
 
187
      </table>
 
188
</div>
 
189
<div class="memdoc">
 
190
 
 
191
</div>
 
192
</div>
 
193
<a class="anchor" id="af0a289b2b4576672f4ce46de1a84f0be"></a><!-- doxytag: member="Gtk::FileFilter::add_mime_type" ref="af0a289b2b4576672f4ce46de1a84f0be" args="(const Glib::ustring &amp;mime_type)" -->
 
194
<div class="memitem">
 
195
<div class="memproto">
 
196
      <table class="memname">
 
197
        <tr>
 
198
          <td class="memname">void Gtk::FileFilter::add_mime_type </td>
 
199
          <td>(</td>
 
200
          <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&#160;</td>
 
201
          <td class="paramname"><em>mime_type</em></td><td>)</td>
 
202
          <td></td>
 
203
        </tr>
 
204
      </table>
 
205
</div>
 
206
<div class="memdoc">
 
207
 
 
208
<p>Adds a rule allowing a given mime type to <em>filter</em>. </p>
 
209
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000173">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
210
<dl><dt><b>Parameters:</b></dt><dd>
 
211
  <table class="params">
 
212
    <tr><td class="paramname">mime_type</td><td>Name of a MIME type. </td></tr>
 
213
  </table>
 
214
  </dd>
 
215
</dl>
 
216
 
 
217
</div>
 
218
</div>
 
219
<a class="anchor" id="a9b49e4a03afffc2806d17abf33b26cad"></a><!-- doxytag: member="Gtk::FileFilter::add_pattern" ref="a9b49e4a03afffc2806d17abf33b26cad" args="(const Glib::ustring &amp;pattern)" -->
 
220
<div class="memitem">
 
221
<div class="memproto">
 
222
      <table class="memname">
 
223
        <tr>
 
224
          <td class="memname">void Gtk::FileFilter::add_pattern </td>
 
225
          <td>(</td>
 
226
          <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&#160;</td>
 
227
          <td class="paramname"><em>pattern</em></td><td>)</td>
 
228
          <td></td>
 
229
        </tr>
 
230
      </table>
 
231
</div>
 
232
<div class="memdoc">
 
233
 
 
234
<p>Adds a rule allowing a shell style glob to a filter. </p>
 
235
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000174">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
236
<dl><dt><b>Parameters:</b></dt><dd>
 
237
  <table class="params">
 
238
    <tr><td class="paramname">pattern</td><td>A shell style glob. </td></tr>
 
239
  </table>
 
240
  </dd>
 
241
</dl>
 
242
 
 
243
</div>
 
244
</div>
 
245
<a class="anchor" id="a7ed1bdf8a077b87b66efbc9fd308a367"></a><!-- doxytag: member="Gtk::FileFilter::add_pixbuf_formats" ref="a7ed1bdf8a077b87b66efbc9fd308a367" args="()" -->
 
246
<div class="memitem">
 
247
<div class="memproto">
 
248
      <table class="memname">
 
249
        <tr>
 
250
          <td class="memname">void Gtk::FileFilter::add_pixbuf_formats </td>
 
251
          <td>(</td>
 
252
          <td class="paramname"></td><td>)</td>
 
253
          <td></td>
 
254
        </tr>
 
255
      </table>
 
256
</div>
 
257
<div class="memdoc">
 
258
 
 
259
<p>Adds a rule allowing image files in the formats supported by GdkPixbuf. </p>
 
260
<dl class="since_2_6"><dt><b><a class="el" href="since_2_6.html#_since_2_6000081">Since gtkmm 2.6:</a></b></dt><dd></dd></dl>
 
261
 
 
262
</div>
 
263
</div>
 
264
<a class="anchor" id="af2f9f2895ad22fe94a878f26c594658c"></a><!-- doxytag: member="Gtk::FileFilter::get_name" ref="af2f9f2895ad22fe94a878f26c594658c" args="() const " -->
 
265
<div class="memitem">
 
266
<div class="memproto">
 
267
      <table class="memname">
 
268
        <tr>
 
269
          <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gtk::FileFilter::get_name </td>
 
270
          <td>(</td>
 
271
          <td class="paramname"></td><td>)</td>
 
272
          <td> const</td>
 
273
        </tr>
 
274
      </table>
 
275
</div>
 
276
<div class="memdoc">
 
277
 
 
278
<p>Gets the human-readable name for the filter. </p>
 
279
<p>See <a class="el" href="classGtk_1_1FileFilter.html#ac192ae4b6a0d24ab00c2d2d434550813" title="Sets the human-readable name of the filter; this is the string that will be displayed in the file sel...">set_name()</a>.</p>
 
280
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000172">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
281
<dl class="return"><dt><b>Returns:</b></dt><dd>The human-readable name of the filter, or <code>0</code>. This value is owned by GTK+ and must not be modified or freed. </dd></dl>
 
282
 
 
283
</div>
 
284
</div>
 
285
<a class="anchor" id="a82c0d157fded98f2d5a40a637227d120"></a><!-- doxytag: member="Gtk::FileFilter::get_needed" ref="a82c0d157fded98f2d5a40a637227d120" args="() const " -->
 
286
<div class="memitem">
 
287
<div class="memproto">
 
288
      <table class="memname">
 
289
        <tr>
 
290
          <td class="memname"><a class="el" href="group__gtkmmEnums.html#gaf8205a61123bc5013c12d13335623959">FileFilterFlags</a> Gtk::FileFilter::get_needed </td>
 
291
          <td>(</td>
 
292
          <td class="paramname"></td><td>)</td>
 
293
          <td> const</td>
 
294
        </tr>
 
295
      </table>
 
296
</div>
 
297
<div class="memdoc">
 
298
 
 
299
<p>Gets the fields that need to be filled in for the structure passed to filter() </p>
 
300
<p>This function will not typically be used by applications; it is intended principally for use in the implementation of <a class="el" href="classGtk_1_1FileChooser.html" title="Gtk::FileChooser is an interface that can be implemented by file selection widgets.">Gtk::FileChooser</a>.</p>
 
301
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000175">Since gtkmm 2.4:</a></b></dt><dd></dd></dl>
 
302
<dl class="return"><dt><b>Returns:</b></dt><dd>Bitfield of flags indicating needed fields when calling filter(). </dd></dl>
 
303
 
 
304
</div>
 
305
</div>
 
306
<a class="anchor" id="a66e9c0496e9160dac00dc4084b7546bc"></a><!-- doxytag: member="Gtk::FileFilter::gobj" ref="a66e9c0496e9160dac00dc4084b7546bc" args="()" -->
 
307
<div class="memitem">
 
308
<div class="memproto">
 
309
      <table class="memname">
 
310
        <tr>
 
311
          <td class="memname">GtkFileFilter* Gtk::FileFilter::gobj </td>
 
312
          <td>(</td>
 
313
          <td class="paramname"></td><td>)</td>
 
314
          <td><code> [inline]</code></td>
 
315
        </tr>
 
316
      </table>
 
317
</div>
 
318
<div class="memdoc">
 
319
 
 
320
<p>Provides access to the underlying C GtkObject. </p>
 
321
 
 
322
<p>Reimplemented from <a class="el" href="classGtk_1_1Object.html#ae3541ec02d1b7cd56cfabe7295f8948f">Gtk::Object</a>.</p>
 
323
 
 
324
</div>
 
325
</div>
 
326
<a class="anchor" id="a7d46093351ec372a672a3be88646005a"></a><!-- doxytag: member="Gtk::FileFilter::gobj" ref="a7d46093351ec372a672a3be88646005a" args="() const " -->
 
327
<div class="memitem">
 
328
<div class="memproto">
 
329
      <table class="memname">
 
330
        <tr>
 
331
          <td class="memname">const GtkFileFilter* Gtk::FileFilter::gobj </td>
 
332
          <td>(</td>
 
333
          <td class="paramname"></td><td>)</td>
 
334
          <td> const<code> [inline]</code></td>
 
335
        </tr>
 
336
      </table>
 
337
</div>
 
338
<div class="memdoc">
 
339
 
 
340
<p>Provides access to the underlying C GtkObject. </p>
 
341
 
 
342
<p>Reimplemented from <a class="el" href="classGtk_1_1Object.html#a5a0e5941619df9ec0cc52feccad99005">Gtk::Object</a>.</p>
 
343
 
 
344
</div>
 
345
</div>
 
346
<a class="anchor" id="ac192ae4b6a0d24ab00c2d2d434550813"></a><!-- doxytag: member="Gtk::FileFilter::set_name" ref="ac192ae4b6a0d24ab00c2d2d434550813" args="(const Glib::ustring &amp;name)" -->
 
347
<div class="memitem">
 
348
<div class="memproto">
 
349
      <table class="memname">
 
350
        <tr>
 
351
          <td class="memname">void Gtk::FileFilter::set_name </td>
 
352
          <td>(</td>
 
353
          <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&#160;</td>
 
354
          <td class="paramname"><em>name</em></td><td>)</td>
 
355
          <td></td>
 
356
        </tr>
 
357
      </table>
 
358
</div>
 
359
<div class="memdoc">
 
360
 
 
361
<p>Sets the human-readable name of the filter; this is the string that will be displayed in the file selector user interface if there is a selectable list of filters. </p>
 
362
<dl class="since_2_4"><dt><b><a class="el" href="since_2_4.html#_since_2_4000171">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">name</td><td>The human-readable-name for the filter, or <code>0</code> to remove any existing name. </td></tr>
 
366
  </table>
 
367
  </dd>
 
368
</dl>
 
369
 
 
370
</div>
 
371
</div>
 
372
<hr/><h2>Friends And Related Function Documentation</h2>
 
373
<a class="anchor" id="a1d316df58a9cd0b8b872bb159caa81ce"></a><!-- doxytag: member="Gtk::FileFilter::wrap" ref="a1d316df58a9cd0b8b872bb159caa81ce" args="(GtkFileFilter *object, bool take_copy=false)" -->
 
374
<div class="memitem">
 
375
<div class="memproto">
 
376
      <table class="memname">
 
377
        <tr>
 
378
          <td class="memname"><a class="el" href="classGtk_1_1FileFilter.html">Gtk::FileFilter</a>* wrap </td>
 
379
          <td>(</td>
 
380
          <td class="paramtype">GtkFileFilter *&#160;</td>
 
381
          <td class="paramname"><em>object</em>, </td>
 
382
        </tr>
 
383
        <tr>
 
384
          <td class="paramkey"></td>
 
385
          <td></td>
 
386
          <td class="paramtype">bool&#160;</td>
 
387
          <td class="paramname"><em>take_copy</em> = <code>false</code>&#160;</td>
 
388
        </tr>
 
389
        <tr>
 
390
          <td></td>
 
391
          <td>)</td>
 
392
          <td></td><td><code> [related]</code></td>
 
393
        </tr>
 
394
      </table>
 
395
</div>
 
396
<div class="memdoc">
 
397
 
 
398
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
 
399
<dl><dt><b>Parameters:</b></dt><dd>
 
400
  <table class="params">
 
401
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
 
402
    <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>
 
403
  </table>
 
404
  </dd>
 
405
</dl>
 
406
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
407
 
 
408
</div>
 
409
</div>
 
410
<hr/>The documentation for this class was generated from the following file:<ul>
 
411
<li>gtkmm/filefilter.h</li>
 
412
</ul>
 
413
</div>
 
414
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:45 for gtkmm by&#160;
 
415
<a href="http://www.doxygen.org/index.html">
 
416
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
 
417
</body>
 
418
</html>