Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker GObject.InitiallyUnowned
Gtk.Adjustment

Class Gtk.Adjustment

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkAdjustment
Class :	Adjustment
Extends:	GObject.InitiallyUnowned

The GtkAdjustment object represents a value which has an associated lower
and upper bound, together with step and page increments, and a page size.
It is used within several GTK+ widgets, including
GtkSpinButton, GtkViewport, and GtkRange (which is a base class for
GtkHScrollbar, GtkVScrollbar, GtkHScale, and GtkVScale).
The GtkAdjustment object does not update the value itself. Instead
it is left up to the owner of the GtkAdjustment to control the value.
The owner of the GtkAdjustment typically calls the
gtk_adjustment_value_changed() and gtk_adjustment_changed() functions
after changing the value and its bounds. This results in the emission of the
GtkAdjustment::value_changed or GtkAdjustment::changed signal respectively.

Properties
Properties		Defined By
	g_type_instance : GObject.TypeInstance	GObject.InitiallyUnowned
	lower : gdouble The minimum value of the adjustment. The minimum value of the adjustment.	Gtk.Adjustment
	page_increment : gdouble The page increment of the adjustment. The page increment of the adjustment.	Gtk.Adjustment
	page_size : gdouble The page size of the adjustment. The page size of the adjustment. Note that the page-size is irrelevant and should be set to zero if the adjustment is used for a simple scalar value, e.g. in a GtkSpinButton.	Gtk.Adjustment
	parent_instance : GObject.InitiallyUnowned read only	Gtk.Adjustment
	priv : Gtk.AdjustmentPrivate read only	Gtk.Adjustment
	qdata : GLib.Data read only	GObject.InitiallyUnowned
	ref_count : guint32 read only	GObject.InitiallyUnowned
	step_increment : gdouble The step increment of the adjustment. The step increment of the adjustment.	Gtk.Adjustment
	upper : gdouble The maximum value of the adjustment. The maximum value of the adjustment. Note that values will be restricted by upper - page-size if the page-size property is nonzero.	Gtk.Adjustment
	value : gdouble The value of the adjustment. The value of the adjustment.	Gtk.Adjustment

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.Adjustment (Object *properties) Create a new Gtk.Adjustment Create a new Gtk.Adjustment Parameters: Object properties*
	new Gtk.Adjustment.c_new (gdouble *value, gdouble lower, gdouble upper, gdouble step_increment, gdouble page_increment, gdouble page_size) : Gtk.Adjustment Create a new Gtk.Adjustment Create a new Gtk.Adjustment Parameters: gdouble value* Required (not null) the initial value. gdouble lower Required (not null) the minimum value. gdouble upper Required (not null) the maximum value. gdouble step_increment Required (not null) the step increment. gdouble page_increment Required (not null) the page increment. gdouble page_size Required (not null) the page size. Returns: Gtk.Adjustment a new GtkAdjustment.
	changed () : none Emits a GtkAdjustment::changed signal from the GtkAdjustment. Emits a GtkAdjustment::changed signal from the GtkAdjustment. This is typically called by the owner of the GtkAdjustment after it has changed any of the GtkAdjustment fields other than the value. Returns: none	Gtk.Adjustment
	clamp_page (gdouble *lower, gdouble upper) : none Updates the GtkAdjustment* GtkAdjustment.value to ensure that the range between lower and upper is in the current page (i.e. Updates the GtkAdjustment GtkAdjustment.value to ensure that the range between lower and upper is in the current page (i.e. between GtkAdjustment.value and GtkAdjustment.value + GtkAdjustment.page_size). If the range is larger than the page size, then only the start of it will be in the current page. A GtkAdjustment::changed signal will be emitted if the value is changed. Parameters: gdouble lower Required (not null) the lower value. gdouble upper Required (not null) the upper value. Returns: none	Gtk.Adjustment
	configure (gdouble *value, gdouble lower, gdouble upper, gdouble step_increment, gdouble page_increment, gdouble page_size) : none Sets all properties of the adjustment at once. Sets all properties of the adjustment at once. Use this function to avoid multiple emissions of the "changed" signal. See gtk_adjustment_set_lower() for an alternative way of compressing multiple emissions of "changed" into one. Parameters: gdouble value* Required (not null) the new value gdouble lower Required (not null) the new minimum value gdouble upper Required (not null) the new maximum value gdouble step_increment Required (not null) the new step increment gdouble page_increment Required (not null) the new page increment gdouble page_size Required (not null) the new page size Returns: none	Gtk.Adjustment
	get_lower () : gdouble Retrieves the minimum value of the adjustment. Retrieves the minimum value of the adjustment. Returns: gdouble The current minimum value of the adjustment.	Gtk.Adjustment
	get_page_increment () : gdouble Retrieves the page increment of the adjustment. Retrieves the page increment of the adjustment. Returns: gdouble The current page increment of the adjustment.	Gtk.Adjustment
	get_page_size () : gdouble Retrieves the page size of the adjustment. Retrieves the page size of the adjustment. Returns: gdouble The current page size of the adjustment.	Gtk.Adjustment
	get_step_increment () : gdouble Retrieves the step increment of the adjustment. Retrieves the step increment of the adjustment. Returns: gdouble The current step increment of the adjustment.	Gtk.Adjustment
	get_upper () : gdouble Retrieves the maximum value of the adjustment. Retrieves the maximum value of the adjustment. Returns: gdouble The current maximum value of the adjustment.	Gtk.Adjustment
	get_value () : gdouble Gets the current value of the adjustment. Gets the current value of the adjustment. See gtk_adjustment_set_value (). Returns: gdouble The current value of the adjustment.	Gtk.Adjustment
	set_lower (gdouble *lower) : none Sets the minimum value of the adjustment. Sets the minimum value of the adjustment. When setting multiple adjustment properties via their individual setters, multiple "changed" signals will be emitted. However, since the emission of the "changed" signal is tied to the emission of the "GObject::notify" signals of the changed properties, it's possible to compress the "changed" signals into one by calling g_object_freeze_notify() and g_object_thaw_notify() around the calls to the individual setters. Alternatively, using a single g_object_set() for all the properties to change, or using gtk_adjustment_configure() has the same effect of compressing "changed" emissions. Parameters: gdouble lower* Required (not null) the new minimum value Returns: none	Gtk.Adjustment
	set_page_increment (gdouble *page_increment) : none Sets the page increment of the adjustment. Sets the page increment of the adjustment. See gtk_adjustment_set_lower() about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties. Parameters: gdouble page_increment* Required (not null) the new page increment Returns: none	Gtk.Adjustment
	set_page_size (gdouble *page_size) : none Sets the page size of the adjustment. Sets the page size of the adjustment. See gtk_adjustment_set_lower() about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties. Parameters: gdouble page_size* Required (not null) the new page size Returns: none	Gtk.Adjustment
	set_step_increment (gdouble *step_increment) : none Sets the step increment of the adjustment. Sets the step increment of the adjustment. See gtk_adjustment_set_lower() about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties. Parameters: gdouble step_increment* Required (not null) the new step increment Returns: none	Gtk.Adjustment
	set_upper (gdouble *upper) : none Sets the maximum value of the adjustment. Sets the maximum value of the adjustment. Note that values will be restricted by upper - page-size if the page-size property is nonzero. See gtk_adjustment_set_lower() about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties. Parameters: gdouble upper* Required (not null) the new maximum value Returns: none	Gtk.Adjustment
	set_value (gdouble *value) : none Sets the GtkAdjustment* value. Sets the GtkAdjustment value. The value is clamped to lie between GtkAdjustment.lower and GtkAdjustment.upper. Note that for adjustments which are used in a GtkScrollbar, the effective range of allowed values goes from GtkAdjustment.lower to GtkAdjustment.upper - GtkAdjustment.page_size. Parameters: gdouble value Required (not null) the new value. Returns: none	Gtk.Adjustment
	value_changed () : none Emits a GtkAdjustment::value_changed signal from the GtkAdjustment. Emits a GtkAdjustment::value_changed signal from the GtkAdjustment. This is typically called by the owner of the GtkAdjustment after it has changed the GtkAdjustment value field. Returns: none	Gtk.Adjustment

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	changed (Adjustment *self) : none Emitted when one or more of the GtkAdjustment* fields have been changed, other than the value field. Emitted when one or more of the GtkAdjustment fields have been changed, other than the value field. Parameters: Gtk.Adjustment self Returns: {none}	Gtk.Adjustment
	value_changed (Adjustment *self) : none Emitted when the GtkAdjustment* value field has been changed. Emitted when the GtkAdjustment value field has been changed. Parameters: Gtk.Adjustment self Returns: {none}	Gtk.Adjustment

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gtk.CellRendererSpin Property	adjustment : Gtk.Adjustment The adjustment that holds the value of the spinbutton.
Gtk.Container Method	get_focus_hadjustment () : Gtk.Adjustment Retrieves the horizontal focus adjustment for the container.
Gtk.Container Method	get_focus_vadjustment () : Gtk.Adjustment Retrieves the vertical focus adjustment for the container.
Gtk.Container Method	set_focus_hadjustment (Adjustment *adjustment*) : none Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget.
Gtk.Container Method	set_focus_vadjustment (Adjustment *adjustment*) : none Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget.
Gtk.Entry Method	get_cursor_hadjustment () : Gtk.Adjustment Retrieves the horizontal cursor adjustment for the entry.
Gtk.Entry Method	set_cursor_hadjustment (Adjustment *adjustment*) : none Hooks up an adjustment to the cursor position in an entry, so that when the cursor is moved, the adjustment is scrolled to show that position.
Gtk.HScale Method	new Gtk.HScale.c_new (Adjustment *adjustment*) : Gtk.Widget Create a new Gtk.HScale
Gtk.HScrollbar Method	new Gtk.HScrollbar.c_new (Adjustment *adjustment*) : Gtk.Widget Create a new Gtk.HScrollbar
Gtk.Layout Method	new Gtk.Layout.c_new (Adjustment *hadjustment, Adjustment vadjustment*) : Gtk.Widget Create a new Gtk.Layout
Gtk.Layout Method	get_hadjustment () : Gtk.Adjustment This function should only be called after the layout has been placed in a GtkScrolledWindow or otherwise configured for scrolling.
Gtk.Layout Method	get_vadjustment () : Gtk.Adjustment This function should only be called after the layout has been placed in a GtkScrolledWindow or otherwise configured for scrolling.
Gtk.Layout Method	set_hadjustment (Adjustment *adjustment*) : none Sets the horizontal scroll adjustment for the layout.
Gtk.Layout Method	set_vadjustment (Adjustment *adjustment*) : none Sets the vertical scroll adjustment for the layout.
Gtk.Range Property	adjustment : Gtk.Adjustment
Gtk.Range Method	get_adjustment () : Gtk.Adjustment Get the GtkAdjustment which is the "model" object for GtkRange.
Gtk.Range Method	set_adjustment (Adjustment *adjustment*) : none Sets the adjustment to be used as the "model" object for this range widget.
Gtk.Scale Method	new Gtk.Scale.c_new (Orientation *orientation, Adjustment adjustment*) : Gtk.Widget Create a new Gtk.Scale
Gtk.ScaleButton Property	adjustment : Gtk.Adjustment
Gtk.ScaleButton Method	get_adjustment () : Gtk.Adjustment Gets the GtkAdjustment associated with the GtkScaleButton's scale.
Gtk.ScaleButton Method	set_adjustment (Adjustment *adjustment) : none Sets the GtkAdjustment* to be used as a model for the GtkScaleButton's scale.
Gtk.Scrollable Property	hadjustment : Gtk.Adjustment Horizontal GtkAdjustment of the scrollable widget.
Gtk.Scrollable Property	vadjustment : Gtk.Adjustment Verical GtkAdjustment of the scrollable widget.
Gtk.Scrollable Method	get_hadjustment () : Gtk.Adjustment Retrieves the GtkAdjustment used for horizontal scrolling.
Gtk.Scrollable Method	get_vadjustment () : Gtk.Adjustment Retrieves the GtkAdjustment used for vertical scrolling.
Gtk.Scrollable Method	set_hadjustment (Adjustment *hadjustment) : none Sets the horizontal adjustment of the GtkScrollable*.
Gtk.Scrollable Method	set_vadjustment (Adjustment *vadjustment) : none Sets the vertical adjustment of the GtkScrollable*.
Gtk.Scrollbar Method	new Gtk.Scrollbar.c_new (Orientation *orientation, Adjustment adjustment*) : Gtk.Widget Create a new Gtk.Scrollbar
Gtk.ScrolledWindow Property	hadjustment : Gtk.Adjustment
Gtk.ScrolledWindow Property	vadjustment : Gtk.Adjustment
Gtk.ScrolledWindow Method	new Gtk.ScrolledWindow.c_new (Adjustment *hadjustment, Adjustment vadjustment*) : Gtk.Widget Create a new Gtk.ScrolledWindow
Gtk.ScrolledWindow Method	get_hadjustment () : Gtk.Adjustment Returns the horizontal scrollbar's adjustment, used to connect the horizontal scrollbar to the child widget's horizontal scroll functionality.
Gtk.ScrolledWindow Method	get_vadjustment () : Gtk.Adjustment Returns the vertical scrollbar's adjustment, used to connect the vertical scrollbar to the child widget's vertical scroll functionality.
Gtk.ScrolledWindow Method	set_hadjustment (Adjustment *hadjustment) : none Sets the GtkAdjustment* for the horizontal scrollbar.
Gtk.ScrolledWindow Method	set_vadjustment (Adjustment *vadjustment) : none Sets the GtkAdjustment* for the vertical scrollbar.
Gtk.SpinButton Property	adjustment : Gtk.Adjustment
Gtk.SpinButton Method	new Gtk.SpinButton.c_new (Adjustment *adjustment, gdouble climb_rate, guint32 digits*) : Gtk.Widget Create a new Gtk.SpinButton
Gtk.SpinButton Method	configure (Adjustment *adjustment, gdouble climb_rate, guint32 digits*) : none Changes the properties of an existing spin button.
Gtk.SpinButton Method	get_adjustment () : Gtk.Adjustment Get the adjustment associated with a GtkSpinButton
Gtk.SpinButton Method	set_adjustment (Adjustment *adjustment) : none Replaces the GtkAdjustment* associated with spin_button.
Gtk.TextView Method	get_hadjustment () : Gtk.Adjustment Gets the horizontal-scrolling GtkAdjustment.
Gtk.TextView Method	get_vadjustment () : Gtk.Adjustment Gets the vertical-scrolling GtkAdjustment.
Gtk.ToolPalette Method	get_hadjustment () : Gtk.Adjustment Gets the horizontal adjustment of the tool palette.
Gtk.ToolPalette Method	get_vadjustment () : Gtk.Adjustment Gets the vertical adjustment of the tool palette.
Gtk.TreeView Method	get_hadjustment () : Gtk.Adjustment Gets the GtkAdjustment currently being used for the horizontal aspect.
Gtk.TreeView Method	get_vadjustment () : Gtk.Adjustment Gets the GtkAdjustment currently being used for the vertical aspect.
Gtk.TreeView Method	set_hadjustment (Adjustment *adjustment) : none Sets the GtkAdjustment* for the current horizontal aspect.
Gtk.TreeView Method	set_vadjustment (Adjustment *adjustment) : none Sets the GtkAdjustment* for the current vertical aspect.
Gtk.VScale Method	new Gtk.VScale.c_new (Adjustment *adjustment*) : Gtk.Widget Create a new Gtk.VScale
Gtk.VScrollbar Method	new Gtk.VScrollbar.c_new (Adjustment *adjustment*) : Gtk.Widget Create a new Gtk.VScrollbar
Gtk.Viewport Method	new Gtk.Viewport.c_new (Adjustment *hadjustment, Adjustment vadjustment*) : Gtk.Widget Create a new Gtk.Viewport
Gtk.Viewport Method	get_hadjustment () : Gtk.Adjustment Returns the horizontal adjustment of the viewport.
Gtk.Viewport Method	get_vadjustment () : Gtk.Adjustment Returns the vertical adjustment of the viewport.
Gtk.Viewport Method	set_hadjustment (Adjustment *adjustment*) : none Sets the horizontal adjustment of the viewport.
Gtk.Viewport Method	set_vadjustment (Adjustment *adjustment*) : none Sets the vertical adjustment of the viewport.