krähemann.com

AgsLed

AgsLed — A led widget

Stability Level

Stable, unless otherwise indicated

Functions

guint ags_led_get_segment_width ()
void ags_led_set_segment_width ()
guint ags_led_get_segment_height ()
void ags_led_set_segment_height ()
gboolean ags_led_is_active ()
void ags_led_set_active ()
AgsLed * ags_led_new ()
#define AGS_IS_LED()
#define AGS_IS_LED_CLASS()
#define AGS_LED()
#define AGS_LED_CLASS()
#define AGS_LED_GET_CLASS()
GType ags_led_get_type ()

Properties

guint segment-height Read / Write
guint segment-width Read / Write

Types and Values

#define AGS_LED_DEFAULT_SEGMENT_WIDTH
#define AGS_LED_DEFAULT_SEGMENT_HEIGHT
#define AGS_TYPE_LED
struct AgsLed
struct AgsLedClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── AgsLed

Implemented Interfaces

AgsLed implements GtkAccessible, GtkBuildable and GtkConstraintTarget.

Includes

#include <ags/widget/ags_led.h>

Description

AgsLed is a widget visualizing a gboolean value.

Functions

ags_led_get_segment_width ()

guint
ags_led_get_segment_width (AgsLed *led);

Get segment width.

Parameters

led

the AgsLed

  

Returns

the segment width

Since: 4.0.0

ags_led_set_segment_width ()

void
ags_led_set_segment_width (AgsLed *led,
                           guint segment_width);

Set segment width.

Parameters

led

the AgsLed

  

segment_width

the segment width

  

Since: 4.0.0

ags_led_get_segment_height ()

guint
ags_led_get_segment_height (AgsLed *led);

Get segment height.

Parameters

led

the AgsLed

  

Returns

the segment height

Since: 4.0.0

ags_led_set_segment_height ()

void
ags_led_set_segment_height (AgsLed *led,
                            guint segment_height);

Set segment height.

Parameters

led

the AgsLed

  

segment_height

the segment height

  

Since: 4.0.0

ags_led_is_active ()

gboolean
ags_led_is_active (AgsLed *led);

Set led to active state.

Parameters

led

the AgsLed

  

Returns

TRUE if led active, otherwise FALSE

Since: 3.2.0

ags_led_set_active ()

void
ags_led_set_active (AgsLed *led,
                    gboolean active);

Set led active by active .

Parameters

led

the AgsLed

  

active

TRUE if active, otherwise FALSE

  

Since: 3.0.0

ags_led_new ()

AgsLed *
ags_led_new (guint segment_width,
             guint segment_height);

Create a new instance of AgsLed.

Parameters

segment_width

the width of the segment

  

segment_height

the height of the segment

  

Returns

the new AgsLed

Since: 3.0.0

AGS_IS_LED()

#define AGS_IS_LED(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_LED))

AGS_IS_LED_CLASS()

#define AGS_IS_LED_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE((class), AGS_TYPE_LED))

AGS_LED()

#define AGS_LED(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_LED, AgsLed))

AGS_LED_CLASS()

#define AGS_LED_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_LED, AgsLedClass))

AGS_LED_GET_CLASS()

#define AGS_LED_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_LED, AgsLedClass))

ags_led_get_type ()

GType
ags_led_get_type (void);

Types and Values

AGS_LED_DEFAULT_SEGMENT_WIDTH

#define AGS_LED_DEFAULT_SEGMENT_WIDTH (12)

AGS_LED_DEFAULT_SEGMENT_HEIGHT

#define AGS_LED_DEFAULT_SEGMENT_HEIGHT (8)

AGS_TYPE_LED

#define AGS_TYPE_LED                (ags_led_get_type())

struct AgsLed

struct AgsLed;

struct AgsLedClass

struct AgsLedClass {
  GtkWidgetClass widget;
};

Property Details

The “segment-height” property

  “segment-height”           guint

The led's segment height.

Owner: AgsLed

Flags: Read / Write

Allowed values: >= 1

Default value: 8

Since: 4.0.0

The “segment-width” property

  “segment-width”            guint

The led's segment width.

Owner: AgsLed

Flags: Read / Write

Allowed values: >= 1

Default value: 12

Since: 4.0.0

Generated by GTK-Doc