← Back to branch summary

~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

Viewing changes to docs/reference/gtk/tmpl/gtkadjustment.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-05-04 12:24:25 UTC
  • mfrom: (1.1.21 upstream)
  • Revision ID: james.westby@ubuntu.com-20070504122425-0m8midgzrp40y8w2
Tags: 2.10.12-1ubuntu1
* Sync with Debian
* New upstream version:
  Fixed bugs:
  - 379414 file chooser warnings when changing path in the entry
  - 418585 GtkFileChooserDefault sizing code is not DPI independent
  - 419568 Crash in search if start with special letter
  - 435062 build dies with icon cache validation
  - 379399 Segfault to call gtk_print_operation_run twice.
  - 387889 cups backend has problems when there are too many printers
  - 418531 invalid read to gtkicontheme.c gtk_icon_theme_lookup_icon...
  - 423916 crash in color scheme code
  - 424042 Segmentation fault while quickly pressing Alt+arrows
  - 415260 Protect against negative indices when setting values in G...
  - 419171 XGetVisualInfo() may not set nxvisuals
  - 128852 Gdk cursors don't look good on win32
  - 344657 Ctrl-H doesn't toggle "Show Hidden Files" setting
  - 345345 PrintOperation::paginate is not emitted for class handler
  - 347567 GtkPrintOperation::end-print is not emitted if it's cance...
  - 369112 gtk_ui_manager_add_ui should accept unnamed separator
  - 392015 Selected menu item invisible on Windows Vista
  - 399253 MS-Windows Theme Bottom Tab placement rendering glitches
  - 399425 gtk_input_dialog_fill_axes() adds child to gtkscrolledwin...
  - 403251 [patch] little memory leak in GtkPrintJob
  - 403267 [patch] memory leak in GtkPageSetupUnixDialog
  - 403470 MS-Windows Theme tab placement other than on top leaks a ...
  - 404506 Windows system fonts that have multi-byte font names cann...
  - 405089 Incorrect window placement for GtkEventBox private window
  - 405515 Minor leak in gtkfilesystemmodel.c
  - 405539 gdk_pixbuf_save() for PNG saver can return FALSE without ...
  - 415681 gdk_window_clear_area includes an extra line and column o...
  - 418219 GtkRecentChooser should apply filter before sorting and c...
  - 418403 Scroll to printer after selecting it from settings
  - 421985 _gtk_print_operation_platform_backend_launch_preview
  - 421990 gtk_print_job_get_surface
  - 421993 gtk_print_operation_init
  - 423064 Conditional jump or move depends on uninitialised value(s...
  - 423722 Fix printing header in gtk-demo
  - 424168 gtk_print_operation_run on async preview
  - 425655 Don't install gtk+-unix-print-2.0.pc on non-UNIX platforms
  - 425786 GDK segfaults if XineramaQueryScreens fails
  - 428665 Lpr Backend gets stuck in infinite loop during gtk_enumer...
  - 429902 GtkPrintOperation leaks cairo contextes
  - 431997 First delay of GdkPixbufAnimationIter is wrong
  - 433242 Inconsistent scroll arrow position calculations
  - 433972 Placing gtk.Expander inside a gtk.TextView() changes gtk....
  - 434261 _gtk_toolbar_elide_underscores incorrectly handles some s...
  - 383354 ctrl-L should make 'Location' entry disappear
  - 418673 gtk_recent_manager_add_item
  - 429732 gtk_accel_group_finalize accesses invalid memory
  - 435028 WM_CLIENT_LEADER is wrong on the leader_window
  - 431067 Background of the header window is not updated
  - 338843 add recent files support inside the ui manager
  - 148535 add drop shadow to menus, tooltips, etc. under Windows XP
* debian/control.in:
  - Conflicts on ubuntulooks (<= 0.9.11-1)
* debian/patches/15_default-fallback-icon-theme.patch:
  - patch from Debian, fallback on gnome icon theme

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/tmpl/gtkadjustment.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
GtkAdjustment
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
A GtkObject representing an adjustable bounded value
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
The #GtkAdjustment object represents a value which has an associated lower
 
10
and upper bound, together with step and page increments, and a page size.
 
11
It is used within several GTK+ widgets, including
 
12
#GtkSpinButton, #GtkViewport, and #GtkRange (which is a base class for
 
13
#GtkHScrollbar, #GtkVScrollbar, #GtkHScale, and #GtkVScale).
 
14
</para>
 
15
<para>
 
16
The #GtkAdjustment object does not update the value itself. Instead
 
17
it is left up to the owner of the #GtkAdjustment to control the value.
 
18
</para>
 
19
<para>
 
20
The owner of the #GtkAdjustment typically calls the
 
21
gtk_adjustment_value_changed() and gtk_adjustment_changed() functions
 
22
after changing the value and its bounds. This results in the emission of the
 
23
&quot;value_changed&quot; or &quot;changed&quot; signal respectively.
 
24
</para>
 
25
 
 
26
<!-- ##### SECTION See_Also ##### -->
 
27
<para>
 
28
 
 
29
</para>
 
30
 
 
31
<!-- ##### SECTION Stability_Level ##### -->
 
32
 
 
33
 
 
34
<!-- ##### STRUCT GtkAdjustment ##### -->
 
35
<para>
 
36
The #GtkAdjustment-struct struct contains the following fields.
 
37
 
 
38
<informaltable pgwide="1" frame="none" role="struct">
 
39
<tgroup cols="2"><colspec colwidth="2*"/><colspec colwidth="8*"/>
 
40
<tbody>
 
41
 
 
42
<row>
 
43
<entry>#gdouble lower;</entry>
 
44
<entry>the minimum value.</entry>
 
45
</row>
 
46
 
 
47
<row>
 
48
<entry>#gdouble upper;</entry>
 
49
<entry>the maximum value.</entry>
 
50
</row>
 
51
 
 
52
<row>
 
53
<entry>#gdouble value;</entry>
 
54
<entry>the current value.</entry>
 
55
</row>
 
56
 
 
57
<row>
 
58
<entry>#gdouble step_increment;</entry>
 
59
<entry>the increment to use to make minor changes to the value.
 
60
In a #GtkScrollbar this increment is used when the mouse is clicked on the
 
61
arrows at the top and bottom of the scrollbar, to scroll by a small amount.
 
62
</entry>
 
63
</row>
 
64
 
 
65
<row>
 
66
<entry>#gdouble page_increment;</entry>
 
67
<entry>the increment to use to make major changes to the value.
 
68
In a #GtkScrollbar this increment is used when the mouse is clicked in the
 
69
trough, to scroll by a large amount.
 
70
</entry>
 
71
</row>
 
72
 
 
73
<row>
 
74
<entry>#gdouble page_size;</entry>
 
75
<entry>the page size.
 
76
In a #GtkScrollbar this is the size of the area which is currently visible.
 
77
</entry>
 
78
</row>
 
79
 
 
80
</tbody></tgroup></informaltable>
 
81
 
 
82
</para>
 
83
 
 
84
 
 
85
<!-- ##### SIGNAL GtkAdjustment::changed ##### -->
 
86
<para>
 
87
Emitted when one or more of the #GtkAdjustment fields have been changed,
 
88
other than the value field.
 
89
</para>
 
90
 
 
91
@adjustment: the object which received the signal.
 
92
 
 
93
<!-- ##### SIGNAL GtkAdjustment::value-changed ##### -->
 
94
<para>
 
95
Emitted when the #GtkAdjustment value field has been changed.
 
96
</para>
 
97
 
 
98
@adjustment: the object which received the signal.
 
99
 
 
100
<!-- ##### ARG GtkAdjustment:lower ##### -->
 
101
<para>
 
102
 
 
103
</para>
 
104
 
 
105
<!-- ##### ARG GtkAdjustment:page-increment ##### -->
 
106
<para>
 
107
 
 
108
</para>
 
109
 
 
110
<!-- ##### ARG GtkAdjustment:page-size ##### -->
 
111
<para>
 
112
 
 
113
</para>
 
114
 
 
115
<!-- ##### ARG GtkAdjustment:step-increment ##### -->
 
116
<para>
 
117
 
 
118
</para>
 
119
 
 
120
<!-- ##### ARG GtkAdjustment:upper ##### -->
 
121
<para>
 
122
 
 
123
</para>
 
124
 
 
125
<!-- ##### ARG GtkAdjustment:value ##### -->
 
126
<para>
 
127
 
 
128
</para>
 
129
 
 
130
<!-- ##### FUNCTION gtk_adjustment_new ##### -->
 
131
<para>
 
132
Creates a new #GtkAdjustment.
 
133
</para>
 
134
 
 
135
@value: the initial value.
 
136
@lower: the minimum value.
 
137
@upper: the maximum value.
 
138
@step_increment: the step increment.
 
139
@page_increment: the page increment.
 
140
@page_size: the page size.
 
141
@Returns: a new #GtkAdjustment.
 
142
 
 
143
 
 
144
<!-- ##### FUNCTION gtk_adjustment_get_value ##### -->
 
145
<para>
 
146
 
 
147
</para>
 
148
 
 
149
@adjustment: 
 
150
@Returns: 
 
151
 
 
152
 
 
153
<!-- ##### FUNCTION gtk_adjustment_set_value ##### -->
 
154
<para>
 
155
Sets the #GtkAdjustment value. The value is clamped to lie between
 
156
<literal>adjustment-&gt;lower</literal> and
 
157
<literal>adjustment-&gt;upper</literal>.
 
158
</para>
 
159
<para>
 
160
Note that for adjustments which are used in a #GtkScrollbar, the effective
 
161
range of allowed values goes from <literal>adjustment-&gt;lower</literal> to
 
162
<literal>adjustment-&gt;upper - adjustment-&gt;page_size</literal>.
 
163
</para>
 
164
 
 
165
@adjustment: a #GtkAdjustment.
 
166
@value: the new value.
 
167
 
 
168
 
 
169
<!-- ##### FUNCTION gtk_adjustment_clamp_page ##### -->
 
170
<para>
 
171
Updates the #GtkAdjustment @value to ensure that the range between @lower
 
172
and @upper is in the current page (i.e. between @value and @value +
 
173
@page_size).
 
174
If the range is larger than the page size, then only the start of it will
 
175
be in the current page.
 
176
A &quot;changed&quot; signal will be emitted if the value is changed.
 
177
</para>
 
178
 
 
179
@adjustment: a #GtkAdjustment.
 
180
@lower: the lower value.
 
181
@upper: the upper value.
 
182
 
 
183
 
 
184
<!-- ##### FUNCTION gtk_adjustment_changed ##### -->
 
185
<para>
 
186
Emits a &quot;changed&quot; signal from the #GtkAdjustment.
 
187
This is typically called by the owner of the #GtkAdjustment after it has
 
188
changed any of the #GtkAdjustment fields other than the value.
 
189
</para>
 
190
 
 
191
@adjustment: a #GtkAdjustment
 
192
 
 
193
 
 
194
<!-- ##### FUNCTION gtk_adjustment_value_changed ##### -->
 
195
<para>
 
196
Emits a &quot;value_changed&quot; signal from the #GtkAdjustment.
 
197
This is typically called by the owner of the #GtkAdjustment after it has
 
198
changed the #GtkAdjustment value field.
 
199
</para>
 
200
 
 
201
@adjustment: a #GtkAdjustment
 
202
 
 
203