GiwLed
GiwLed - A led widget


Synopsis

#include <giwled.h>                         GiwLed; GtkWidget*     giw_led_new                                        (void); void                 giw_led_set_mode                              (GiwLed *led, guint8 mode);    uint8                giw_led_get_mode                              (GiwLed *led);    void                 giw_led_set_colors                             (GiwLed *led, GdkColor on_color, GdkColor off_color); void                 giw_led_enable_mouse                       (GiwLed *led, gboolean option);

Object Hierarchy

GObject    +----GtkObject            +----GtkWidget                     +----GiwLed

Signal Prototypes

"mode_changed"   void         user_function      (GiwLed *led, gpointer user_data);

Description

GiwLed is a simple led, wich can be on or off.

Details

GiwLed

typedef struct GiwLed _GiwLed

The GiwLed struct contains private data only, and should be manipulated using the functions below.

---

giw_led_new()

GtkWidget*     giw_led_new                                       (void);

Creates a new led, with all default options.

Returns: a new led.

---

giw_led_set_mode()

void                 giw_led_set_mode                              (GiwLed *led, guint8 mode);

Sets the mode of te led (on or off).

led: A led.
mode: 0 for setting on, or a diferent value (1 generaly) for setting off.

---

giw_led_get_mode()

uint8                giw_led_get_mode                              (GiwLed *led);

Gets the mode of te led (on or off).

led: A led.
Returns: 0 if the mode is off, other to on.

---

giw_led_set_colors()

void                 giw_led_set_colors                             (GiwLed *led, GdkColor on_color, GdkColor off_color);

Sets the colors wich will be used for represent on of off modes. The fields red, green and blue of the GdkColor structure will be used.

led: A led.
on_color: Color used when the led is on.
off_color: Color used when the led is off.

---

giw_led_enable_mouse()

void                 giw_led_enable_mouse                       (GiwLed *led, gboolean option);

Enables or disables the option of using mouse to change the mode (by clicking in the led).

led: A led.
option: 0 for enable, other value to disable.

---

Signals

The "mode_changed" signal

void        user_function                  (GiwLed *led, gpointer user_data);

led: the object which received the signal.
user_data: user data set when the signal handler was connected.