~ubuntu-branches/ubuntu/lucid/gedit/lucid-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: 2010-03-18 00:37:05 UTC
  • mfrom: (1.1.76 upstream)
  • Revision ID: james.westby@ubuntu.com-20100318003705-typ8fgrsezmc334h
Tags: 2.29.9-0ubuntu1
* New upstream version:
  - Fix a file corruption bug in the new file saving code 
  - Misc bugfixes
* debian/patches/80_not_using_localmodlibs.patch:
  - dropped, the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="GeditFileChooserDialog">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="GeditFileChooserDialog.top_of_page">GeditFileChooserDialog</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>GEDIT Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>GeditFileChooserDialog</refname>
13
 
<refpurpose></refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="GeditFileChooserDialog.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
                    <link linkend="GeditFileChooserDialogPrivate">GeditFileChooserDialogPrivate</link>;
21
 
                    <link linkend="GeditFileChooserDialog-struct">GeditFileChooserDialog</link>;
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,
23
 
                                                         <link linkend="GtkWindow">GtkWindow</link> *parent,
24
 
                                                         <link linkend="GtkFileChooserAction">GtkFileChooserAction</link> action,
25
 
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
26
 
                                                         const <link linkend="gchar">gchar</link> *first_button_text,
27
 
                                                         ...);
28
 
<link linkend="void">void</link>                <link linkend="gedit-file-chooser-dialog-set-encoding">gedit_file_chooser_dialog_set_encoding</link>
29
 
                                                        (<link linkend="GeditFileChooserDialog">GeditFileChooserDialog</link> *dialog,
30
 
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding);
31
 
</synopsis>
32
 
</refsynopsisdiv>
33
 
 
34
 
<refsect1 id="GeditFileChooserDialog.object-hierarchy" role="object_hierarchy">
35
 
<title role="object_hierarchy.title">Object Hierarchy</title>
36
 
<synopsis>
37
 
  <link linkend="GObject">GObject</link>
38
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
39
 
         +----<link linkend="GtkObject">GtkObject</link>
40
 
               +----<link linkend="GtkWidget">GtkWidget</link>
41
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
42
 
                           +----<link linkend="GtkBin">GtkBin</link>
43
 
                                 +----<link linkend="GtkWindow">GtkWindow</link>
44
 
                                       +----<link linkend="GtkDialog">GtkDialog</link>
45
 
                                             +----<link linkend="GtkFileChooserDialog">GtkFileChooserDialog</link>
46
 
                                                   +----GeditFileChooserDialog
47
 
</synopsis>
48
 
</refsect1>
49
 
 
50
 
 
51
 
 
52
 
<refsect1 id="GeditFileChooserDialog.implemented-interfaces" role="impl_interfaces">
53
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
54
 
<para>
55
 
GeditFileChooserDialog implements
56
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkFileChooser">GtkFileChooser</link>.</para>
57
 
</refsect1>
58
 
 
59
 
 
60
 
 
61
 
 
62
 
 
63
 
<refsect1 id="GeditFileChooserDialog.description" role="desc">
64
 
<title role="desc.title">Description</title>
65
 
<para>
66
 
</para>
67
 
</refsect1>
68
 
 
69
 
<refsect1 id="GeditFileChooserDialog.details" role="details">
70
 
<title role="details.title">Details</title>
71
 
<refsect2 id="GeditFileChooserDialogPrivate" role="struct">
72
 
<title>GeditFileChooserDialogPrivate</title>
73
 
<indexterm zone="GeditFileChooserDialogPrivate"><primary sortas="GeditFileChooserDialogPrivate">GeditFileChooserDialogPrivate</primary></indexterm><programlisting>typedef struct _GeditFileChooserDialogPrivate GeditFileChooserDialogPrivate;</programlisting>
74
 
<para>
75
 
</para></refsect2>
76
 
<refsect2 id="GeditFileChooserDialog-struct" role="struct">
77
 
<title>GeditFileChooserDialog</title>
78
 
<indexterm zone="GeditFileChooserDialog-struct"><primary sortas="GeditFileChooserDialog">GeditFileChooserDialog</primary></indexterm><programlisting>typedef struct _GeditFileChooserDialog GeditFileChooserDialog;</programlisting>
79
 
<para>
80
 
</para></refsect2>
81
 
<refsect2 id="gedit-file-chooser-dialog-new" role="function">
82
 
<title>gedit_file_chooser_dialog_new ()</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,
84
 
                                                         <link linkend="GtkWindow">GtkWindow</link> *parent,
85
 
                                                         <link linkend="GtkFileChooserAction">GtkFileChooserAction</link> action,
86
 
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding,
87
 
                                                         const <link linkend="gchar">gchar</link> *first_button_text,
88
 
                                                         ...);</programlisting>
89
 
<para>
90
 
Creates a new <link linkend="GeditFileChooserDialog"><type>GeditFileChooserDialog</type></link>.  This function is analogous to
91
 
<link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
92
 
<para>
93
 
</para><variablelist role="params">
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>
101
 
<listitem><simpara> Open or save mode for the dialog
102
 
</simpara></listitem></varlistentry>
103
 
<varlistentry><term><parameter>encoding</parameter>&#160;:</term>
104
 
<listitem><simpara>
105
 
</simpara></listitem></varlistentry>
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>
113
 
 
114
 
</simpara></listitem></varlistentry>
115
 
</variablelist></refsect2>
116
 
<refsect2 id="gedit-file-chooser-dialog-set-encoding" role="function">
117
 
<title>gedit_file_chooser_dialog_set_encoding ()</title>
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
119
 
                                                        (<link linkend="GeditFileChooserDialog">GeditFileChooserDialog</link> *dialog,
120
 
                                                         const <link linkend="GeditEncoding">GeditEncoding</link> *encoding);</programlisting>
121
 
<para>
122
 
</para><variablelist role="params">
123
 
<varlistentry><term><parameter>dialog</parameter>&#160;:</term>
124
 
<listitem><simpara>
125
 
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><parameter>encoding</parameter>&#160;:</term>
127
 
<listitem><simpara>
128
 
</simpara></listitem></varlistentry>
129
 
</variablelist></refsect2>
130
 
 
131
 
</refsect1>
132
 
 
133
 
 
134
 
 
135
 
 
136
 
</refentry>