AgsScale

AgsScale — A scale widget

Functions

void ags_scale_set_scale_width ()
guint ags_scale_get_scale_width ()
void ags_scale_set_scale_height ()
guint ags_scale_get_scale_height ()
void ags_scale_set_control_name ()
gchar * ags_scale_get_control_name ()
void ags_scale_set_upper ()
gdouble ags_scale_get_upper ()
void ags_scale_set_lower ()
gdouble ags_scale_get_lower ()
void ags_scale_set_default_value ()
gdouble ags_scale_get_default_value ()
void ags_scale_value_changed ()
AgsScale * ags_scale_new ()
#define AGS_IS_SCALE()
#define AGS_IS_SCALE_CLASS()
#define AGS_SCALE()
#define AGS_SCALE_CLASS()
#define AGS_SCALE_GET_CLASS()
GType ags_scale_get_type ()

Properties

gchar * control-name Read / Write
gdouble default-value Read / Write
gdouble lower Read / Write
guint scale-height Read / Write
guint scale-width Read / Write
gdouble upper Read / Write

Signals

void value-changed Run Last

Types and Values

#define AGS_SCALE_DEFAULT_SCALE_WIDTH
#define AGS_SCALE_DEFAULT_SCALE_HEIGHT
#define AGS_SCALE_DEFAULT_LOWER
#define AGS_SCALE_DEFAULT_UPPER
#define AGS_SCALE_DEFAULT_VALUE
#define AGS_SCALE_DEFAULT_STEP_COUNT
#define AGS_SCALE_DEFAULT_PAGE_SIZE
enum AgsScaleFlags
enum AgsScaleButtonState
enum AgsScaleKeyMask
enum AgsScaleLayout
enum AgsScaleAction
#define AGS_TYPE_SCALE
struct AgsScale
struct AgsScaleClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── AgsScale

Implemented Interfaces

AgsScale implements AtkImplementorIface and GtkBuildable.

Includes

#include <ags/widget/ags_scale.h>

Description

AgsScale is a widget that shows you a meter.

Functions

ags_scale_set_scale_width ()

void
ags_scale_set_scale_width (AgsScale *scale,
                           guint scale_width);

Set scale_width of scale .

Parameters

scale

the AgsScale

  

scale_width

the scale width

  

Since: 3.2.2

ags_scale_get_scale_width ()

guint
ags_scale_get_scale_width (AgsScale *scale);

Get scale width of scale .

Parameters

scale

the AgsScale

  

Returns

the scale width

Since: 3.2.2

ags_scale_set_scale_height ()

void
ags_scale_set_scale_height (AgsScale *scale,
                            guint scale_height);

Set scale_height of scale .

Parameters

scale

the AgsScale

  

scale_height

the scale height

  

Since: 3.2.2

ags_scale_get_scale_height ()

guint
ags_scale_get_scale_height (AgsScale *scale);

Get scale height of scale .

Parameters

scale

the AgsScale

  

Returns

the scale height

Since: 3.2.2

ags_scale_set_control_name ()

void
ags_scale_set_control_name (AgsScale *scale,
                            gchar *control_name);

Set control_name of scale .

Parameters

scale

the AgsScale

  

control_name

the scale height

  

Since: 3.2.2

ags_scale_get_control_name ()

gchar *
ags_scale_get_control_name (AgsScale *scale);

Get scale height of scale .

Parameters

scale

the AgsScale

  

Returns

the scale height

Since: 3.2.2

ags_scale_set_upper ()

void
ags_scale_set_upper (AgsScale *scale,
                     gdouble upper);

Set upper of scale .

Parameters

scale

the AgsScale

  

upper

the upper

  

Since: 3.2.2

ags_scale_get_upper ()

gdouble
ags_scale_get_upper (AgsScale *scale);

Get upper of scale .

Parameters

scale

the AgsScale

  

Returns

the upper

Since: 3.2.2

ags_scale_set_lower ()

void
ags_scale_set_lower (AgsScale *scale,
                     gdouble lower);

Set lower of scale .

Parameters

scale

the AgsScale

  

lower

the lower

  

Since: 3.2.2

ags_scale_get_lower ()

gdouble
ags_scale_get_lower (AgsScale *scale);

Get lower of scale .

Parameters

scale

the AgsScale

  

Returns

the lower

Since: 3.2.2

ags_scale_set_default_value ()

void
ags_scale_set_default_value (AgsScale *scale,
                             gdouble default_value);

Set default_value of scale .

Parameters

scale

the AgsScale

  

default_value

the normalized volume

  

Since: 3.2.2

ags_scale_get_default_value ()

