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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpscrolledpreview.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:
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
 
5
 
<refentry id="libgimpwidgets-GimpScrolledPreview">
 
5
<refentry id="GimpScrolledPreview">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpScrolledPreview</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpScrolledPreview</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="GimpScrolledPreview">GimpScrolledPreview</link>;
 
25
                    <link linkend="GimpScrolledPreview-struct">GimpScrolledPreview</link>;
 
26
<link linkend="void">void</link>                <link linkend="gimp-scrolled-preview-set-position">gimp_scrolled_preview_set_position</link>  (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview,
 
27
                                                         <link linkend="gint">gint</link> x,
 
28
                                                         <link linkend="gint">gint</link> y);
 
29
<link linkend="void">void</link>                <link linkend="gimp-scrolled-preview-set-policy">gimp_scrolled_preview_set_policy</link>    (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview,
 
30
                                                         <link linkend="GtkPolicyType">GtkPolicyType</link> hscrollbar_policy,
 
31
                                                         <link linkend="GtkPolicyType">GtkPolicyType</link> vscrollbar_policy);
 
32
<link linkend="void">void</link>                <link linkend="gimp-scrolled-preview-freeze">gimp_scrolled_preview_freeze</link>        (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview);
 
33
<link linkend="void">void</link>                <link linkend="gimp-scrolled-preview-thaw">gimp_scrolled_preview_thaw</link>          (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview);
26
34
 
27
35
</synopsis>
28
36
</refsynopsisdiv>
29
37
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
<refsect1 id="desc">
39
 
<title id="desc.title">Description</title>
 
38
<refsect1 role="object_hierarchy">
 
39
<title role="object_hierarchy.title">Object Hierarchy</title>
 
40
<synopsis>
 
41
 
 
42
  <link linkend="GObject">GObject</link>
 
43
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
44
         +----<link linkend="GtkObject">GtkObject</link>
 
45
               +----<link linkend="GtkWidget">GtkWidget</link>
 
46
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
47
                           +----<link linkend="GtkBox">GtkBox</link>
 
48
                                 +----<link linkend="GtkVBox">GtkVBox</link>
 
49
                                       +----<link linkend="GimpPreview">GimpPreview</link>
 
50
                                             +----GimpScrolledPreview
 
51
</synopsis>
 
52
 
 
53
</refsect1>
 
54
 
 
55
 
 
56
 
 
57
<refsect1 role="impl_interfaces">
 
58
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
59
<para>
 
60
GimpScrolledPreview implements
 
61
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
62
 
 
63
</refsect1>
 
64
 
 
65
 
 
66
 
 
67
 
 
68
 
 
69
<refsect1 role="desc">
 
70
<title role="desc.title">Description</title>
40
71
<para>
41
72
A widget providing a <link linkend="GimpPreview"><type>GimpPreview</type></link> enhanced by scrolling capabilities.
42
73
</para>
43
74
</refsect1>
44
75
 
45
 
<refsect1 id="details">
46
 
<title id="details.title">Details</title>
47
 
<refsect2>
48
 
<title><anchor id="GimpScrolledPreview" role="struct"/>GimpScrolledPreview</title>
49
 
<indexterm><primary>GimpScrolledPreview</primary></indexterm><programlisting>typedef struct {
50
 
  GimpPreview   parent_instance;
51
 
} GimpScrolledPreview;
52
 
</programlisting>
53
 
<para>
54
 
 
 
76
<refsect1 role="details">
 
77
<title role="details.title">Details</title>
 
78
<refsect2>
 
79
<title><anchor id="GimpScrolledPreview-struct" role="struct"/>GimpScrolledPreview</title>
 
80
<indexterm><primary>GimpScrolledPreview</primary></indexterm><programlisting>typedef struct _GimpScrolledPreview GimpScrolledPreview;</programlisting>
 
81
<para>
 
82
 
 
83
</para></refsect2>
 
84
<refsect2>
 
85
<title><anchor id="gimp-scrolled-preview-set-position" role="function" condition="since:GIMP 2.4"/>gimp_scrolled_preview_set_position ()</title>
 
