MateMixerSwitch

typedef struct _MateMixerSwitch MateMixerSwitch;

The MateMixerSwitch structure contains only private data and should only be accessed using the provided API.

struct MateMixerSwitchClass

struct MateMixerSwitchClass {
    GObjectClass parent_class;
};

The class structure for MateMixerSwitch.

mate_mixer_switch_get_name ()

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.

mate_mixer_switch_get_label ()

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.

mate_mixer_switch_get_option ()

MateMixerSwitchOption * mate_mixer_switch_get_option    (MateMixerSwitch *swtch,
                                                         const gchar *name);

Gets the MateMixerSwitchOption with the given name.

mate_mixer_switch_list_options ()

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.

mate_mixer_switch_get_active_option ()

MateMixerSwitchOption * mate_mixer_switch_get_active_option
                                                        (MateMixerSwitch *swtch);

Gets the MateMixerSwitchOption which is currently active.

mate_mixer_switch_set_active_option ()

gboolean            mate_mixer_switch_set_active_option (MateMixerSwitch *swtch,
                                                         MateMixerSwitchOption *option);

Changes the currently active switch option.

The "active-option" property

  "active-option"            MateMixerSwitchOption*  : Read / Write / Construct Only

Active option of the switch.

The "label" property

  "label"                    gchar*                : Read / Write / Construct Only

Label of the switch.

Default value: NULL

The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

Name of the switch.

Default value: NULL