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

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpui.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:
23
23
 
24
24
 
25
25
 
26
 
<link linkend="void">void</link>        <link linkend="gimp-ui-init">gimp_ui_init</link>                    (const <link linkend="gchar">gchar</link> *prog_name,
27
 
                                             <link linkend="gboolean">gboolean</link> preview);
 
26
<link linkend="void">void</link>                <link linkend="gimp-ui-init">gimp_ui_init</link>                        (const <link linkend="gchar">gchar</link> *prog_name,
 
27
                                                         <link linkend="gboolean">gboolean</link> preview);
 
28
<link linkend="GdkWindow">GdkWindow</link>*          <link linkend="gimp-ui-get-display-window">gimp_ui_get_display_window</link>          (<link linkend="guint32">guint32</link> gdisp_ID);
 
29
<link linkend="GdkWindow">GdkWindow</link>*          <link linkend="gimp-ui-get-progress-window">gimp_ui_get_progress_window</link>         (void);
 
30
<link linkend="void">void</link>                <link linkend="gimp-window-set-transient">gimp_window_set_transient</link>           (<link linkend="GtkWindow">GtkWindow</link> *window);
 
31
<link linkend="void">void</link>                <link linkend="gimp-window-set-transient-for-display">gimp_window_set_transient_for_display</link>
 
32
                                                        (<link linkend="GtkWindow">GtkWindow</link> *window,
 
33
                                                         <link linkend="guint32">guint32</link> gdisp_ID);
28
34
</synopsis>
29
35
</refsynopsisdiv>
30
36
 
49
55
<title role="details.title">Details</title>
50
56
<refsect2>
51
57
<title><anchor id="gimp-ui-init" role="function"/>gimp_ui_init ()</title>
52
 
<indexterm><primary>gimp_ui_init</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_ui_init                    (const <link linkend="gchar">gchar</link> *prog_name,
53
 
                                             <link linkend="gboolean">gboolean</link> preview);</programlisting>
 
58
<indexterm><primary>gimp_ui_init</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_ui_init                        (const <link linkend="gchar">gchar</link> *prog_name,
 
59
                                                         <link linkend="gboolean">gboolean</link> preview);</programlisting>
54
60
<para>
55
61
This function initializes GTK+ with <link linkend="gtk-init"><function>gtk_init()</function></link> and initializes GDK's
56
62
image rendering subsystem (GdkRGB) to follow the GIMP main program's
72
78
            reasons only.
73
79
</simpara></listitem></varlistentry>
74
80
</variablelist></refsect2>
 
81
<refsect2>
 
82
<title><anchor id="gimp-ui-get-display-window" role="function" condition="since:GIMP 2.4"/>gimp_ui_get_display_window ()</title>
 
83
<indexterm role="GIMP 2.4"><primary>gimp_ui_get_display_window</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link>*          gimp_ui_get_display_window          (<link linkend="guint32">guint32</link> gdisp_ID);</programlisting>
 
84
<para>
 
85
Returns the <link linkend="GdkWindow"><type>GdkWindow</type></link> of a display window. The purpose is to allow
 
86
to make plug-in dialogs transient to the image display as explained
 
87
with <link linkend="gdk-window-set-transient-for"><function>gdk_window_set_transient_for()</function></link>.
 
88
</para>
 
89
<para>
 
90
You shouldn't have to call this function directly. Use
 
91
<link linkend="gimp-window-set-transient-for-display"><function>gimp_window_set_transient_for_display()</function></link> instead.</para>
 
92
<para>
 
93
 
 
94
</para><variablelist role="params">
 
95
<varlistentry><term><parameter>gdisp_ID</parameter>&nbsp;:</term>
 
96
<listitem><simpara>
 
97
</simpara></listitem></varlistentry>
 
98
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A reference to a <link linkend="GdkWindow"><type>GdkWindow</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. You should
 
99
              unref the window using <link linkend="g-object-unref"><function>g_object_unref()</function></link> as soon as
 
100
              you don't need it any longer.
 
101
 
 
102
</simpara></listitem></varlistentry>
 
103
</variablelist><para role="since">Since  GIMP 2.4
 
104
</para></refsect2>
 
