1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkFileSelection: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
<link rel="prev" href="GtkCombo.html" title="GtkCombo">
<link rel="next" href="GtkItemFactory.html" title="GtkItemFactory">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkFileSelection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkFileSelection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkFileSelection.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkFileSelection.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkCombo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkItemFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkFileSelection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkFileSelection.top_of_page"></a>GtkFileSelection</span></h2>
<p>GtkFileSelection</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkFileSelection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkFileSelection.html#gtk-file-selection-new" title="gtk_file_selection_new ()">gtk_file_selection_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkFileSelection.html#gtk-file-selection-complete" title="gtk_file_selection_complete ()">gtk_file_selection_complete</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkFileSelection.html#gtk-file-selection-show-fileop-buttons" title="gtk_file_selection_show_fileop_buttons ()">gtk_file_selection_show_fileop_buttons</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkFileSelection.html#gtk-file-selection-hide-fileop-buttons" title="gtk_file_selection_hide_fileop_buttons ()">gtk_file_selection_hide_fileop_buttons</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkFileSelection.html#gtk-file-selection-set-select-multiple" title="gtk_file_selection_set_select_multiple ()">gtk_file_selection_set_select_multiple</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkFileSelection.html#gtk-file-selection-get-select-multiple" title="gtk_file_selection_get_select_multiple ()">gtk_file_selection_get_select_multiple</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkFileSelection.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">char</span> *</td>
<td class="property_name"><a class="link" href="GtkFileSelection.html#GtkFileSelection--filename" title="The “filename” property">filename</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkFileSelection.html#GtkFileSelection--select-multiple" title="The “select-multiple” property">select-multiple</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkFileSelection.html#GtkFileSelection--show-fileops" title="The “show-fileops” property">show-fileops</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkFileSelection.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkFileSelection.html#GtkFileSelection-struct" title="struct GtkFileSelection">GtkFileSelection</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkFileSelection.html#gtk-file-selection-set-filename" title="gtk_file_selection_set_filename">gtk_file_selection_set_filename</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkFileSelection.html#gtk-file-selection-get-filename" title="gtk_file_selection_get_filename">gtk_file_selection_get_filename</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GtkFileSelection.html#gtk-file-selection-get-selections" title="gtk_file_selection_get_selections">gtk_file_selection_get_selections</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkFileSelection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
<span class="lineart">╰──</span> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
<span class="lineart">╰──</span> <a class="link" href="GtkWindow.html" title="GtkWindow">GtkWindow</a>
<span class="lineart">╰──</span> <a class="link" href="GtkDialog.html" title="GtkDialog">GtkDialog</a>
<span class="lineart">╰──</span> GtkFileSelection
</pre>
</div>
<div class="refsect1">
<a name="GtkFileSelection.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkFileSelection implements
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkFileSelection.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkFileSelection.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GtkFileSelection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-file-selection-new"></a><h3>gtk_file_selection_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_file_selection_new (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_new</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-selection-complete"></a><h3>gtk_file_selection_complete ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_selection_complete (<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pattern</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_complete</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-selection-show-fileop-buttons"></a><h3>gtk_file_selection_show_fileop_buttons ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_selection_show_fileop_buttons
(<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_show_fileop_buttons</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-selection-hide-fileop-buttons"></a><h3>gtk_file_selection_hide_fileop_buttons ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_selection_hide_fileop_buttons
(<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_hide_fileop_buttons</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-selection-set-select-multiple"></a><h3>gtk_file_selection_set_select_multiple ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_file_selection_set_select_multiple
(<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> select_multiple</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_set_select_multiple</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Sets whether the user is allowed to select multiple files in the file list.
Use <a class="link" href="GtkFileSelection.html#gtk-file-selection-get-selections" title="gtk_file_selection_get_selections"><code class="function">gtk_file_selection_get_selections()</code></a> to get the list of selected files.</p>
<div class="refsect3">
<a name="gtk-file-selection-set-select-multiple.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filesel</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>select_multiple</p></td>
<td class="parameter_description"><p>whether or not the user is allowed to select multiple
files in the file list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-selection-get-select-multiple"></a><h3>gtk_file_selection_get_select_multiple ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_file_selection_get_select_multiple
(<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_get_select_multiple</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Determines whether or not the user is allowed to select multiple files in
the file list. See <a class="link" href="GtkFileSelection.html#gtk-file-selection-set-select-multiple" title="gtk_file_selection_set_select_multiple ()"><code class="function">gtk_file_selection_set_select_multiple()</code></a>.</p>
<div class="refsect3">
<a name="gtk-file-selection-get-select-multiple.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filesel</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-file-selection-get-select-multiple.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the user is allowed to select multiple files in the
file list</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkFileSelection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkFileSelection-struct"></a><h3>struct GtkFileSelection</h3>
<pre class="programlisting">struct GtkFileSelection {
GtkWidget *dir_list;
GtkWidget *file_list;
GtkWidget *selection_entry;
GtkWidget *selection_text;
GtkWidget *main_vbox;
GtkWidget *ok_button;
GtkWidget *cancel_button;
GtkWidget *help_button;
GtkWidget *history_pulldown;
GtkWidget *history_menu;
GList *history_list;
GtkWidget *fileop_dialog;
GtkWidget *fileop_entry;
gchar *fileop_file;
gpointer cmpl_state;
GtkWidget *fileop_c_dir;
GtkWidget *fileop_del_file;
GtkWidget *fileop_ren_file;
GtkWidget *button_area;
GtkWidget *action_area;
};
</pre>
<div class="warning"><p><code class="literal">GtkFileSelection</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-selection-set-filename"></a><h3>gtk_file_selection_set_filename</h3>
<pre class="programlisting">#define gtk_file_selection_set_filename gtk_file_selection_set_filename_utf8
</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_set_filename</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Sets a default path for the file requestor. If <em class="parameter"><code>filename</code></em>
includes a
directory path, then the requestor will open with that path as its
current working directory.</p>
<p>This has the consequence that in order to open the requestor with a
working directory and an empty filename, <em class="parameter"><code>filename</code></em>
must have a trailing
directory separator.</p>
<p>The encoding of <em class="parameter"><code>filename</code></em>
is preferred GLib file name encoding, which
may not be UTF-8. See <code class="function">g_filename_from_utf8()</code>.</p>
<div class="refsect3">
<a name="gtk-file-selection-set-filename.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filesel</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>a string to set as the default file name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-selection-get-filename"></a><h3>gtk_file_selection_get_filename</h3>
<pre class="programlisting">#define gtk_file_selection_get_filename gtk_file_selection_get_filename_utf8
</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_get_filename</code> is deprecated and should not be used in newly-written code.</p></div>
<p>This function returns the selected filename in the GLib file name
encoding. To convert to UTF-8, call <code class="function">g_filename_to_utf8()</code>. The
returned string points to a statically allocated buffer and should
be copied if you plan to keep it around.</p>
<p>If no file is selected then the selected directory path is returned.</p>
<div class="refsect3">
<a name="gtk-file-selection-get-filename.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filesel</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-file-selection-get-filename.returns"></a><h4>Returns</h4>
<p> currently-selected filename in the on-disk encoding.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-file-selection-get-selections"></a><h3>gtk_file_selection_get_selections</h3>
<pre class="programlisting">#define gtk_file_selection_get_selections gtk_file_selection_get_selections_utf8
</pre>
<div class="warning"><p><code class="literal">gtk_file_selection_get_selections</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Retrieves the list of file selections the user has made in the dialog box.
This function is intended for use when the user can select multiple files
in the file list. </p>
<p>The filenames are in the GLib file name encoding. To convert to
UTF-8, call <code class="function">g_filename_to_utf8()</code> on each string.</p>
<div class="refsect3">
<a name="gtk-file-selection-get-selections.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filesel</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-file-selection-get-selections.returns"></a><h4>Returns</h4>
<p> a newly-allocated <code class="literal">NULL</code>-terminated array of strings. Use
<code class="function">g_strfreev()</code> to free it.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkFileSelection.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkFileSelection--filename"></a><h3>The <code class="literal">“filename”</code> property</h3>
<pre class="programlisting"> “filename” <span class="type">char</span> *</pre>
<p>The currently selected filename.</p>
<p>Owner: GtkFileSelection</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkFileSelection--select-multiple"></a><h3>The <code class="literal">“select-multiple”</code> property</h3>
<pre class="programlisting"> “select-multiple” <span class="type">gboolean</span></pre>
<p>Whether to allow multiple files to be selected.</p>
<p>Owner: GtkFileSelection</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkFileSelection--show-fileops"></a><h3>The <code class="literal">“show-fileops”</code> property</h3>
<pre class="programlisting"> “show-fileops” <span class="type">gboolean</span></pre>
<p>Whether buttons for creating/manipulating files should be displayed.</p>
<p>Owner: GtkFileSelection</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>
|