86
<indexterm role="GIMP 2.4"><primary>gimp_scrolled_preview_set_position</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_scrolled_preview_set_position  (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview,
 
87
                                                         <link linkend="gint">gint</link> x,
 
88
                                                         <link linkend="gint">gint</link> y);</programlisting>
 
89
<para>
 
90
</para>
 
91
<para>
 
92
 
 
93
</para><variablelist role="params">
 
94
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
95
<listitem><simpara> a <link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>
 
96
</simpara></listitem></varlistentry>
 
97
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
98
<listitem><simpara>       horizontal scroll offset
 
99
</simpara></listitem></varlistentry>
 
100
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
101
<listitem><simpara>       vertical scroll offset
 
102
</simpara></listitem></varlistentry>
 
103
</variablelist><para role="since">Since  GIMP 2.4
 
104
</para></refsect2>
 
105
<refsect2>
 
106
<title><anchor id="gimp-scrolled-preview-set-policy" role="function" condition="since:GIMP 2.4"/>gimp_scrolled_preview_set_policy ()</title>
 
107
<indexterm role="GIMP 2.4"><primary>gimp_scrolled_preview_set_policy</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_scrolled_preview_set_policy    (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview,
 
108
                                                         <link linkend="GtkPolicyType">GtkPolicyType</link> hscrollbar_policy,
 
109
                                                         <link linkend="GtkPolicyType">GtkPolicyType</link> vscrollbar_policy);</programlisting>
 
110
<para>
 
111
</para>
 
112
<para>
 
113
 
 
114
</para><variablelist role="params">
 
115
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
116
<listitem><simpara>           a <link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>
 
117
</simpara></listitem></varlistentry>
 
118
<varlistentry><term><parameter>hscrollbar_policy</parameter>&nbsp;:</term>
 
119
<listitem><simpara> policy for horizontal scrollbar
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><parameter>vscrollbar_policy</parameter>&nbsp;:</term>
 
122
<listitem><simpara> policy for vertical scrollbar
 
123
</simpara></listitem></varlistentry>
 
124
</variablelist><para role="since">Since  GIMP 2.4
 
125
</para></refsect2>
 
126
<refsect2>
 
127
<title><anchor id="gimp-scrolled-preview-freeze" role="function" condition="since:GIMP 2.4"/>gimp_scrolled_preview_freeze ()</title>
 
128
<indexterm role="GIMP 2.4"><primary>gimp_scrolled_preview_freeze</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_scrolled_preview_freeze        (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview);</programlisting>
 
129
<para>
 
130
While the <parameter>preview</parameter> is frozen, it is not going to redraw itself in
 
131
response to scroll events.
 
132
</para>
 
133
<para>
 
134
This function should only be used to implement widgets derived from
 
135
<link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>. There is no point in calling this from a plug-in.</para>
 
136
<para>
 
137
 
 
138
</para><variablelist role="params">
 
139
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
140
<listitem><simpara> a <link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>
 
141
</simpara></listitem></varlistentry>
 
142
</variablelist><para role="since">Since  GIMP 2.4
 
143
</para></refsect2>
 
144
<refsect2>
 
145
<title><anchor id="gimp-scrolled-preview-thaw" role="function" condition="since:GIMP 2.4"/>gimp_scrolled_preview_thaw ()</title>
 
146
<indexterm role="GIMP 2.4"><primary>gimp_scrolled_preview_thaw</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_scrolled_preview_thaw          (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview);</programlisting>
 
147
<para>
 
148
While the <parameter>preview</parameter> is frozen, it is not going to redraw itself in
 
149
response to scroll events.
 
150
</para>
 
151
<para>
 
152
This function should only be used to implement widgets derived from
 
153
<link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>. There is no point in calling this from a plug-in.</para>
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
 
157
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
158
<listitem><simpara> a <link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>
 
159
</simpara></listitem></varlistentry>
 
160
</variablelist><para role="since">Since  GIMP 2.4
55
161
</para></refsect2>
56
162
 
57
163
</refsect1>