W Wrapl, The Programming Language

Libraries:Gtk:Gtk:Range

Types

T

Inherits from:

T is the common base class for widgets which visualize an adjustment, e.g scales or scrollbars.

Apart from signals for monitoring the parameters of the adjustment, GtkRange provides properties and methods for influencing the sensitivity of the "steppers". It also provides properties and methods for setting a "fill level" on range widgets. See SetFillLevel.



Constants

Nil : T

Functions

GetType() : Gtk.GObject.Type.T



Methods

:GetAdjustment(self @ T) : Gtk.Gtk.Adjustment.T

Get the Gtk.Gtk.Adjustment.T which is the "model" object for T. See SetAdjustment for details. The return value does not have a reference added, so should not be unreferenced.

range a T
Returns a Gtk.Gtk.Adjustment.T. [transfer none]


:GetFillLevel(self @ T) : Std.Real.T

Gets the current position of the fill level indicator.

range A T
Returns The current fill level


:GetFlippable(self @ T) : Std.Symbol.T

Gets the value set by SetFlippable.

range a T
Returns TRUE if the range is flippable


:GetInverted(self @ T) : Std.Symbol.T

Gets the value set by SetInverted.

range a T
Returns TRUE if the range is inverted


:GetLowerStepperSensitivity(self @ T) : Gtk.Gtk.SensitivityType.T

Gets the sensitivity policy for the stepper that points to the 'lower' end of the GtkRange's adjustment.

range a T
Returns The lower stepper's sensitivity policy.


:GetMinSliderSize(self @ T) : Std.Integer.SmallT

This function is useful mainly for T subclasses.

See SetMinSliderSize.

range a T
Returns The minimum size of the range's slider.


:GetRangeRect(self @ T, range_rect @ Gtk.Gdk.Rectangle.T) : Std.Object.T

This function returns the area that contains the range's trough and its steppers, in widget->window coordinates.

This function is useful mainly for T subclasses.

range a T
range_rect return location for the range rectangle. [out]


:GetRestrictToFillLevel(self @ T) : Std.Symbol.T

Gets whether the range is restricted to the fill level.

range A T
Returns TRUE if range is restricted to the fill level.


:GetShowFillLevel(self @ T) : Std.Symbol.T

Gets whether the range displays the fill level graphically.

range A T
Returns TRUE if range shows the fill level.


:GetSliderRange(self @ T, slider_start @ Std.Object.T, slider_end @ Std.Object.T) : Std.Object.T

This function returns sliders range along the long dimension, in widget->window coordinates.

This function is useful mainly for T subclasses.

range a T
slider_start return location for the slider's start, or NULL. [out][allow-none]
slider_end return location for the slider's end, or NULL. [out][allow-none]


:GetSliderSizeFixed(self @ T) : Std.Symbol.T

This function is useful mainly for T subclasses.

See SetSliderSizeFixed.

range a T
Returns whether the range's slider has a fixed size.


:GetUpdatePolicy(self @ T) : Gtk.Gtk.UpdateType.T

Warning

GetUpdatePolicy has been deprecated since version 2.24 and should not be used in newly-written code. There is no replacement. If you require delayed updates, you need to code it yourself.



:GetUpperStepperSensitivity(self @ T) : Gtk.Gtk.SensitivityType.T

Gets the sensitivity policy for the stepper that points to the 'upper' end of the GtkRange's adjustment.

range a T
Returns The upper stepper's sensitivity policy.


:GetValue(self @ T) : Std.Real.T

Gets the current value of the range.

range a T
Returns current value of the range.


:SetAdjustment(self @ T, adjustment @ Gtk.Gtk.Adjustment.T) : Std.Object.T

Sets the adjustment to be used as the "model" object for this range widget. The adjustment indicates the current range value, the minimum and maximum range values, the step/page increments used for keybindings and scrolling, and the page size. The page size is normally 0 for Gtk.Gtk.Scale.T and nonzero for Gtk.Gtk.Scrollbar.T, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider.

range a T
adjustment a Gtk.Gtk.Adjustment.T


