← Back to branch summary

~ubuntu-branches/ubuntu/trusty/rgtk2/trusty

« back to all changes in this revision

Viewing changes to man/GtkRange.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2010-11-03 11:35:46 UTC
  • mfrom: (1.3.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20101103113546-a7fi7jdxdebp0tw1
Tags: 2.20.1-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/GtkRange.Rd
24
24
\code{\link{gtkRangeGetLowerStepperSensitivity}(object)}\cr
25
25
\code{\link{gtkRangeSetUpperStepperSensitivity}(object, sensitivity)}\cr
26
26
\code{\link{gtkRangeGetUpperStepperSensitivity}(object)}\cr
 
27
\code{\link{gtkRangeGetFlippable}(object)}\cr
 
28
\code{\link{gtkRangeSetFlippable}(object, flippable)}\cr
 
29
\code{\link{gtkRangeGetMinSliderSize}(object)}\cr
 
30
\code{\link{gtkRangeGetRangeRect}(object)}\cr
 
31
\code{\link{gtkRangeGetSliderRange}(object)}\cr
 
32
\code{\link{gtkRangeGetSliderSizeFixed}(object)}\cr
 
33
\code{\link{gtkRangeSetMinSliderSize}(object, min.size)}\cr
 
34
\code{\link{gtkRangeSetSliderSizeFixed}(object, size.fixed)}\cr
27
35
 
28
36
}
29
37
\section{Hierarchy}{\preformatted{GObject
34
42
                           +----GtkScale
35
43
                           +----GtkScrollbar}}
36
44
\section{Interfaces}{GtkRange implements
37
 
 AtkImplementorIface and  \verb{\link{GtkBuildable}}.}
38
 
\section{Detailed Description}{\verb{\link{GtkRange}} is the common base class for widgets which visualize an
39
 
adjustment, e.g scales or scrollbars. 
 
45
 AtkImplementorIface,  \code{\link{GtkBuildable}} and  \code{\link{GtkOrientable}}.}
 
