MateMixerSwitchOption

MateMixerSwitchOption

Synopsis

#include <libmatemixer/matemixer.h>

                    MateMixerSwitchOption;
struct              MateMixerSwitchOptionClass;
const gchar *       mate_mixer_switch_option_get_name   (MateMixerSwitchOption *option);
const gchar *       mate_mixer_switch_option_get_label  (MateMixerSwitchOption *option);
const gchar *       mate_mixer_switch_option_get_icon   (MateMixerSwitchOption *option);

Object Hierarchy

  GObject
   +----MateMixerSwitchOption

Properties

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

Description

Details

MateMixerSwitchOption

typedef struct _MateMixerSwitchOption MateMixerSwitchOption;

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


struct MateMixerSwitchOptionClass

struct MateMixerSwitchOptionClass {
    GObjectClass parent_class;
};

The class structure for MateMixerSwitchOption.

GObjectClass parent_class;

The parent class.

mate_mixer_switch_option_get_name ()

const gchar *       mate_mixer_switch_option_get_name   (MateMixerSwitchOption *option);

Gets the name of the switch option. The name serves as a unique identifier and in most cases it is not in a user-readable form.

The returned name is guaranteed to be unique across all the switch options of a particular MateMixerSwitch and may be used to get the MateMixerSwitchOption using mate_mixer_switch_get_option().

option :

a MateMixerSwitchOption

Returns :

the name of the switch option.

mate_mixer_switch_option_get_label ()

const gchar *       mate_mixer_switch_option_get_label  (MateMixerSwitchOption *option);

Gets the label of the switch option. This is a potentially translated string that should be presented to users in the user interface.

option :

a MateMixerSwitchOption

Returns :

the label of the switch option.

mate_mixer_switch_option_get_icon ()

const gchar *       mate_mixer_switch_option_get_icon   (MateMixerSwitchOption *option);

Gets the XDG icon name of the switch option.

option :

a MateMixerSwitchOption

Returns :

the icon name or NULL.

Property Details

The "icon" property

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

The XDG icon name of the switch option.

Default value: NULL


The "label" property

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

The label of the switch option. This is a potentially translated string that should be presented to users in the user interface.

Default value: NULL


The "name" property

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

The name of the switch option. The name serves as a unique identifier and in most cases it is not in a user-readable form.

Default value: NULL