~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpfileentry.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
 
5
5
<refentry id="GimpFileEntry">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpFileEntry</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpFileEntry</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
10
</refmeta>
15
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
16
</refnamediv>
17
17
 
18
 
<refsynopsisdiv id="synopsis">
19
 
<title id="synopsis.title">Synopsis</title>
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
20
20
 
21
21
<synopsis>
22
22
 
23
23
 
24
24
 
25
 
            <link linkend="GimpFileEntry-struct">GimpFileEntry</link>;
26
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-file-entry-new">gimp_file_entry_new</link>             (const <link linkend="gchar">gchar</link> *title,
27
 
                                             const <link linkend="gchar">gchar</link> *filename,
28
 
                                             <link linkend="gboolean">gboolean</link> dir_only,
29
 
                                             <link linkend="gboolean">gboolean</link> check_valid);
30
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-file-entry-get-filename">gimp_file_entry_get_filename</link>    (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry);
31
 
<link linkend="void">void</link>        <link linkend="gimp-file-entry-set-filename">gimp_file_entry_set_filename</link>    (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry,
32
 
                                             const <link linkend="gchar">gchar</link> *filename);
 
25
                    <link linkend="GimpFileEntry-struct">GimpFileEntry</link>;
 
26
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-file-entry-new">gimp_file_entry_new</link>                 (const <link linkend="gchar">gchar</link> *title,
 
27
                                                         const <link linkend="gchar">gchar</link> *filename,
 
28
                                                         <link linkend="gboolean">gboolean</link> dir_only,
 
29
                                                         <link linkend="gboolean">gboolean</link> check_valid);
 
30
<link linkend="gchar">gchar</link>*              <link linkend="gimp-file-entry-get-filename">gimp_file_entry_get_filename</link>        (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry);
 
31
<link linkend="void">void</link>                <link linkend="gimp-file-entry-set-filename">gimp_file_entry_set_filename</link>        (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry,
 
32
                                                         const <link linkend="gchar">gchar</link> *filename);
33
33
 
34
34
</synopsis>
35
35
</refsynopsisdiv>
36
36
 
37
 
<refsect1 id="object_hierarchy">
38
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
37
<refsect1 role="object_hierarchy">
 
38
<title role="object_hierarchy.title">Object Hierarchy</title>
39
39
<synopsis>
40
40
 
41
41
  <link linkend="GObject">GObject</link>
52
52
 
53
53
 
54
54
 
55
 
<refsect1 id="impl_interfaces">
56
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
55
<refsect1 role="impl_interfaces">
 
56
<title role="impl_interfaces.title">Implemented Interfaces</title>
57
57
<para>
58
58
GimpFileEntry implements
59
59
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
62
62
 
63
63
 
64
64
 
65
 
<refsect1 id="signal_proto">
66
 
<title id="signal_proto.title">Signals</title>
 
65
<refsect1 role="signal_proto">
 
66
<title role="signal_proto.title">Signals</title>
67
67
<synopsis>
68
68
 
69
 
&quot;<link linkend="GimpFileEntry-filename-changed">filename-changed</link>&quot;
70
 
            <link linkend="void">void</link>        user_function      (<link linkend="GimpFileEntry">GimpFileEntry</link> *arg0,
71
 
                                            <link linkend="gpointer">gpointer</link>       user_data)      : Run first
 
69
  &quot;<link linkend="GimpFileEntry-filename-changed">filename-changed</link>&quot;                               : Run First
72
70
</synopsis>
73
71
</refsect1>
74
72
 
75
73
 
76
 
<refsect1 id="desc">
77
 
<title id="desc.title">Description</title>
 
74
<refsect1 role="desc">
 
75
<title role="desc.title">Description</title>
78
76
<para>
79
77
This widget is used to enter filenames or directories.
80
78
</para>
97
95
</para>
98
96
</refsect1>
99
97
 
100
 
<refsect1 id="details">
101
 
<title id="details.title">Details</title>
 
98
<refsect1 role="details">
 
99
<title role="details.title">Details</title>
102
100
<refsect2>
103
101
<title><anchor id="GimpFileEntry-struct" role="struct"/>GimpFileEntry</title>
104
 
<indexterm><primary>GimpFileEntry</primary></indexterm><programlisting>typedef struct _GimpFileEntry GimpFileEntry;</programlisting>
 
102
<indexterm role="deprecated"><primary>GimpFileEntry</primary></indexterm><programlisting>typedef struct _GimpFileEntry GimpFileEntry;</programlisting>
 
