File: gimpoffsetarea.xml

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (205 lines) | stat: -rw-r--r-- 10,201 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="GimpOffsetArea">
<refmeta>
<refentrytitle id="top_of_page">GimpOffsetArea</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GimpOffsetArea</refname>
<refpurpose>Widget to control image offsets.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>

<synopsis>



            <link linkend="GimpOffsetArea-struct">GimpOffsetArea</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-offset-area-new">gimp_offset_area_new</link>            (<link linkend="gint">gint</link> orig_width,
                                             <link linkend="gint">gint</link> orig_height);
<link linkend="void">void</link>        <link linkend="gimp-offset-area-set-size">gimp_offset_area_set_size</link>       (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
                                             <link linkend="gint">gint</link> width,
                                             <link linkend="gint">gint</link> height);
<link linkend="void">void</link>        <link linkend="gimp-offset-area-set-offsets">gimp_offset_area_set_offsets</link>    (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
                                             <link linkend="gint">gint</link> offset_x,
                                             <link linkend="gint">gint</link> offset_y);
<link linkend="void">void</link>        <link linkend="gimp-offset-area-set-pixbuf">gimp_offset_area_set_pixbuf</link>     (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
                                             <link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);

</synopsis>
</refsynopsisdiv>

<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkDrawingArea">GtkDrawingArea</link>
                           +----GimpOffsetArea
</synopsis>

</refsect1>



<refsect1 id="impl_interfaces">
<title id="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpOffsetArea implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>

</refsect1>



<refsect1 id="signal_proto">
<title id="signal_proto.title">Signals</title>
<synopsis>

&quot;<link linkend="GimpOffsetArea-offsets-changed">offsets-changed</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *gimpoffsetarea,
                                            <link linkend="gint">gint</link>            arg1,
                                            <link linkend="gint">gint</link>            arg2,
                                            <link linkend="gpointer">gpointer</link>        user_data)           : Run first
</synopsis>
</refsect1>


<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpOffsetArea-struct" role="struct"/>GimpOffsetArea</title>
<indexterm><primary>GimpOffsetArea</primary></indexterm><programlisting>typedef struct _GimpOffsetArea GimpOffsetArea;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gimp-offset-area-new" role="function"/>gimp_offset_area_new ()</title>
<indexterm><primary>gimp_offset_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_offset_area_new            (<link linkend="gint">gint</link> orig_width,
                                             <link linkend="gint">gint</link> orig_height);</programlisting>
<para>
Creates a new <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link> widget. A <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link> can be used
when resizing an image or a drawable to allow the user to interactively
specify the new offsets.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>orig_width</parameter>&nbsp;:</term>
<listitem><simpara> the original width
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>orig_height</parameter>&nbsp;:</term>
<listitem><simpara> the original height
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-offset-area-set-size" role="function"/>gimp_offset_area_set_size ()</title>
<indexterm><primary>gimp_offset_area_set_size</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_offset_area_set_size       (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
                                             <link linkend="gint">gint</link> width,
                                             <link linkend="gint">gint</link> height);</programlisting>
<para>
Sets the size of the image/drawable displayed by the <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
If the offsets change as a result of this change, the <link linkend="offsets-changed"><literal>offsets_changed</literal></link>
signal is emitted.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>offset_area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> the new width
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> the new height
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-offset-area-set-offsets" role="function"/>gimp_offset_area_set_offsets ()</title>
<indexterm><primary>gimp_offset_area_set_offsets</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_offset_area_set_offsets    (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
                                             <link linkend="gint">gint</link> offset_x,
                                             <link linkend="gint">gint</link> offset_y);</programlisting>
<para>
Sets the offsets of the image/drawable displayed by the <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
It does not emit the <link linkend="offsets-changed"><literal>offsets_changed</literal></link> signal.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>offset_area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset_x</parameter>&nbsp;:</term>
<listitem><simpara> the X offset
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offset_y</parameter>&nbsp;:</term>
<listitem><simpara> the Y offset
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-offset-area-set-pixbuf" role="function" condition="since:GIMP 2.2"/>gimp_offset_area_set_pixbuf ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_offset_area_set_pixbuf</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_offset_area_set_pixbuf     (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
                                             <link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
<para>
Sets the pixbuf which represents the original image/drawable which
is being offset.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>offset_area</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixbuf</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para>Since  GIMP 2.2
</para></refsect2>

</refsect1>

<refsect1 id="signals">
<title id="signals.title">Signal Details</title>
<refsect2><title><anchor id="GimpOffsetArea-offsets-changed"/>The &quot;offsets-changed&quot; signal</title>
<indexterm><primary>GimpOffsetArea::offsets-changed</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *gimpoffsetarea,
                                            <link linkend="gint">gint</link>            arg1,
                                            <link linkend="gint">gint</link>            arg2,
                                            <link linkend="gpointer">gpointer</link>        user_data)           : Run first</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>gimpoffsetarea</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
<listitem><simpara>

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>