NbtkGtkLightSwitch

NbtkGtkLightSwitch — a toggle switch between two states

Synopsis

                    NbtkGtkLightSwitch;
void                nbtk_gtk_light_switch_set_active    (NbtkGtkLightSwitch *lightswitch,
                                                         gboolean active);
gboolean            nbtk_gtk_light_switch_get_active    (NbtkGtkLightSwitch *lightswitch);
GtkWidget*          nbtk_gtk_light_switch_new           (void);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkDrawingArea
                           +----NbtkGtkLightSwitch

Implemented Interfaces

NbtkGtkLightSwitch implements AtkImplementorIface and GtkBuildable.

Signals

  "switch-flipped"                                 : Run First

Description

A visual representation of a toggle switch that can move between two states.

Details

NbtkGtkLightSwitch

typedef struct _NbtkGtkLightSwitch NbtkGtkLightSwitch;

The contents of this structure are private and should only be accessed through the public API.


nbtk_gtk_light_switch_set_active ()

void                nbtk_gtk_light_switch_set_active    (NbtkGtkLightSwitch *lightswitch,
                                                         gboolean active);

Set the value of the "active" property

lightswitch :

A NbtkGtkLightSwitch

active :

TRUE to set the switch to its ON state

nbtk_gtk_light_switch_get_active ()

gboolean            nbtk_gtk_light_switch_get_active    (NbtkGtkLightSwitch *lightswitch);

Get the value of the "active" property

lightswitch :

A NbtkGtkLightSwitch

Returns :

TRUE if the switch is "on"

nbtk_gtk_light_switch_new ()

GtkWidget*          nbtk_gtk_light_switch_new           (void);

Create a NbtkGtkLightSwitch

Returns :

a newly allocated NbtkGtkLightSwitch

Signal Details

The "switch-flipped" signal

void                user_function                      (NbtkGtkLightSwitch *nbtkgtklightswitch,
                                                        gboolean            arg1,
                                                        gpointer            user_data)               : Run First

nbtkgtklightswitch :

the object which received the signal.

arg1 :

user_data :

user data set when the signal handler was connected.