103
<warning><para><literal>GimpFileEntry</literal> is deprecated and should not be used in newly-written code.</para></warning>
105
104
<para>
106
105
 
107
106
</para></refsect2>
108
107
<refsect2>
109
 
<title><anchor id="gimp-file-entry-new" role="function"/>gimp_file_entry_new ()</title>
110
 
<indexterm><primary>gimp_file_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_file_entry_new             (const <link linkend="gchar">gchar</link> *title,
111
 
                                             const <link linkend="gchar">gchar</link> *filename,
112
 
                                             <link linkend="gboolean">gboolean</link> dir_only,
113
 
                                             <link linkend="gboolean">gboolean</link> check_valid);</programlisting>
 
108
<title><anchor id="gimp-file-entry-new" role="function" condition="deprecated:"/>gimp_file_entry_new ()</title>
 
109
<indexterm role="deprecated"><primary>gimp_file_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_file_entry_new                 (const <link linkend="gchar">gchar</link> *title,
 
110
                                                         const <link linkend="gchar">gchar</link> *filename,
 
111
                                                         <link linkend="gboolean">gboolean</link> dir_only,
 
112
                                                         <link linkend="gboolean">gboolean</link> check_valid);</programlisting>
 
113
<warning><para><literal>gimp_file_entry_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
114
114
<para>
115
 
Creates a new <link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> widget.</para>
 
115
You should use <link linkend="GtkFileChooserButton"><type>GtkFileChooserButton</type></link> instead.</para>
116
116
<para>
117
117
 
118
118
</para><variablelist role="params">
133
133
</simpara></listitem></varlistentry>
134
134
</variablelist></refsect2>
135
135
<refsect2>
136
 
<title><anchor id="gimp-file-entry-get-filename" role="function"/>gimp_file_entry_get_filename ()</title>
137
 
<indexterm><primary>gimp_file_entry_get_filename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_file_entry_get_filename    (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry);</programlisting>
 
136
<title><anchor id="gimp-file-entry-get-filename" role="function" condition="deprecated:"/>gimp_file_entry_get_filename ()</title>
 
137
<indexterm role="deprecated"><primary>gimp_file_entry_get_filename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_file_entry_get_filename        (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry);</programlisting>
 
138
<warning><para><literal>gimp_file_entry_get_filename</literal> is deprecated and should not be used in newly-written code.</para></warning>
138
139
<para>
139
140
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
140
141
<para>
147
148
</simpara></listitem></varlistentry>
148
149
</variablelist></refsect2>
149
150
<refsect2>
150
 
<title><anchor id="gimp-file-entry-set-filename" role="function"/>gimp_file_entry_set_filename ()</title>
151
 
<indexterm><primary>gimp_file_entry_set_filename</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_file_entry_set_filename    (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry,
152
 
                                             const <link linkend="gchar">gchar</link> *filename);</programlisting>
 
151
<title><anchor id="gimp-file-entry-set-filename" role="function" condition="deprecated:"/>gimp_file_entry_set_filename ()</title>
 
152
<indexterm role="deprecated"><primary>gimp_file_entry_set_filename</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_file_entry_set_filename        (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry,
 
153
                                                         const <link linkend="gchar">gchar</link> *filename);</programlisting>
 
154
<warning><para><literal>gimp_file_entry_set_filename</literal> is deprecated and should not be used in newly-written code.</para></warning>
153
155
<para>
154
156
If you specified <parameter>check_valid</parameter> as <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> in <link linkend="gimp-file-entry-new"><function>gimp_file_entry_new()</function></link>
155
157
the <link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> will immediately check the validity of the file
167
169
 
168
170
</refsect1>
169
171
 
170
 
<refsect1 id="signals">
171
 
<title id="signals.title">Signal Details</title>
 
172
<refsect1 role="signals">
 
173
<title role="signals.title">Signal Details</title>
172
174
<refsect2><title><anchor id="GimpFileEntry-filename-changed"/>The &quot;filename-changed&quot; signal</title>
173
 
<indexterm><primary>GimpFileEntry::filename-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpFileEntry">GimpFileEntry</link> *arg0,
174
 
                                            <link linkend="gpointer">gpointer</link>       user_data)      : Run first</programlisting>
 
175
<indexterm><primary>GimpFileEntry::filename-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpFileEntry">GimpFileEntry</link> *arg0,
 
176
                                                        <link linkend="gpointer">gpointer</link>       user_data)      : Run First</programlisting>
175
177
<para>
176
178
This signal is emitted whenever the user changes the filename.</para>
177
179
<para>