logo top
Main Page   Widgets   Namespaces   Book  

Gtk::Range Class Reference
[Widgets]

Inheritance diagram for Gtk::Range:

Inheritance graph
[legend]
List of all members.

Detailed Description

Base class for widgets which visualize an adjustment.


Public Member Functions

const Gtk::Adjustmentget_adjustment () const
 Get the Gtk::Adjustment which is the "model" object for Gtk::Range.
Gtk::Adjustmentget_adjustment ()
 Get the Gtk::Adjustment which is the "model" object for Gtk::Range.
bool get_inverted () const
 Gets the value set by set_inverted().
UpdateType get_update_policy () const
 Gets the update policy of range .
double get_value () const
 Gets the current value of the range.
const GtkRange* gobj () const
 Provides access to the underlying C GtkObject.
GtkRange* gobj ()
 Provides access to the underlying C GtkObject.
Glib::PropertyProxy_ReadOnly<
Adjustment* > 
property_adjustment () const
 The GtkAdjustment that contains the current value of this range object.
Glib::PropertyProxy<Adjustment*> property_adjustment ()
 The GtkAdjustment that contains the current value of this range object.
Glib::PropertyProxy_ReadOnly<
bool > 
property_inverted () const
 Invert direction slider moves to increase range value.
Glib::PropertyProxy<bool> property_inverted ()
 Invert direction slider moves to increase range value.
Glib::PropertyProxy_ReadOnly<
UpdateType
property_update_policy () const
 How the range should be updated on the screen.
Glib::PropertyProxy<UpdateTypeproperty_update_policy ()
 How the range should be updated on the screen.
void set_adjustment (Gtk::Adjustment& adjustment)
 Sets the adjustment to be used as the "model" object for this range widget.
void set_increments (double step, double page)
 Sets the step and page sizes for the range.
void set_inverted (bool setting=true)
 Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right.
void set_range (double min, double max)
 Sets the allowable values in the Gtk::Range, and clamps the range value to be between min and max .
void set_update_policy (UpdateType policy)
 Sets the update policy for the range.
void set_value (double value)
 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.
Glib::SignalProxy1< void,
double > 
signal_adjust_bounds ()
Glib::SignalProxy2< bool,
ScrollType, double > 
signal_change_value ()
 The change_value signal is emitted when a scroll action is performed on a range.
Glib::SignalProxy1< void,
ScrollType
signal_move_slider ()
Glib::SignalProxy0<void> signal_value_changed ()
void unset_adjustment ()
virtual ~Range ()

Protected Member Functions

virtual void get_range_border_vfunc (GtkBorder* border) const
virtual void on_adjust_bounds (double new_value)
virtual void on_move_slider (ScrollType scroll)
virtual void on_value_changed ()
 Range ()

Related Functions

(Note that these are not member functions.)

Gtk::Rangewrap (GtkRange* object, bool take_copy=false)


Constructor & Destructor Documentation

virtual Gtk::Range::~Range (  )  [virtual]
 

Gtk::Range::Range (  )  [protected]
 


Member Function Documentation

const Gtk::Adjustment* Gtk::Range::get_adjustment (  )  const
 

Get the Gtk::Adjustment which is the "model" object for Gtk::Range.

See set_adjustment() for details. The return value does not have a reference added, so should not be unreferenced.

Returns:
A Gtk::Adjustment.

Gtk::Adjustment* Gtk::Range::get_adjustment (  ) 
 

Get the Gtk::Adjustment which is the "model" object for Gtk::Range.

See set_adjustment() for details. The return value does not have a reference added, so should not be unreferenced.

Returns:
A Gtk::Adjustment.

bool Gtk::Range::get_inverted (  )  const
 

Gets the value set by set_inverted().

Returns:
true if the range is inverted.

virtual void Gtk::Range::get_range_border_vfunc ( GtkBorder*  border  )  const [protected, virtual]
 

UpdateType Gtk::Range::get_update_policy (  )  const
 

Gets the update policy of range .

See set_update_policy().

Returns:
The current update policy.

double Gtk::Range::get_value (  )  const
 

Gets the current value of the range.

Returns:
Current value of the range.

const GtkRange* Gtk::Range::gobj (  )  const [inline]
 

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Widget.