:SetFillLevel(self @ T, fill_level @ Std.Real.T) : Std.Object.T

Set the new position of the fill level indicator.

The "fill level" is probably best described by its most prominent use case, which is an indicator for the amount of pre-buffering in a streaming media player. In that use case, the value of the range would indicate the current play position, and the fill level would be the position up to which the file/stream has been downloaded.

This amount of prebuffering can be displayed on the range's trough and is themeable separately from the trough. To enable fill level display, use SetShowFillLevel. The range defaults to not showing the fill level.

Additionally, it's possible to restrict the range's slider position to values which are smaller than the fill level. This is controller by SetRestrictToFillLevel and is by default enabled.

range a T
fill_level the new position of the fill level indicator


:SetFlippable(self @ T, flippable @ Std.Symbol.T) : Std.Object.T

If a range is flippable, it will switch its direction if it is horizontal and its direction is Gtk.Gtk.TextDirection.Rtl.

See Gtk.Gtk.Widget.GetDirection.

range a T
flippable TRUE to make the range flippable


:SetIncrements(self @ T, step @ Std.Real.T, page @ Std.Real.T) : Std.Object.T

Sets the step and page sizes for the range. The step size is used when the user clicks the Gtk.Gtk.Scrollbar.T arrows or moves Gtk.Gtk.Scale.T via arrow keys. The page size is used for example when moving via Page Up or Page Down keys.

range a T
step step size
page page size


:SetInverted(self @ T, setting @ Std.Symbol.T) : Std.Object.T

Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right. Inverted ranges have higher values at the top or on the right rather than on the bottom or left.

range a T
setting TRUE to invert the range


:SetLowerStepperSensitivity(self @ T, sensitivity @ Gtk.Gtk.SensitivityType.T) : Std.Object.T

Sets the sensitivity policy for the stepper that points to the 'lower' end of the GtkRange's adjustment.

range a T
sensitivity the lower stepper's sensitivity policy.


:SetMinSliderSize(self @ T, min_size @ Std.Symbol.T) : Std.Object.T

Sets the minimum size of the range's slider.

This function is useful mainly for T subclasses.

range a T
min_size The slider's minimum size


:SetRange(self @ T, min @ Std.Real.T, max @ Std.Real.T) : Std.Object.T

Sets the allowable values in the T, and clamps the range value to be between min and max. (If the range has a non-zero page size, it is clamped between min and max - page-size.)

range a T
min minimum range value
max maximum range value


:SetRestrictToFillLevel(self @ T, restrict_to_fill_level @ Std.Symbol.T) : Std.Object.T

Sets whether the slider is restricted to the fill level. See SetFillLevel for a general description of the fill level concept.

range A T
restrict_to_fill_level Whether the fill level restricts slider movement.


:SetShowFillLevel(self @ T, show_fill_level @ Std.Symbol.T) : Std.Object.T

Sets whether a graphical fill level is show on the trough. See SetFillLevel for a general description of the fill level concept.

range A T
show_fill_level Whether a fill level indicator graphics is shown.


:SetSliderSizeFixed(self @ T, size_fixed @ Std.Symbol.T) : Std.Object.T

Sets whether the range's slider has a fixed size, or a size that depends on it's adjustment's page size.

This function is useful mainly for T subclasses.

range a T
size_fixed TRUE to make the slider size constant


:SetUpdatePolicy(self @ T, policy @ Gtk.Gtk.UpdateType.T) : Std.Object.T

Warning

SetUpdatePolicy has been deprecated since version 2.24 and should not be used in newly-written code. There is no replacement. If you require delayed updates, you need to code it yourself.



:SetUpperStepperSensitivity(self @ T, sensitivity @ Gtk.Gtk.SensitivityType.T) : Std.Object.T

Sets the sensitivity policy for the stepper that points to the 'upper' end of the GtkRange's adjustment.

range a T
sensitivity the upper stepper's sensitivity policy.


:SetValue(self @ T, value @ Std.Real.T) : Std.Object.T

Sets the current value of the range; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The range emits the "value-changed" signal if the value changes.

range a T
value new value of the range