HildonVolumebar

HildonVolumebar — Base class for widgets that display a volume bar

Synopsis




double      hildon_volumebar_get_level      (HildonVolumebar *self);
void        hildon_volumebar_set_level      (HildonVolumebar *self,
                                             gdouble level);
gboolean    hildon_volumebar_get_mute       (HildonVolumebar *self);
void        hildon_volumebar_set_mute       (HildonVolumebar *self,
                                             gboolean mute);
void        hildon_volumebar_level_change   (HildonVolumebar *self);
GtkAdjustment* hildon_volumebar_get_adjustment
                                            (HildonVolumebar *self);

Description

HildonVolumebar 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.

Details

hildon_volumebar_get_level ()

double      hildon_volumebar_get_level      (HildonVolumebar *self);

Gets the volume level of this HildonVolumebar.

self : volume bar to query level on
Returns : volume level or -1 on error

hildon_volumebar_set_level ()

void        hildon_volumebar_set_level      (HildonVolumebar *self,
                                             gdouble level);

Sets new volume level for this HildonVolumebar.

self : volume bar to change level on
level : new level

hildon_volumebar_get_mute ()

gboolean    hildon_volumebar_get_mute       (HildonVolumebar *self);

Gets mute status of this HildonVolumebar (ON/OFF).

self : volume bar to query mute status
Returns : Mute status as gboolean value.

hildon_volumebar_set_mute ()

void        hildon_volumebar_set_mute       (HildonVolumebar *self,
                                             gboolean mute);

Sets mute status for this HildonVolumebar.

self : volume bar to work on
mute : mute ON/OFF

hildon_volumebar_level_change ()

void        hildon_volumebar_level_change   (HildonVolumebar *self);

Emits "level_changed" signal to the given volume bar. This function is mainly used by derived classes.

self : a HildonVolumebar widget

hildon_volumebar_get_adjustment ()

GtkAdjustment* hildon_volumebar_get_adjustment
                                            (HildonVolumebar *self);

Gets the GtkAdjustment used in volume bar. This can be handy to give to hildon_appview_set_connected_adjustment which will allow changing the volume with increase / decrease hardware buttons.

This is a temporary solution until volume bar is restructured to be a child class of GtkRange.

self : a HildonVolumebar
Returns : a GtkAdjustment used by volume bar.

See Also

HildonHVolumebar, HildonVVolumebar