~ubuntu-branches/ubuntu/raring/gtk+2.0/raring-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkFileSelection.html

  • Committer: Package Import Robot
  • Author(s): Robert Ancell
  • Date: 2012-09-05 17:27:55 UTC
  • mfrom: (1.14.14)
  • Revision ID: package-import@ubuntu.com-20120905172755-14uyfpowr7elvr7m
Tags: 2.24.12-0ubuntu1
* New upstream bugfix release
* debian/patches/091_bugzilla_tooltip_refresh.patch:
  - Applied upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
9
9
<link rel="prev" href="GtkCombo.html" title="GtkCombo">
10
10
<link rel="next" href="GtkItemFactory.html" title="GtkItemFactory">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
47
47
#include &lt;gtk/gtk.h&gt;
48
48
 
49
49
struct              <a class="link" href="GtkFileSelection.html#GtkFileSelection-struct" title="struct GtkFileSelection">GtkFileSelection</a>;
50
 
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkFileSelection.html#gtk-file-selection-new" title="gtk_file_selection_new ()">gtk_file_selection_new</a>              (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);
 
50
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkFileSelection.html#gtk-file-selection-new" title="gtk_file_selection_new ()">gtk_file_selection_new</a>              (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>);
51
51
#define             <a class="link" href="GtkFileSelection.html#gtk-file-selection-set-filename" title="gtk_file_selection_set_filename">gtk_file_selection_set_filename</a>
52
52
#define             <a class="link" href="GtkFileSelection.html#gtk-file-selection-get-filename" title="gtk_file_selection_get_filename">gtk_file_selection_get_filename</a>
53
53
<span class="returnvalue">void</span>                <a class="link" href="GtkFileSelection.html#gtk-file-selection-complete" title="gtk_file_selection_complete ()">gtk_file_selection_complete</a>         (<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>,
54
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern</code></em>);
 
54
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *pattern</code></em>);
55
55
<span class="returnvalue">void</span>                <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>
56
56
                                                        (<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>);
57
57
<span class="returnvalue">void</span>                <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>
59
59
#define             <a class="link" href="GtkFileSelection.html#gtk-file-selection-get-selections" title="gtk_file_selection_get_selections">gtk_file_selection_get_selections</a>
60
60
<span class="returnvalue">void</span>                <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>
61
61
                                                        (<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>,
62
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> select_multiple</code></em>);
63
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>
 
62
                                                         <em class="parameter"><code><span class="type">gboolean</span> select_multiple</code></em>);
 
63
<span class="returnvalue">gboolean</span>            <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>
64
64
                                                        (<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>);
65
65
</pre>
66
66
</div>
87
87
<div class="refsect1">
88
88
<a name="GtkFileSelection.properties"></a><h2>Properties</h2>
89
89
<pre class="synopsis">
90
 
  "<a class="link" href="GtkFileSelection.html#GtkFileSelection--filename" title='The "filename" property'>filename</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
91
 
  "<a class="link" href="GtkFileSelection.html#GtkFileSelection--select-multiple" title='The "select-multiple" property'>select-multiple</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
92
 
  "<a class="link" href="GtkFileSelection.html#GtkFileSelection--show-fileops" title='The "show-fileops" property'>show-fileops</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
90
  "<a class="link" href="GtkFileSelection.html#GtkFileSelection--filename" title='The "filename" property'>filename</a>"                 <span class="type">gchar</span>*                : Read / Write
 
91
  "<a class="link" href="GtkFileSelection.html#GtkFileSelection--select-multiple" title='The "select-multiple" property'>select-multiple</a>"          <span class="type">gboolean</span>              : Read / Write
 
92
  "<a class="link" href="GtkFileSelection.html#GtkFileSelection--show-fileops" title='The "show-fileops" property'>show-fileops</a>"             <span class="type">gboolean</span>              : Read / Write
93
93
</pre>
94
94
</div>
95
95
<div class="refsect1">
123
123
<p>
124
124
</p>
125
125
<div class="example">
126
 
<a name="id1258328"></a><p class="title"><b>Example 64. Getting a filename from the user.</b></p>
 
126
<a name="id1389229"></a><p class="title"><b>Example 64. Getting a filename from the user.</b></p>
127
127
<div class="example-contents">
128
128
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
129
129
    <tbody>
