Maeomm Reference Documentation: hildonsmm
Main Page   Namespaces   Book  

Hildon::Volumebar Class Reference
[Widgets]

Inheritance diagram for Hildon::Volumebar:

Gtk::Container Gtk::Widget Gtk::Object Atk::Implementor Glib::Object Glib::Interface Glib::ObjectBase Glib::ObjectBase sigc::trackable sigc::trackable Hildon::HVolumebar Hildon::VVolumebar List of all members.

Detailed Description

Hildon::Volumebar is a base class for widgets that display a volume bar that allows increasing or decreasing volume within a predefined range, and muting the volume when users click the mute icon.


Public Member Functions

const Gtk::Adjustmentget_adjustment () const
 Gets the GtkAdjustment used in volume bar.
Gtk::Adjustmentget_adjustment ()
 Gets the GtkAdjustment used in volume bar.
double get_level () const
 Gets the volume level of this Hildon::Volumebar.
bool get_mute () const
 Gets mute status of this Hildon::Volumebar (ON/OFF).
const HildonVolumebar* gobj () const
 Provides access to the underlying C GtkObject.
HildonVolumebar* gobj ()
 Provides access to the underlying C GtkObject.
void set_level (double level)
 Sets new volume level for this Hildon::Volumebar.
void set_mute (bool mute=true)
 Sets mute status for this Hildon::Volumebar.
Glib::SignalProxy0<void> signal_level_changed ()
 
Prototype:
void level_changed()

Glib::SignalProxy0<void> signal_mute_toggled ()
 
Prototype:
void mute_toggled()

 Volumebar ()
virtual ~Volumebar ()

Related Functions

(Note that these are not member functions.)

Hildon::Volumebarwrap (HildonVolumebar* object, bool take_copy=false)
 
Parameters:
object The C instance


Constructor & Destructor Documentation

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

Hildon::Volumebar::Volumebar (  ) 


Member Function Documentation

const Gtk::Adjustment* Hildon::Volumebar::get_adjustment (  )  const

Gets the GtkAdjustment used in volume bar.

This can be handy to pass to hildon_appview_set_connected_adjustment which will allow changing the volume with 'increase' / 'decrease' hardware buttons.

Returns:
A Gtk::Adjustment used by volume bar.

Gtk::Adjustment* Hildon::Volumebar::get_adjustment (  ) 

Gets the GtkAdjustment used in volume bar.

This can be handy to pass to hildon_appview_set_connected_adjustment which will allow changing the volume with 'increase' / 'decrease' hardware buttons.

Returns:
A Gtk::Adjustment used by volume bar.

double Hildon::Volumebar::get_level (  )  const

Gets the volume level of this Hildon::Volumebar.

Returns:
Volume level or -1 on error.

bool Hildon::Volumebar::get_mute (  )  const

Gets mute status of this Hildon::Volumebar (ON/OFF).

Returns:
Mute status as bool value.

const HildonVolumebar* Hildon::Volumebar::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Container.

Reimplemented in Hildon::HVolumebar, and Hildon::VVolumebar.

HildonVolumebar* Hildon::Volumebar::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Container.

Reimplemented in Hildon::HVolumebar, and Hildon::VVolumebar.

void Hildon::Volumebar::set_level ( double  level  ) 

Sets new volume level for this Hildon::Volumebar.

Parameters:
level New level.

void Hildon::Volumebar::set_mute ( bool  mute = true  ) 

Sets mute status for this Hildon::Volumebar.

Parameters:
mute Mute ON/OFF.

Glib::SignalProxy0< void > Hildon::Volumebar::signal_level_changed (  ) 

Prototype:
void level_changed()

Glib::SignalProxy0< void > Hildon::Volumebar::signal_mute_toggled (  ) 

Prototype:
void mute_toggled()


Friends And Related Function Documentation

Hildon::Volumebar* wrap ( HildonVolumebar *  object,
bool  take_copy = false 
) [related]

Parameters:
object The C instance

Parameters:
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 hildonmm by Doxygen 1.5.1 © 1997-2001