![]() |
![]() |
![]() |
libmatemixer Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <libmatemixer/matemixer.h> MateMixerSwitch; struct MateMixerSwitchClass; const gchar * mate_mixer_switch_get_name (MateMixerSwitch *swtch
); const gchar * mate_mixer_switch_get_label (MateMixerSwitch *swtch
); MateMixerSwitchOption * mate_mixer_switch_get_option (MateMixerSwitch *swtch
,const gchar *name
); const GList * mate_mixer_switch_list_options (MateMixerSwitch *swtch
); MateMixerSwitchOption * mate_mixer_switch_get_active_option (MateMixerSwitch *swtch
); gboolean mate_mixer_switch_set_active_option (MateMixerSwitch *swtch
,MateMixerSwitchOption *option
);
"active-option" MateMixerSwitchOption* : Read / Write / Construct Only "label" gchar* : Read / Write / Construct Only "name" gchar* : Read / Write / Construct Only
typedef struct _MateMixerSwitch MateMixerSwitch;
The MateMixerSwitch structure contains only private data and should only be accessed using the provided API.
struct MateMixerSwitchClass { GObjectClass parent_class; };
The class structure for MateMixerSwitch.
const gchar * mate_mixer_switch_get_name (MateMixerSwitch *swtch
);
Gets the name of the switch.
The name serves as a unique identifier and in most cases it is not in a user-readable form.
|
a MateMixerSwitch |
Returns : |
the name of the switch. |
const gchar * mate_mixer_switch_get_label (MateMixerSwitch *swtch
);
Gets the label of the switch.
This is a potentially translated string that should be presented to users in the user interface.
|
a MateMixerSwitch |
Returns : |
the label of the switch option. |
MateMixerSwitchOption * mate_mixer_switch_get_option (MateMixerSwitch *swtch
,const gchar *name
);
Gets the MateMixerSwitchOption with the given name.
|
a MateMixerSwitch |
|
the name of an option |
Returns : |
a MateMixerSwitchOption or NULL if there is no such switch option. |
const GList * mate_mixer_switch_list_options (MateMixerSwitch *swtch
);
Gets the list of switch options that belong to the switch.
The returned GList is owned by the MateMixerSwitch and may be invalidated at any time.
|
a MateMixerSwitch |
Returns : |
a GList of the switch options. |
MateMixerSwitchOption * mate_mixer_switch_get_active_option
(MateMixerSwitch *swtch
);
Gets the MateMixerSwitchOption which is currently active.
|
a MateMixerSwitch |
Returns : |
a MateMixerSwitchOption. |
gboolean mate_mixer_switch_set_active_option (MateMixerSwitch *swtch
,MateMixerSwitchOption *option
);
Changes the currently active switch option.
|
a MateMixerSwitch |
|
the MateMixerSwitchOption to set as the active option |
Returns : |
TRUE on success or FALSE on failure. |
"active-option"
property"active-option" MateMixerSwitchOption* : Read / Write / Construct Only
Active option of the switch.
"label"
property "label" gchar* : Read / Write / Construct Only
Label of the switch.
Default value: NULL