160
160
<span class="normal">   </span><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">file_selector </span><span class="symbol">=</span><span class="normal"> </span><span class="function">GTK_WIDGET</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">user_data</span><span class="symbol">);</span>
161
161
<span class="normal">   </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">selected_filename</span><span class="symbol">;</span>
162
162
<span class="normal">   selected_filename </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkFileSelection.html#gtk-file-selection-get-filename">gtk_file_selection_get_filename</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_FILE_SELECTION</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file_selector</span><span class="symbol">));</span>
163
 
<span class="normal">   </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Selected filename: %s</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">,</span><span class="normal"> selected_filename</span><span class="symbol">);</span>
 
163
<span class="normal">   </span><span class="function">g_print</span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Selected filename: %s</span><span class="specialchar">\n</span><span class="string">"</span><span class="symbol">,</span><span class="normal"> selected_filename</span><span class="symbol">);</span>
164
164
<span class="cbracket">}</span>
165
165
<span class="type">void</span><span class="normal"> </span><span class="function">create_file_selection</span><span class="normal"> </span><span class="symbol">(</span><span class="type">void</span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
166
166
<span class="normal">   </span><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">file_selector</span><span class="symbol">;</span>
277
277
<td></td>
278
278
</tr>
279
279
<tr>
280
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="GtkFileSelection-struct.history-list"></a>history_list</code></em>;</span></p></td>
 
280
<td><p><span class="term"><span class="type">GList</span> *<em class="structfield"><code><a name="GtkFileSelection-struct.history-list"></a>history_list</code></em>;</span></p></td>
281
281
<td></td>
282
282
</tr>
283
283
<tr>
291
291
<td></td>
292
292
</tr>
293
293
<tr>
294
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GtkFileSelection-struct.fileop-file"></a>fileop_file</code></em>;</span></p></td>
 
294
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="GtkFileSelection-struct.fileop-file"></a>fileop_file</code></em>;</span></p></td>
295
295
<td></td>
296
296
</tr>
297
297
<tr>
298
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GtkFileSelection-struct.cmpl-state"></a>cmpl_state</code></em>;</span></p></td>
 
298
<td><p><span class="term"><span class="type">gpointer</span> <em class="structfield"><code><a name="GtkFileSelection-struct.cmpl-state"></a>cmpl_state</code></em>;</span></p></td>
299
299
<td></td>
300
300
</tr>
301
301
<tr>
327
327
<hr>
328
328
<div class="refsect2">
329
329
<a name="gtk-file-selection-new"></a><h3>gtk_file_selection_new ()</h3>
330
 
<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 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>);</pre>
 
330
<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>
331
331
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
332
332
<h3 class="title">Warning</h3>
333
333
<p><code class="literal">gtk_file_selection_new</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="GtkFileChooserDialog.html#gtk-file-chooser-dialog-new" title="gtk_file_chooser_dialog_new ()"><code class="function">gtk_file_chooser_dialog_new()</code></a> instead</p>
373
373
</p>
374
374
<p>
375
375
The encoding of <em class="parameter"><code>filename</code></em> is preferred GLib file name encoding, which
376
 
may not be UTF-8. See <a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#g-filename-from-utf8"><code class="function">g_filename_from_utf8()</code></a>.
 
376
may not be UTF-8. See <code class="function">g_filename_from_utf8()</code>.
377
377
</p>
378
378
<div class="variablelist"><table border="0" class="variablelist">
379
379
<colgroup>
403
403
</div>
404
404
<p>
405
405
This function returns the selected filename in the GLib file name
406
 
encoding. To convert to UTF-8, call <a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#g-filename-to-utf8"><code class="function">g_filename_to_utf8()</code></a>. The
 
406
encoding. To convert to UTF-8, call <code class="function">g_filename_to_utf8()</code>. The
407
407
returned string points to a statically allocated buffer and should
408
408
be copied if you plan to keep it around.
409
409
</p>
425
425
<div class="refsect2">
426
426
<a name="gtk-file-selection-complete"></a><h3>gtk_file_selection_complete ()</h3>
427
427
<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>,
428
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern</code></em>);</pre>
 
