~ubuntu-branches/ubuntu/intrepid/gedit/intrepid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/xml/gedit-file-chooser-dialog.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-09-08 21:33:44 UTC
  • mfrom: (1.1.48 upstream)
  • Revision ID: james.westby@ubuntu.com-20080908213344-eiv4gvnuily7unti
Tags: 2.23.92-0ubuntu1
* New upstream version:
  - Bugfixes related to the gio port (lp: #236953, #262007)

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
<refnamediv>
12
12
<refname>GeditFileChooserDialog</refname>
13
13
<refpurpose></refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
14
</refnamediv>
16
15
 
17
16
<refsynopsisdiv id="GeditFileChooserDialog.synopsis" role="synopsis">
20
19
<synopsis>
21
20
                    <link linkend="GeditFileChooserDialogPrivate">GeditFileChooserDialogPrivate</link>;
22
21
                    <link linkend="GeditFileChooserDialog-struct">GeditFileChooserDialog</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gedit-file-chooser-dialog-new">gedit_file_chooser_dialog_new</link>       (const <link linkend="gchar">gchar</link> *title,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gedit-file-chooser-dialog-new">gedit_file_chooser_dialog_new</link>       (const <link linkend="gchar">gchar</link> *title,
24
23
                                                         <link linkend="GtkWindow">GtkWindow</link> *parent,
25
24
                                                         <link linkend="GtkFileChooserAction">GtkFileChooserAction</link> action,
26
25
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
46
45
                                             +----<link linkend="GtkFileChooserDialog">GtkFileChooserDialog</link>
47
46
                                                   +----GeditFileChooserDialog
48
47
</synopsis>
49
 
 
50
48
</refsect1>
51
49
 
52
50
 
56
54
<para>
57
55
GeditFileChooserDialog implements
58
56
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkFileChooser">GtkFileChooser</link>.</para>
59
 
 
60
57
</refsect1>
61
58
 
62
59
 
66
63
<refsect1 id="GeditFileChooserDialog.description" role="desc">
67
64
<title role="desc.title">Description</title>
68
65
<para>
69
 
 
70
66
</para>
71
67
</refsect1>
72
68
 
74
70
<title role="details.title">Details</title>
75
71
<refsect2 id="GeditFileChooserDialogPrivate" role="struct">
76
72
<title>GeditFileChooserDialogPrivate</title>
77
 
<indexterm zone="GeditFileChooserDialogPrivate"><primary>GeditFileChooserDialogPrivate</primary></indexterm><programlisting>typedef struct _GeditFileChooserDialogPrivate GeditFileChooserDialogPrivate;</programlisting>
 
73
<indexterm zone="GeditFileChooserDialogPrivate"><primary sortas="GeditFileChooserDialogPrivate">GeditFileChooserDialogPrivate</primary></indexterm><programlisting>typedef struct _GeditFileChooserDialogPrivate GeditFileChooserDialogPrivate;</programlisting>
78
74
<para>
79
 
 
80
75
</para></refsect2>
81
76
<refsect2 id="GeditFileChooserDialog-struct" role="struct">
82
77
<title>GeditFileChooserDialog</title>
83
 
<indexterm zone="GeditFileChooserDialog-struct"><primary>GeditFileChooserDialog</primary></indexterm><programlisting>typedef struct _GeditFileChooserDialog GeditFileChooserDialog;</programlisting>
 
78
<indexterm zone="GeditFileChooserDialog-struct"><primary sortas="GeditFileChooserDialog">GeditFileChooserDialog</primary></indexterm><programlisting>typedef struct _GeditFileChooserDialog GeditFileChooserDialog;</programlisting>
84
79
<para>
85
 
 
86
80
</para></refsect2>
87
81
<refsect2 id="gedit-file-chooser-dialog-new" role="function">
88
82
<title>gedit_file_chooser_dialog_new ()</title>
89
 
<indexterm zone="gedit-file-chooser-dialog-new"><primary>gedit_file_chooser_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gedit_file_chooser_dialog_new       (const <link linkend="gchar">gchar</link> *title,
 
83
<indexterm zone="gedit-file-chooser-dialog-new"><primary sortas="gedit_file_chooser_dialog_new">gedit_file_chooser_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gedit_file_chooser_dialog_new       (const <link linkend="gchar">gchar</link> *title,
90
84
                                                         <link linkend="GtkWindow">GtkWindow</link> *parent,
91
85
                                                         <link linkend="GtkFileChooserAction">GtkFileChooserAction</link> action,
92
86
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
96
90
Creates a new <link linkend="GeditFileChooserDialog"><type>GeditFileChooserDialog</type></link>.  This function is analogous to
97
91
<link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
98
92
<para>
99
 
 
100
93
</para><variablelist role="params">
101
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
102
 
<listitem><simpara> Title of the dialog, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
103
 
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
105
 
<listitem><simpara> Transient parent of the dialog, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
106
 
</simpara></listitem></varlistentry>
107
 
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
 
94
<varlistentry><term><parameter>title</parameter>&#160;:</term>
 
95
<listitem><simpara> Title of the dialog, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
 
96
</simpara></listitem></varlistentry>
 
97
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
 
98
<listitem><simpara> Transient parent of the dialog, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
 
99
</simpara></listitem></varlistentry>
 
100
<varlistentry><term><parameter>action</parameter>&#160;:</term>
108
101
<listitem><simpara> Open or save mode for the dialog
109
102
</simpara></listitem></varlistentry>
110
 
<varlistentry><term><parameter>encoding</parameter>&nbsp;:</term>
 
103
<varlistentry><term><parameter>encoding</parameter>&#160;:</term>
111
104
<listitem><simpara>
112
105
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><parameter>first_button_text</parameter>&nbsp;:</term>
114
 
<listitem><simpara> stock ID or text to go in the first button, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
115
 
</simpara></listitem></varlistentry>
116
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
117
 
<listitem><simpara> response ID for the first button, then additional (button, id) pairs, ending with <link linkend="NULL:CAPS"><literal>NULL</literal></link>
118
 
</simpara></listitem></varlistentry>
119
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GeditFileChooserDialog"><type>GeditFileChooserDialog</type></link>
 
106
<varlistentry><term><parameter>first_button_text</parameter>&#160;:</term>
 
107
<listitem><simpara> stock ID or text to go in the first button, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
 
108
</simpara></listitem></varlistentry>
 
109
<varlistentry><term><parameter>...</parameter>&#160;:</term>
 
110
<listitem><simpara> response ID for the first button, then additional (button, id) pairs, ending with <link linkend="NULL--CAPS"><literal>NULL</literal></link>
 
111
</simpara></listitem></varlistentry>
 
112
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GeditFileChooserDialog"><type>GeditFileChooserDialog</type></link>
120
113
 
121
114
</simpara></listitem></varlistentry>
122
115
</variablelist></refsect2>
123
116
<refsect2 id="gedit-file-chooser-dialog-set-encoding" role="function">
124
117
<title>gedit_file_chooser_dialog_set_encoding ()</title>
125
 
<indexterm zone="gedit-file-chooser-dialog-set-encoding"><primary>gedit_file_chooser_dialog_set_encoding</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_file_chooser_dialog_set_encoding
 
118
<indexterm zone="gedit-file-chooser-dialog-set-encoding"><primary sortas="gedit_file_chooser_dialog_set_encoding">gedit_file_chooser_dialog_set_encoding</primary></indexterm><programlisting><link linkend="void">void</link>                gedit_file_chooser_dialog_set_encoding
126
119
                                                        (<link linkend="GeditFileChooserDialog">GeditFileChooserDialog</link> *dialog,
127
120
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding);</programlisting>
128
121
<para>
129
 
 
130
122
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
 
123
<varlistentry><term><parameter>dialog</parameter>&#160;:</term>
132
124
<listitem><simpara>
133
125
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><parameter>encoding</parameter>&nbsp;:</term>
 
126
<varlistentry><term><parameter>encoding</parameter>&#160;:</term>
135
127
<listitem><simpara>
136
 
 
137
 
 
138
128
</simpara></listitem></varlistentry>
139
129
</variablelist></refsect2>
140
130