gdouble
ags_scale_get_default_value (AgsScale *scale);

Get normalized volume of scale .

Parameters

scale

the AgsScale

  

Returns

the normalized volume

Since: 3.2.2

ags_scale_value_changed ()

void
ags_scale_value_changed (AgsScale *scale,
                         gdouble default_value);

Emits ::value-changed event.

Parameters

scale

the AgsScale

  

default_value

the default value

  

Since: 3.0.0

ags_scale_new ()

AgsScale *
ags_scale_new ();

Create a new instance of AgsScale.

Returns

the new AgsScale instance

Since: 3.0.0

AGS_IS_SCALE()

#define AGS_IS_SCALE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_SCALE))

AGS_IS_SCALE_CLASS()

#define AGS_IS_SCALE_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_SCALE))

AGS_SCALE()

#define AGS_SCALE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_SCALE, AgsScale))

AGS_SCALE_CLASS()

#define AGS_SCALE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_SCALE, AgsScaleClass))

AGS_SCALE_GET_CLASS()

#define AGS_SCALE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS (obj, AGS_TYPE_SCALE, AgsScaleClass))

ags_scale_get_type ()

GType
ags_scale_get_type (void);

Types and Values

AGS_SCALE_DEFAULT_SCALE_WIDTH

#define AGS_SCALE_DEFAULT_SCALE_WIDTH (60)

AGS_SCALE_DEFAULT_SCALE_HEIGHT

#define AGS_SCALE_DEFAULT_SCALE_HEIGHT (128)

AGS_SCALE_DEFAULT_LOWER

#define AGS_SCALE_DEFAULT_LOWER (0.0)

AGS_SCALE_DEFAULT_UPPER

#define AGS_SCALE_DEFAULT_UPPER (1.0)

AGS_SCALE_DEFAULT_VALUE

#define AGS_SCALE_DEFAULT_VALUE (0.0)

AGS_SCALE_DEFAULT_STEP_COUNT

#define AGS_SCALE_DEFAULT_STEP_COUNT (16.0)

AGS_SCALE_DEFAULT_PAGE_SIZE

#define AGS_SCALE_DEFAULT_PAGE_SIZE (8.0)

enum AgsScaleFlags

Members

AGS_SCALE_LOGARITHMIC

    

enum AgsScaleButtonState

Members

AGS_SCALE_BUTTON_1_PRESSED

    

enum AgsScaleKeyMask

Members

AGS_SCALE_KEY_L_CONTROL

    

AGS_SCALE_KEY_R_CONTROL

    

AGS_SCALE_KEY_L_SHIFT

    

AGS_SCALE_KEY_R_SHIFT

    

enum AgsScaleLayout

Members

AGS_SCALE_LAYOUT_VERTICAL

    

AGS_SCALE_LAYOUT_HORIZONTAL

    

enum AgsScaleAction

Members

AGS_SCALE_STEP_UP

    

AGS_SCALE_STEP_DOWN

    

AGS_SCALE_PAGE_UP

    

AGS_SCALE_PAGE_DOWN

    

AGS_TYPE_SCALE

#define AGS_TYPE_SCALE                (ags_scale_get_type())

struct AgsScale

struct AgsScale;

struct AgsScaleClass

struct AgsScaleClass {
  GtkWidgetClass widget;

  void (*value_changed)(AgsScale *scale,
			gdouble default_value);
};

Property Details

The “control-name” property

  “control-name”             gchar *

The scale's control name.

Owner: AgsScale

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “default-value” property

  “default-value”            gdouble

The scale's default value.

Owner: AgsScale

Flags: Read / Write

Default value: 0

Since: 3.0.0

The “lower” property

  “lower”                    gdouble

The scale's lower range.

Owner: AgsScale

Flags: Read / Write

Default value: 0

Since: 3.0.0

The “scale-height” property

  “scale-height”             guint

The scale height to use for drawing a scale.

Owner: AgsScale

Flags: Read / Write

Default value: 128

Since: 3.0.0

The “scale-width” property

  “scale-width”              guint

The scale width to use for drawing a scale.

Owner: AgsScale

Flags: Read / Write

Default value: 60

Since: 3.0.0

The “upper” property

  “upper”                    gdouble

The scale's upper range.

Owner: AgsScale

Flags: Read / Write

Default value: 1

Since: 3.0.0

Signal Details

The “value-changed” signal

void
user_function (AgsScale *scale,
               gdouble   default_value,
               gpointer  user_data)

The ::value-changed signal notifies about modified default value.

Parameters

scale

the AgsScale

  

default_value

the changed default value

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Since: 3.0.0

Generated by GTK-Doc V1.32