~ubuntu-branches/ubuntu/karmic/gimp/karmic-updates

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-08-31 10:24:10 UTC
  • mfrom: (1.1.21 upstream) (0.1.5 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090831102410-eqawgw6fhdyi91ee
Tags: 2.6.7-1ubuntu1
* Merge with Debian unstable (LP: #419593), remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + updated some strings for ubuntu
  - debian/rules:
    + updated translation templates
  - debian/control:
    + Drop webkit build dependency. gimp is the only thing pulling in webkit
      for the desktop CDs, and makes them explode. Without the webkit help
      browser plugin, help will just be displayed in the default browser.
* debian/patches/01_debian-gimprc.patch:
  - Updated
* debian/control:
  - Added a BZR link

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
<refnamediv>
13
13
<refname>GimpScrolledPreview</refname>
14
14
<refpurpose>A widget providing a <link linkend="GimpPreview"><type>GimpPreview</type></link> enhanced by scrolling capabilities.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpScrolledPreview.synopsis" role="synopsis">
44
43
                                       +----<link linkend="GimpPreview">GimpPreview</link>
45
44
                                             +----GimpScrolledPreview
46
45
</synopsis>
47
 
 
48
46
</refsect1>
49
47
 
50
48
 
53
51
<title role="impl_interfaces.title">Implemented Interfaces</title>
54
52
<para>
55
53
GimpScrolledPreview implements
56
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
57
 
 
 
54
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
58
55
</refsect1>
59
56
 
60
57
 
72
69
<title role="details.title">Details</title>
73
70
<refsect2 id="GimpScrolledPreview-struct" role="struct">
74
71
<title>GimpScrolledPreview</title>
75
 
<indexterm zone="GimpScrolledPreview-struct"><primary>GimpScrolledPreview</primary></indexterm><programlisting>typedef struct _GimpScrolledPreview GimpScrolledPreview;</programlisting>
 
72
<indexterm zone="GimpScrolledPreview-struct"><primary sortas="GimpScrolledPreview">GimpScrolledPreview</primary></indexterm><programlisting>typedef struct _GimpScrolledPreview GimpScrolledPreview;</programlisting>
76
73
<para>
77
 
 
78
74
</para></refsect2>
79
75
<refsect2 id="gimp-scrolled-preview-set-position" role="function" condition="since:GIMP 2.4">
80
76
<title>gimp_scrolled_preview_set_position ()</title>
81
 
<indexterm zone="gimp-scrolled-preview-set-position" 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,
 
77
<indexterm zone="gimp-scrolled-preview-set-position" role="GIMP 2.4"><primary sortas="gimp_scrolled_preview_set_position">gimp_scrolled_preview_set_position</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_scrolled_preview_set_position  (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview,
82
78
                                                         <link linkend="gint">gint</link> x,
83
79
                                                         <link linkend="gint">gint</link> y);</programlisting>
84
80
<para>
85
81
</para>
86
82
<para>
87
 
 
88
83
</para><variablelist role="params">
89
 
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
84
<varlistentry><term><parameter>preview</parameter>&#160;:</term>
90
85
<listitem><simpara> a <link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>
91
86
</simpara></listitem></varlistentry>
92
 
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
87
<varlistentry><term><parameter>x</parameter>&#160;:</term>
93
88
<listitem><simpara>       horizontal scroll offset
94
89
</simpara></listitem></varlistentry>
95
 
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
90
<varlistentry><term><parameter>y</parameter>&#160;:</term>
96
91
<listitem><simpara>       vertical scroll offset
97
92
</simpara></listitem></varlistentry>
98
 
</variablelist><para role="since">Since  GIMP 2.4
99
 
</para></refsect2>
 
93
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
100
94
<refsect2 id="gimp-scrolled-preview-set-policy" role="function" condition="since:GIMP 2.4">
101
95
<title>gimp_scrolled_preview_set_policy ()</title>
102
 
<indexterm zone="gimp-scrolled-preview-set-policy" 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,
 
96
<indexterm zone="gimp-scrolled-preview-set-policy" role="GIMP 2.4"><primary sortas="gimp_scrolled_preview_set_policy">gimp_scrolled_preview_set_policy</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_scrolled_preview_set_policy    (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview,
103
97
                                                         <link linkend="GtkPolicyType">GtkPolicyType</link> hscrollbar_policy,
104
98
                                                         <link linkend="GtkPolicyType">GtkPolicyType</link> vscrollbar_policy);</programlisting>
105
99
<para>
106
100
</para>
107
101
<para>
108
 
 
109
102
</para><variablelist role="params">
110
 
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
103
<varlistentry><term><parameter>preview</parameter>&#160;:</term>
111
104
<listitem><simpara>           a <link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>
112
105
</simpara></listitem></varlistentry>
113
 
<varlistentry><term><parameter>hscrollbar_policy</parameter>&nbsp;:</term>
 
106
<varlistentry><term><parameter>hscrollbar_policy</parameter>&#160;:</term>
114
107
<listitem><simpara> policy for horizontal scrollbar
115
108
</simpara></listitem></varlistentry>
116
 
<varlistentry><term><parameter>vscrollbar_policy</parameter>&nbsp;:</term>
 
109
<varlistentry><term><parameter>vscrollbar_policy</parameter>&#160;:</term>
117
110
<listitem><simpara> policy for vertical scrollbar
118
111
</simpara></listitem></varlistentry>
119
 
</variablelist><para role="since">Since  GIMP 2.4
120
 
</para></refsect2>
 
112
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
121
113
<refsect2 id="gimp-scrolled-preview-freeze" role="function" condition="since:GIMP 2.4">
122
114
<title>gimp_scrolled_preview_freeze ()</title>
123
 
<indexterm zone="gimp-scrolled-preview-freeze" 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>
 
115
<indexterm zone="gimp-scrolled-preview-freeze" role="GIMP 2.4"><primary sortas="gimp_scrolled_preview_freeze">gimp_scrolled_preview_freeze</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_scrolled_preview_freeze        (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview);</programlisting>
124
116
<para>
125
117
While the <parameter>preview</parameter> is frozen, it is not going to redraw itself in
126
118
response to scroll events.
129
121
This function should only be used to implement widgets derived from
130
122
<link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>. There is no point in calling this from a plug-in.</para>
131
123
<para>
132
 
 
133
124
</para><variablelist role="params">
134
 
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
125
<varlistentry><term><parameter>preview</parameter>&#160;:</term>
135
126
<listitem><simpara> a <link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>
136
127
</simpara></listitem></varlistentry>
137
 
</variablelist><para role="since">Since  GIMP 2.4
138
 
</para></refsect2>
 
128
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
139
129
<refsect2 id="gimp-scrolled-preview-thaw" role="function" condition="since:GIMP 2.4">
140
130
<title>gimp_scrolled_preview_thaw ()</title>
141
 
<indexterm zone="gimp-scrolled-preview-thaw" 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>
 
131
<indexterm zone="gimp-scrolled-preview-thaw" role="GIMP 2.4"><primary sortas="gimp_scrolled_preview_thaw">gimp_scrolled_preview_thaw</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_scrolled_preview_thaw          (<link linkend="GimpScrolledPreview">GimpScrolledPreview</link> *preview);</programlisting>
142
132
<para>
143
133
While the <parameter>preview</parameter> is frozen, it is not going to redraw itself in
144
134
response to scroll events.
147
137
This function should only be used to implement widgets derived from
148
138
<link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>. There is no point in calling this from a plug-in.</para>
149
139
<para>
150
 
 
151
140
</para><variablelist role="params">
152
 
<varlistentry><term><parameter>preview</parameter>&nbsp;:</term>
 
141
<varlistentry><term><parameter>preview</parameter>&#160;:</term>
153
142
<listitem><simpara> a <link linkend="GimpScrolledPreview"><type>GimpScrolledPreview</type></link>
154
143
</simpara></listitem></varlistentry>
155
 
</variablelist><para role="since">Since  GIMP 2.4
156
 
</para></refsect2>
 
144
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
157
145
 
158
146
</refsect1>
159
147