46
\section{Detailed Description}{\code{\link{GtkRange}} is the common base class for widgets which visualize an
 
47
adjustment, e.g scales or scrollbars.
40
48
  
41
 
Apart from signals for monitoring the parameters of the adjustment, 
 
49
Apart from signals for monitoring the parameters of the adjustment,
42
50
GtkRange provides properties and methods for influencing the sensitivity
43
 
of the "steppers". It also provides properties and methods for setting a 
 
51
of the "steppers". It also provides properties and methods for setting a
44
52
"fill level" on range widgets. See \code{\link{gtkRangeSetFillLevel}}.}
45
53
\section{Structures}{\describe{\item{\verb{GtkRange}}{
46
54
\emph{undocumented
65
73
}
66
74
 
67
75
\describe{
68
 
\item{\code{range}}{[\verb{\link{GtkRange}}] the object which received the signal.}
69
 
\item{\code{arg1}}{[numeric] }
70
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
76
\item{\code{range}}{the object which received the signal.}
 
77
\item{\code{arg1}}{\emph{undocumented
 
78
}}
 
79
\item{\code{user.data}}{user data set when the signal handler was connected.}
71
80
}
72
81
 
73
82
 
83
92
  
84
93
The value parameter is unrounded.  An application that overrides
85
94
the ::change-value signal is responsible for clamping the value to
86
 
the desired number of decimal digits; the default GTK+ handler 
 
95
the desired number of decimal digits; the default GTK+ handler
87
96
clamps the value based on \code{range->round.digits}.
88
97
  
89
98
It is not possible to use delayed update policies in an overridden
90
 
::change-value handler.  
91
 
 
92
 
  Since  2.6
 
99
::change-value handler.
 
100
  Since 2.6
93
101
 
94
102
\describe{
95
 
\item{\code{range}}{[\verb{\link{GtkRange}}]  the range that received the signal}
96
 
\item{\code{scroll}}{[\code{\link{GtkScrollType}}]  the type of scroll action that was performed}
97
 
\item{\code{value}}{[numeric]  the new value resulting from the scroll action}
98
 
\item{\code{returns}}{[R object] \code{TRUE} to prevent other handlers from being invoked for the
 
103
\item{\code{range}}{the range that received the signal}
 
104
\item{\code{scroll}}{the type of scroll action that was performed}
 
105
\item{\code{value}}{the new value resulting from the scroll action}
 
106
\item{\code{returns}}{\code{TRUE} to prevent other handlers from being invoked for the
99
107
signal, \code{FALSE} to propagate the signal further}
100
108
\item{\code{user.data}}{user data set when the signal handler was connected.}
101
109
}
103
111
 
104
112
}
105
113
\item{\code{move-slider(range, step, user.data)}}{
106
 
Virtual function that moves the slider. Used for keybindings.  
 
114
Virtual function that moves the slider. Used for keybindings.
107
115
 
108
116
\describe{
109
 
\item{\code{range}}{[\verb{\link{GtkRange}}]  the \verb{\link{GtkRange}}}
110
 
\item{\code{step}}{[\code{\link{GtkScrollType}}]  how to move the slider}
111
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
117
\item{\code{range}}{the \code{\link{GtkRange}}}
 
118
\item{\code{step}}{how to move the slider}
 
119
\item{\code{user.data}}{user data set when the signal handler was connected.}
112
120
}
113
121
 
114
122
 
115
123
}
116
124
\item{\code{value-changed(range, user.data)}}{
117
 
Emitted when the range value changes.  
 
125
Emitted when the range value changes.
118
126
 
119
127
\describe{
120
 
\item{\code{range}}{[\verb{\link{GtkRange}}]  the \verb{\link{GtkRange}}}
121
 
\item{\code{user.data}}{[R object] user data set when the signal handler was connected.}
 
128
\item{\code{range}}{the \code{\link{GtkRange}}}
 
129
\item{\code{user.data}}{user data set when the signal handler was connected.}
122
130
}
123
131
 
124
132
 
125
133
}
126
134
}}
127
135
\section{Properties}{\describe{
128
 
\item{\verb{adjustment} [\verb{\link{GtkAdjustment}} : *        : Read / Write / Construct]}{
 
136
\item{\verb{adjustment} [\code{\link{GtkAdjustment}} : *        : Read / Write / Construct]}{
129
137
 
130
138
The GtkAdjustment that contains the current value of this range object.
131
139
 
133
141
\item{\verb{fill-level} [numeric : Read / Write]}{
134
142
 
135
143
The fill level (e.g. prebuffering of a network stream).
136
 
See \code{\link{gtkRangeSetFillLevel}}.  
137
 
 
138
 
  Default value: 1.79769e+308  Since  2.12
 
144
See \code{\link{gtkRangeSetFillLevel}}.
 
145
  Default value: 1.79769e+308  Since 2.12
139
146
 
140
147
}
141
148
\item{\verb{inverted} [logical : Read / Write]}{
152
159
 
153
160
The restrict-to-fill-level property controls whether slider
154
161
movement is restricted to an upper boundary set by the
155
 
fill level. See \code{\link{gtkRangeSetRestrictToFillLevel}}.  
156
 
 
157
 
  Default value: TRUE  Since  2.12
 
162
fill level. See \code{\link{gtkRangeSetRestrictToFillLevel}}.
 
163
  Default value: TRUE  Since 2.12
158
164
 
159
165
}
160
166
\item{\verb{show-fill-level} [logical : Read / Write]}{
161
167
 
162
168
The show-fill-level property controls whether fill level indicator
163
169
graphics are displayed on the trough. See
164
 
\code{\link{gtkRangeSetShowFillLevel}}.  
165
 
 
166
 
  Default value: FALSE  Since  2.12
 
170
\code{\link{gtkRangeSetShowFillLevel}}.
 
171
  Default value: FALSE  Since 2.12
167
172
 
168
173
}
169
174
\item{\verb{update-policy} [\code{\link{GtkUpdateType}} : Read / Write]}{
193
198
How far in the y direction to move the arrow when the button is depressed.  Default value: 0
194
199
 
195
200
}
 
201
\item{\verb{arrow-scaling} [numeric : Read]}{
 
202
 
 
203
The arrow size proportion relative to the scroll button size.
 
204
  Allowed values: [0,1]  Default value: 0.5  Since 2.14
 
205
 
 
206
}
196
207
\item{\verb{slider-width} [integer : Read]}{
197
208
 
198
209
Width of scrollbar or scale thumb.  Allowed values: >= 0  Default value: 14
208
219
The spacing between the stepper buttons and thumb. Note that
209
220
setting this value to anything > 0 will automatically set the
210
221
trough-under-steppers style property to \code{TRUE} as well. Also,
211
 
stepper-spacing won't have any effect if there are no steppers.  
212
 
 
 
222
stepper-spacing won't have any effect if there are no steppers.
213
223
  Allowed values: >= 0  Default value: 0
214
224
 
215
225
}
220
230
}
221
231
\item{\verb{trough-side-details} [logical : Read]}{
222
232
 
223
 
When \code{TRUE}, the parts of the trough on the two sides of the 
224
 
slider are drawn with different details.  
225
 
 
226
 
  Default value: FALSE  Since  2.10
 
233
When \code{TRUE}, the parts of the trough on the two sides of the
 
234
slider are drawn with different details.
 
235
  Default value: FALSE  Since 2.10
227
236
 
228
237
}
229
238
\item{\verb{trough-under-steppers} [logical : Read]}{
231
240
Whether to draw the trough across the full length of the range or
232
241
to exclude the steppers and their spacing. Note that setting the
233
242
\verb{"stepper-spacing"} style property to any value > 0 will
234
 
automatically enable trough-under-steppers too.  
235
 
 
236
 
  Default value: TRUE  Since  2.10
 
243
automatically enable trough-under-steppers too.
 
244
  Default value: TRUE  Since 2.10
237
245
 
238
246
}
239
247
}}
240
 
\references{\url{http://developer.gnome.org/doc/API/2.0/gtk/GtkRange.html}}
 
248
\references{\url{http://library.gnome.org/devel//gtk/GtkRange.html}}
241
249
\author{Derived by RGtkGen from GTK+ documentation}
242
250
\keyword{internal}