Reimplemented in Gtk::Scale, Gtk::VScale, Gtk::HScale, Gtk::Scrollbar, Gtk::VScrollbar, and Gtk::HScrollbar.

GtkRange* Gtk::Range::gobj (  )  [inline]
 

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Widget.

Reimplemented in Gtk::Scale, Gtk::VScale, Gtk::HScale, Gtk::Scrollbar, Gtk::VScrollbar, and Gtk::HScrollbar.

virtual void Gtk::Range::on_adjust_bounds ( double  new_value  )  [protected, virtual]
 

virtual void Gtk::Range::on_move_slider ( ScrollType  scroll  )  [protected, virtual]
 

virtual void Gtk::Range::on_value_changed (  )  [protected, virtual]
 

Glib::PropertyProxy_ReadOnly<Adjustment*> Gtk::Range::property_adjustment (  )  const
 

The GtkAdjustment that contains the current value of this range object.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Adjustment*> Gtk::Range::property_adjustment (  ) 
 

The GtkAdjustment that contains the current value of this range object.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Range::property_inverted (  )  const
 

Invert direction slider moves to increase range value.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Range::property_inverted (  ) 
 

Invert direction slider moves to increase range value.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<UpdateType> Gtk::Range::property_update_policy (  )  const
 

How the range should be updated on the screen.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<UpdateType> Gtk::Range::property_update_policy (  ) 
 

How the range should be updated on the screen.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

void Gtk::Range::set_adjustment ( Gtk::Adjustment adjustment  ) 
 

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::Scale and nonzero for Gtk::Scrollbar, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider.

Parameters:
adjustment A Gtk::Adjustment.

void Gtk::Range::set_increments ( double  step,
double  page
 

Sets the step and page sizes for the range.

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

Parameters:
step Step size.
page Page size.

void Gtk::Range::set_inverted ( bool  setting = true  ) 
 

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.

Parameters:
setting true to invert the range.

void Gtk::Range::set_range ( double  min,
double  max
 

Sets the allowable values in the Gtk::Range, 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.)

Parameters:
min Minimum range value.
max Maximum range value.

void Gtk::Range::set_update_policy ( UpdateType  policy  ) 
 

Sets the update policy for the range.

Gtk::UPDATE_CONTINUOUS means that anytime the range slider is moved, the range value will change and the value_changed signal will be emitted. Gtk::UPDATE_DELAYED means that the value will be updated after a brief timeout where no slider motion occurs, so updates are spaced by a short time rather than continuous. Gtk::UPDATE_DISCONTINUOUS means that the value will only be updated when the user releases the button and ends the slider drag operation.

Parameters:
policy Update policy.

void Gtk::Range::set_value ( double  value  ) 
 

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.

Parameters:
value New value of the range.

Glib::SignalProxy1<void,double> Gtk::Range::signal_adjust_bounds (  ) 
 

Glib::SignalProxy2<bool,ScrollType,double> Gtk::Range::signal_change_value (  ) 
 

The change_value signal is emitted when a scroll action is performed on a range.

It allows an application to determine the type of scroll event that occurred and the resultant new value. The application can handle the event itself and return true to prevent further processing. Or, by returning false, it can pass the event to other handlers until the default GTK+ handler is reached.

The value parameter is unrounded. An application that overrides the change_value signal is responsible for clamping the value to the desired number of decimal digits; the default handler clamps the value based on range->round_digits.

It is not possible to use delayed update policies in an overridden change_value handler.

Parameters:
scroll the type of scroll action that was performed.
new_value the new value resulting from the scroll action.
Returns:
true to prevent other handlers from being invoked for the signal, or false to propagate the signal further.

Glib::SignalProxy1<void,ScrollType> Gtk::Range::signal_move_slider (  ) 
 

Glib::SignalProxy0<void> Gtk::Range::signal_value_changed (  ) 
 

void Gtk::Range::unset_adjustment (  ) 
 


Friends And Related Function Documentation

Gtk::Range* wrap ( GtkRange*  object,
bool  take_copy = false
[related]
 

Parameters:
object The C instance
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:
Generated for gtkmm 2.4 by Doxygen 1.4.4 © 1997-2001