Maeomm Reference Documentation: hildon-libsmm
Main Page   Namespaces   Book  

Hildon::Controlbar Class Reference
[Widgets]

Inheritance diagram for Hildon::Controlbar:

Inheritance graph
[legend]
List of all members.

Detailed Description

Hildon::Controlbar is widget that allows increasing or decreasing a value within a pre-defined range.

It is a horizontally positioned range widget that is visually divided into blocks and supports setting a minimum and maximum value for the range.


Public Member Functions

 Controlbar ()
int get_max () const
int get_min () const
int get_value () const
const HildonControlbar* gobj () const
 Provides access to the underlying C GtkObject.
HildonControlbar* gobj ()
 Provides access to the underlying C GtkObject.
void set_max (int max)
 Set the control bar's maximum to the given value.
void set_min (int min)
 Set the control bar's minimum to the given value.
void set_range (int min, int max)
 Set the controlbars range to the given value.
void set_value (int value)
 Change the current value of the control bar to the specified value.
Glib::SignalProxy1< void,
bool > 
signal_end_reached ()
virtual ~Controlbar ()

Related Functions

(Note that these are not member functions.)

Hildon::Controlbarwrap (HildonControlbar* object, bool take_copy=false)


Constructor & Destructor Documentation

virtual Hildon::Controlbar::~Controlbar (  )  [virtual]
 

Hildon::Controlbar::Controlbar (  ) 
 


Member Function Documentation

int Hildon::Controlbar::get_max (  )  const
 

Returns:
Maximum value of control bar.

int Hildon::Controlbar::get_min (  )  const
 

Returns:
Minimum value of controlbar.

int Hildon::Controlbar::get_value (  )  const
 

Returns:
Current value as int.

Reimplemented from Gtk::Range.

const HildonControlbar* Hildon::Controlbar::gobj (  )  const [inline]
 

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Scale.

HildonControlbar* Hildon::Controlbar::gobj (  )  [inline]
 

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Scale.

void Hildon::Controlbar::set_max ( int  max  ) 
 

Set the control bar's maximum to the given value.

If the new maximum is smaller than current value, the value will be adjusted so that it equals the new maximum.

Parameters:
max Maximum value to set. The value needs to be greater than 0.

void Hildon::Controlbar::set_min ( int  min  ) 
 

Set the control bar's minimum to the given value.

If the new minimum is smaller than current value, the value will be adjusted so that it equals the new minimum.

Parameters:
min Minimum value to set. The value needs to be greater than or equal to 0.

void Hildon::Controlbar::set_range ( int  min,
int  max
 

Set the controlbars range to the given value.

If the new maximum is smaller than current value, the value will be adjusted so that it equals the new maximum.

If the new minimum is smaller than current value, the value will be adjusted so that it equals the new minimum.

Parameters:
max Maximum value to set. The value needs to be greater than 0.
min Minimum value to set. The value needs to be greater than or equal to 0.

void Hildon::Controlbar::set_value ( int  value  ) 
 

Change the current value of the control bar to the specified value.

Parameters:
value Value in range of >= 0 && < G_MAX_INT.

Glib::SignalProxy1<void,bool> Hildon::Controlbar::signal_end_reached (  ) 
 

Prototype:
void end_reached(bool end)


Friends And Related Function Documentation

Hildon::Controlbar* wrap ( HildonControlbar*  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 hildon-libsmm by Doxygen 1.4.2 © 1997-2001