428
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *pattern</code></em>);</pre>
429
429
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
430
430
<h3 class="title">Warning</h3>
431
431
<p><code class="literal">gtk_file_selection_complete</code> is deprecated and should not be used in newly-written code.</p>
515
515
</p>
516
516
<p>
517
517
The filenames are in the GLib file name encoding. To convert to
518
 
UTF-8, call <a href="http://library.gnome.org/devel/glib/unstable/glib-Character-Set-Conversion.html#g-filename-to-utf8"><code class="function">g_filename_to_utf8()</code></a> on each string.
 
518
UTF-8, call <code class="function">g_filename_to_utf8()</code> on each string.
519
519
</p>
520
520
<div class="variablelist"><table border="0" class="variablelist">
521
521
<colgroup>
524
524
</colgroup>
525
525
<tbody><tr>
526
526
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
527
 
<td>a newly-allocated <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of strings. Use
528
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> to free it.</td>
 
527
<td>a newly-allocated <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>-terminated array of strings. Use
 
528
<code class="function">g_strfreev()</code> to free it.</td>
529
529
</tr></tbody>
530
530
</table></div>
531
531
</div>
534
534
<a name="gtk-file-selection-set-select-multiple"></a><h3>gtk_file_selection_set_select_multiple ()</h3>
535
535
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_file_selection_set_select_multiple
536
536
                                                        (<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>,
537
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> select_multiple</code></em>);</pre>
 
537
                                                         <em class="parameter"><code><span class="type">gboolean</span> select_multiple</code></em>);</pre>
538
538
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
539
539
<h3 class="title">Warning</h3>
540
540
<p><code class="literal">gtk_file_selection_set_select_multiple</code> is deprecated and should not be used in newly-written code.</p>
565
565
<hr>
566
566
<div class="refsect2">
567
567
<a name="gtk-file-selection-get-select-multiple"></a><h3>gtk_file_selection_get_select_multiple ()</h3>
568
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gtk_file_selection_get_select_multiple
 
568
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_file_selection_get_select_multiple
569
569
                                                        (<em class="parameter"><code><a class="link" href="GtkFileSelection.html" title="GtkFileSelection"><span class="type">GtkFileSelection</span></a> *filesel</code></em>);</pre>
570
570
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
571
571
<h3 class="title">Warning</h3>
589
589
<tr>
590
590
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
591
591
<td>
592
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the user is allowed to select multiple files in the
 
592
<code class="literal">TRUE</code> if the user is allowed to select multiple files in the
593
593
file list</td>
594
594
</tr>
595
595
</tbody>
600
600
<a name="GtkFileSelection.property-details"></a><h2>Property Details</h2>
601
601
<div class="refsect2">
602
602
<a name="GtkFileSelection--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
603
 
<pre class="programlisting">  "filename"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
603
<pre class="programlisting">  "filename"                 <span class="type">gchar</span>*                : Read / Write</pre>
604
604
<p>The currently selected filename.</p>
605
605
<p>Default value: NULL</p>
606
606
</div>
607
607
<hr>
608
608
<div class="refsect2">
609
609
<a name="GtkFileSelection--select-multiple"></a><h3>The <code class="literal">"select-multiple"</code> property</h3>
610
 
<pre class="programlisting">  "select-multiple"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
610
<pre class="programlisting">  "select-multiple"          <span class="type">gboolean</span>              : Read / Write</pre>
611
611
<p>Whether to allow multiple files to be selected.</p>
612
612
<p>Default value: FALSE</p>
613
613
</div>
614
614
<hr>
615
615
<div class="refsect2">
616
616
<a name="GtkFileSelection--show-fileops"></a><h3>The <code class="literal">"show-fileops"</code> property</h3>
617
 
<pre class="programlisting">  "show-fileops"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
617
<pre class="programlisting">  "show-fileops"             <span class="type">gboolean</span>              : Read / Write</pre>
618
618
<p>Whether buttons for creating/manipulating files should be displayed.</p>
619
619
<p>Default value: TRUE</p>
620
620
</div>
639
639
</div>
640
640
<div class="footer">
641
641
<hr>
642
 
          Generated by GTK-Doc V1.18</div>
 
642
          Generated by GTK-Doc V1.18.1</div>
643
643
</body>
644
644
</html>
 
 
b'\\ No newline at end of file'