105
<refsect2>
 
106
<title><anchor id="gimp-ui-get-progress-window" role="function" condition="since:GIMP 2.4"/>gimp_ui_get_progress_window ()</title>
 
107
<indexterm role="GIMP 2.4"><primary>gimp_ui_get_progress_window</primary></indexterm><programlisting><link linkend="GdkWindow">GdkWindow</link>*          gimp_ui_get_progress_window         (void);</programlisting>
 
108
<para>
 
109
Returns the <link linkend="GdkWindow"><type>GdkWindow</type></link> of the window this plug-in's progress bar is
 
110
shown in. Use it to make plug-in dialogs transient to this window
 
111
as explained with <link linkend="gdk-window-set-transient-for"><function>gdk_window_set_transient_for()</function></link>.
 
112
</para>
 
113
<para>
 
114
You shouldn't have to call this function directly. Use
 
115
<link linkend="gimp-window-set-transient"><function>gimp_window_set_transient()</function></link> instead.</para>
 
116
<para>
 
117
 
 
118
</para><variablelist role="params">
 
119
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A reference to a <link linkend="GdkWindow"><type>GdkWindow</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. You should
 
120
              unref the window using <link linkend="g-object-unref"><function>g_object_unref()</function></link> as soon as
 
121
              you don't need it any longer.
 
122
 
 
123
</simpara></listitem></varlistentry>
 
124
</variablelist><para role="since">Since  GIMP 2.4
 
125
</para></refsect2>
 
126
<refsect2>
 
127
<title><anchor id="gimp-window-set-transient" role="function" condition="since:GIMP 2.4"/>gimp_window_set_transient ()</title>
 
128
<indexterm role="GIMP 2.4"><primary>gimp_window_set_transient</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_window_set_transient           (<link linkend="GtkWindow">GtkWindow</link> *window);</programlisting>
 
129
<para>
 
130
Indicates to the window manager that <parameter>window</parameter> is a transient dialog
 
131
associated with the GIMP window that the plug-in has been
 
132
started from. See also <link linkend="gimp-window-set-transient-for-display"><function>gimp_window_set_transient_for_display()</function></link>.</para>
 
133
<para>
 
134
 
 
135
</para><variablelist role="params">
 
136
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
 
137
<listitem><simpara> the <link linkend="GtkWindow"><type>GtkWindow</type></link> that should become transient
 
138
</simpara></listitem></varlistentry>
 
139
</variablelist><para role="since">Since  GIMP 2.4
 
140
</para></refsect2>
 
141
<refsect2>
 
142
<title><anchor id="gimp-window-set-transient-for-display" role="function" condition="since:GIMP 2.4"/>gimp_window_set_transient_for_display ()</title>
 
143
<indexterm role="GIMP 2.4"><primary>gimp_window_set_transient_for_display</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_window_set_transient_for_display
 
144
                                                        (<link linkend="GtkWindow">GtkWindow</link> *window,
 
145
                                                         <link linkend="guint32">guint32</link> gdisp_ID);</programlisting>
 
146
<para>
 
147
Indicates to the window manager that <parameter>window</parameter> is a transient dialog
 
148
associated with the GIMP image window that is identified by it's
 
149
display ID.  See <link linkend="gdk-window-set-transient-for"><function>gdk_window_set_transient_for()</function></link> for more information.
 
150
</para>
 
151
<para>
 
152
Most of the time you will want to use the convenience function
 
153
<link linkend="gimp-window-set-transient"><function>gimp_window_set_transient()</function></link>.</para>
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
 
157
<varlistentry><term><parameter>window</parameter>&nbsp;:</term>
 
158
<listitem><simpara>   the <link linkend="GtkWindow"><type>GtkWindow</type></link> that should become transient
 
159
</simpara></listitem></varlistentry>
 
160
<varlistentry><term><parameter>gdisp_ID</parameter>&nbsp;:</term>
 
161
<listitem><simpara> display ID of the image window that should become the parent
 
162
</simpara></listitem></varlistentry>
 
163
</variablelist><para role="since">Since  GIMP 2.4
 
164
</para></refsect2>
75
165
 
76
166
</refsect1>
77
167