Parameters and Values часть 1

Parameters and Values — Стандартные параметры и значения типов

Краткое описание


#include <glib-object.h>



#define             G_IS_PARAM_SPEC_BOOLEAN             (pspec)
#define             G_PARAM_SPEC_BOOLEAN                (pspec)
#define             G_VALUE_HOLDS_BOOLEAN               (value)
#define             G_TYPE_PARAM_BOOLEAN
                    GParamSpecBoolean;
GParamSpec*         g_param_spec_boolean                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gboolean default_value,
                                                         GParamFlags flags);
void                g_value_set_boolean                 (GValue *value,
                                                         gboolean v_boolean);
gboolean            g_value_get_boolean                 (const GValue *value);

#define             G_IS_PARAM_SPEC_CHAR                (pspec)
#define             G_PARAM_SPEC_CHAR                   (pspec)
#define             G_VALUE_HOLDS_CHAR                  (value)
#define             G_TYPE_PARAM_CHAR
                    GParamSpecChar;
GParamSpec*         g_param_spec_char                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint8 minimum,
                                                         gint8 maximum,
                                                         gint8 default_value,
                                                         GParamFlags flags);
void                g_value_set_char                    (GValue *value,
                                                         gchar v_char);
gchar               g_value_get_char                    (const GValue *value);

#define             G_IS_PARAM_SPEC_UCHAR               (pspec)
#define             G_PARAM_SPEC_UCHAR                  (pspec)
#define             G_VALUE_HOLDS_UCHAR                 (value)
#define             G_TYPE_PARAM_UCHAR
                    GParamSpecUChar;
GParamSpec*         g_param_spec_uchar                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint8 minimum,
                                                         guint8 maximum,
                                                         guint8 default_value,
                                                         GParamFlags flags);
void                g_value_set_uchar                   (GValue *value,
                                                         guchar v_uchar);
guchar              g_value_get_uchar                   (const GValue *value);

#define             G_IS_PARAM_SPEC_INT                 (pspec)
#define             G_PARAM_SPEC_INT                    (pspec)
#define             G_VALUE_HOLDS_INT                   (value)
#define             G_TYPE_PARAM_INT
                    GParamSpecInt;
GParamSpec*         g_param_spec_int                    (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint minimum,
                                                         gint maximum,
                                                         gint default_value,
                                                         GParamFlags flags);
void                g_value_set_int                     (GValue *value,
                                                         gint v_int);
gint                g_value_get_int                     (const GValue *value);

#define             G_IS_PARAM_SPEC_UINT                (pspec)
#define             G_PARAM_SPEC_UINT                   (pspec)
#define             G_VALUE_HOLDS_UINT                  (value)
#define             G_TYPE_PARAM_UINT
                    GParamSpecUInt;
GParamSpec*         g_param_spec_uint                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint minimum,
                                                         guint maximum,
                                                         guint default_value,
                                                         GParamFlags flags);
void                g_value_set_uint                    (GValue *value,
                                                         guint v_uint);
guint               g_value_get_uint                    (const GValue *value);

#define             G_IS_PARAM_SPEC_LONG                (pspec)
#define             G_PARAM_SPEC_LONG                   (pspec)
#define             G_VALUE_HOLDS_LONG                  (value)
#define             G_TYPE_PARAM_LONG
                    GParamSpecLong;
GParamSpec*         g_param_spec_long                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         glong minimum,
                                                         glong maximum,
                                                         glong default_value,
                                                         GParamFlags flags);
void                g_value_set_long                    (GValue *value,
                                                         glong v_long);
glong               g_value_get_long                    (const GValue *value);

#define             G_IS_PARAM_SPEC_ULONG               (pspec)
#define             G_PARAM_SPEC_ULONG                  (pspec)
#define             G_VALUE_HOLDS_ULONG                 (value)
#define             G_TYPE_PARAM_ULONG
                    GParamSpecULong;
GParamSpec*         g_param_spec_ulong                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gulong minimum,
                                                         gulong maximum,
                                                         gulong default_value,
                                                         GParamFlags flags);
void                g_value_set_ulong                   (GValue *value,
                                                         gulong v_ulong);
gulong              g_value_get_ulong                   (const GValue *value);

#define             G_IS_PARAM_SPEC_INT64               (pspec)
#define             G_PARAM_SPEC_INT64                  (pspec)
#define             G_VALUE_HOLDS_INT64                 (value)
#define             G_TYPE_PARAM_INT64
                    GParamSpecInt64;
GParamSpec*         g_param_spec_int64                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gint64 minimum,
                                                         gint64 maximum,
                                                         gint64 default_value,
                                                         GParamFlags flags);
void                g_value_set_int64                   (GValue *value,
                                                         gint64 v_int64);
gint64              g_value_get_int64                   (const GValue *value);

#define             G_IS_PARAM_SPEC_UINT64              (pspec)
#define             G_PARAM_SPEC_UINT64                 (pspec)
#define             G_VALUE_HOLDS_UINT64                (value)
#define             G_TYPE_PARAM_UINT64
                    GParamSpecUInt64;
GParamSpec*         g_param_spec_uint64                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         guint64 minimum,
                                                         guint64 maximum,
                                                         guint64 default_value,
                                                         GParamFlags flags);
void                g_value_set_uint64                  (GValue *value,
                                                         guint64 v_uint64);
guint64             g_value_get_uint64                  (const GValue *value);

#define             G_IS_PARAM_SPEC_FLOAT               (pspec)
#define             G_PARAM_SPEC_FLOAT                  (pspec)
#define             G_VALUE_HOLDS_FLOAT                 (value)
#define             G_TYPE_PARAM_FLOAT
                    GParamSpecFloat;
GParamSpec*         g_param_spec_float                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gfloat minimum,
                                                         gfloat maximum,
                                                         gfloat default_value,
                                                         GParamFlags flags);
void                g_value_set_float                   (GValue *value,
                                                         gfloat v_float);
gfloat              g_value_get_float                   (const GValue *value);

#define             G_IS_PARAM_SPEC_DOUBLE              (pspec)
#define             G_PARAM_SPEC_DOUBLE                 (pspec)
#define             G_VALUE_HOLDS_DOUBLE                (value)
#define             G_TYPE_PARAM_DOUBLE
                    GParamSpecDouble;
GParamSpec*         g_param_spec_double                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gdouble minimum,
                                                         gdouble maximum,
                                                         gdouble default_value,
                                                         GParamFlags flags);
void                g_value_set_double                  (GValue *value,
                                                         gdouble v_double);
gdouble             g_value_get_double                  (const GValue *value);

#define             G_IS_PARAM_SPEC_ENUM                (pspec)
#define             G_PARAM_SPEC_ENUM                   (pspec)
#define             G_VALUE_HOLDS_ENUM                  (value)
#define             G_TYPE_PARAM_ENUM
                    GParamSpecEnum;
GParamSpec*         g_param_spec_enum                   (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType enum_type,
                                                         gint default_value,
                                                         GParamFlags flags);
void                g_value_set_enum                    (GValue *value,
                                                         gint v_enum);
gint                g_value_get_enum                    (const GValue *value);

#define             G_IS_PARAM_SPEC_FLAGS               (pspec)
#define             G_PARAM_SPEC_FLAGS                  (pspec)
#define             G_VALUE_HOLDS_FLAGS                 (value)
#define             G_TYPE_PARAM_FLAGS
                    GParamSpecFlags;
GParamSpec*         g_param_spec_flags                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType flags_type,
                                                         guint default_value,
                                                         GParamFlags flags);
void                g_value_set_flags                   (GValue *value,
                                                         guint v_flags);
guint               g_value_get_flags                   (const GValue *value);

#define             G_IS_PARAM_SPEC_STRING              (pspec)
#define             G_PARAM_SPEC_STRING                 (pspec)
#define             G_VALUE_HOLDS_STRING                (value)
#define             G_TYPE_PARAM_STRING
                    GParamSpecString;
typedef             gchararray;
GParamSpec*         g_param_spec_string                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         const gchar *default_value,
                                                         GParamFlags flags);
void                g_value_set_string                  (GValue *value,
                                                         const gchar *v_string);
void                g_value_set_static_string           (GValue *value,
                                                         const gchar *v_string);
void                g_value_take_string                 (GValue *value,
                                                         gchar *v_string);
void                g_value_set_string_take_ownership   (GValue *value,
                                                         gchar *v_string);
const gchar*        g_value_get_string                  (const GValue *value);
gchar*              g_value_dup_string                  (const GValue *value);

#define             G_IS_PARAM_SPEC_PARAM               (pspec)
#define             G_PARAM_SPEC_PARAM                  (pspec)
#define             G_VALUE_HOLDS_PARAM                 (value)
#define             G_TYPE_PARAM_PARAM
                    GParamSpecParam;
GParamSpec*         g_param_spec_param                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType param_type,
                                                         GParamFlags flags);
void                g_value_set_param                   (GValue *value,
                                                         GParamSpec *param);
void                g_value_take_param                  (GValue *value,
                                                         GParamSpec *param);
void                g_value_set_param_take_ownership    (GValue *value,
                                                         GParamSpec *param);
GParamSpec*         g_value_get_param                   (const GValue *value);
GParamSpec*         g_value_dup_param                   (const GValue *value);

#define             G_IS_PARAM_SPEC_BOXED               (pspec)
#define             G_PARAM_SPEC_BOXED                  (pspec)
#define             G_VALUE_HOLDS_BOXED                 (value)
#define             G_TYPE_PARAM_BOXED
                    GParamSpecBoxed;
GParamSpec*         g_param_spec_boxed                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType boxed_type,
                                                         GParamFlags flags);
void                g_value_set_boxed                   (GValue *value,
                                                         gconstpointer v_boxed);
void                g_value_set_static_boxed            (GValue *value,
                                                         gconstpointer v_boxed);
void                g_value_take_boxed                  (GValue *value,
                                                         gconstpointer v_boxed);
void                g_value_set_boxed_take_ownership    (GValue *value,
                                                         gconstpointer v_boxed);
gpointer            g_value_get_boxed                   (const GValue *value);
gpointer            g_value_dup_boxed                   (const GValue *value);

#define             G_IS_PARAM_SPEC_POINTER             (pspec)
#define             G_PARAM_SPEC_POINTER                (pspec)
#define             G_VALUE_HOLDS_POINTER               (value)
#define             G_TYPE_PARAM_POINTER
                    GParamSpecPointer;
GParamSpec*         g_param_spec_pointer                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GParamFlags flags);
void                g_value_set_pointer                 (GValue *value,
                                                         gpointer v_pointer);
gpointer            g_value_get_pointer                 (const GValue *value);

#define             G_IS_PARAM_SPEC_OBJECT              (pspec)
#define             G_PARAM_SPEC_OBJECT                 (pspec)
#define             G_VALUE_HOLDS_OBJECT                (value)
#define             G_TYPE_PARAM_OBJECT
                    GParamSpecObject;
GParamSpec*         g_param_spec_object                 (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType object_type,
                                                         GParamFlags flags);
void                g_value_set_object                  (GValue *value,
                                                         gpointer v_object);
void                g_value_take_object                 (GValue *value,
                                                         gpointer v_object);
void                g_value_set_object_take_ownership   (GValue *value,
                                                         gpointer v_object);
gpointer            g_value_get_object                  (const GValue *value);
gpointer            g_value_dup_object                  (const GValue *value);

#define             G_IS_PARAM_SPEC_UNICHAR             (pspec)
#define             G_PARAM_SPEC_UNICHAR                (pspec)
#define             G_TYPE_PARAM_UNICHAR
                    GParamSpecUnichar;
GParamSpec*         g_param_spec_unichar                (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         gunichar default_value,
                                                         GParamFlags flags);

#define             G_IS_PARAM_SPEC_VALUE_ARRAY         (pspec)
#define             G_PARAM_SPEC_VALUE_ARRAY            (pspec)
#define             G_TYPE_PARAM_VALUE_ARRAY
                    GParamSpecValueArray;
GParamSpec*         g_param_spec_value_array            (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GParamSpec *element_spec,
                                                         GParamFlags flags);

#define             G_IS_PARAM_SPEC_OVERRIDE            (pspec)
#define             G_PARAM_SPEC_OVERRIDE               (pspec)
#define             G_TYPE_PARAM_OVERRIDE
                    GParamSpecOverride;
GParamSpec*         g_param_spec_override               (const gchar *name,
                                                         GParamSpec *overridden);

#define             G_IS_PARAM_SPEC_GTYPE               (pspec)
#define             G_PARAM_SPEC_GTYPE                  (pspec)
#define             G_VALUE_HOLDS_GTYPE                 (value)
#define             G_TYPE_PARAM_GTYPE
                    GParamSpecGType;
GParamSpec*         g_param_spec_gtype                  (const gchar *name,
                                                         const gchar *nick,
                                                         const gchar *blurb,
                                                         GType is_a_type,
                                                         GParamFlags flags);
GType               g_value_get_gtype                   (const GValue *value);
void                g_value_set_gtype                   (GValue *value,
                                                         GType v_gtype);

Описание

GValue обеспечивает абстрактную контейнерную структуру которая может копироваться, преобразовываться и сравниваться имея значение любого (производного) типа, который зарегистрирован как GType с помощью GTypeValueTable в её структуре GTypeInfo. Спецификации параметра для большинства типовых значений могут быть созданы как GParamSpecпроизводного экземпляра, например для реализации GObject свойств которыми оперируют контейнеры GValue.

Имена параметров должны начинаться с букв (a-z или A-Z). Последующие символы могут быть буквами, числами или символом '-'. Все остальные символы заменяются символом '-' в процессе конструирования.

Детали

G_IS_PARAM_SPEC_BOOLEAN()

Определяет является ли полученный GParamSpec типом G_TYPE_PARAM_BOOLEAN.

pspec :

допустимый экземпляр GParamSpec

G_PARAM_SPEC_BOOLEAN()

Приводит экземпляр GParamSpec к GParamSpecBoolean.

pspec :

допустимый экземпляр GParamSpec

G_VALUE_HOLDS_BOOLEAN()

Определяет может ли полученный GValue содержать значения типа G_TYPE_BOOLEAN.

value :

правильная структура GValue

G_TYPE_PARAM_BOOLEAN

GType из GParamSpecBoolean.

GParamSpecBoolean

Производная структура GParamSpec которая содержит метаданные для логических (boolean) свойств.

GParamSpec parent_instance;

закрытая часть GParamSpec

gboolean default_value;

значение по умолчанию для определённого свойства

g_param_spec_boolean ()

Создаёт новый экземпляр GParamSpecBoolean определяющий свойство G_TYPE_BOOLEAN.

Смотрите детали имён свойств в g_param_spec_internal().

name :

каноническое имя определённого свойства

nick :

псевдоним для определённого свойства

blurb :

описание определённого свойства

default_value :

значение по умолчанию определённого свойства

flags :

флаги для определённого свойства

Возвращает :

вновь созданная спецификация параметра

g_value_set_boolean ()

Устанавливает содержимое G_TYPE_BOOLEAN GValue в значение v_boolean.

value :

допустимая структура GValue типа G_TYPE_BOOLEAN

v_boolean :

логическое значение для установки

g_value_get_boolean ()

Получает содержимое G_TYPE_BOOLEAN GValue.

value :

допустимая структура GValue типа G_TYPE_BOOLEAN

Возвращает :

логическое содержимое value

G_IS_PARAM_SPEC_CHAR()

Определяет является ли полученный GParamSpec типом G_TYPE_PARAM_CHAR.

pspec :

допустимый экземпляр GParamSpec

G_PARAM_SPEC_CHAR()

Приводит экземпляр GParamSpec к GParamSpecChar.

pspec :

допустимый экземпляр GParamSpec

G_VALUE_HOLDS_CHAR()

Определяет может ли полученная GValue содержать значения типа G_TYPE_CHAR.

value :

допустимая структура GValue

G_TYPE_PARAM_CHAR

GType из GParamSpecChar.

GParamSpecChar

Производная структура GParamSpec которая содержит метаданные для свойств символа.

GParamSpec parent_instance;

закрытая часть GParamSpec

gint8 minimum;

минимальное значение для определённого свойства

gint8 maximum;

максимальное значение для определённого свойства

gint8 default_value;

значение по умолчанию для определённого свойства

g_param_spec_char ()

Создаёт новый экземпляр GParamSpecChar определённого свойства G_TYPE_CHAR.

name :

каноническое имя определённого свойства

nick :

псевдоним для определённого свойства

blurb :

описание определённого свойства

minimum :

минимальное значение для определённого свойства

maximum :

максимальное значение для определённого свойства

default_value :

значение по умолчанию для определённого свойства

flags :

флаги для определённого свойства

Возвращает :

вновь созданная спецификация параметра

g_value_set_char ()

Устанавливает содержимое G_TYPE_CHAR GValue в значение v_char.

value :

допустимая структура GValue типа G_TYPE_CHAR

v_char :

символьное значение для установки

g_value_get_char ()

Получает содержимое G_TYPE_CHAR GValue.

value :

допустимая структура GValue типа G_TYPE_CHAR

Возвращает :

символьное содержимое value

G_IS_PARAM_SPEC_UCHAR()

Определяет соответствует ли полученный GParamSpec типу G_TYPE_PARAM_UCHAR.

pspec :

допустимый экземпляр GParamSpec

G_PARAM_SPEC_UCHAR()

Преобразует экземпляр GParamSpec в GParamSpecUChar.

pspec :

допустимый экземпляр GParamSpec

G_VALUE_HOLDS_UCHAR()

Определяет может ли полученная структура GValue содержать значения типа G_TYPE_UCHAR.

value :

допустимая структура GValue

G_TYPE_PARAM_UCHAR

GType из GParamSpecUChar.

GParamSpecUChar

Производная структура GParamSpec которая содержит метаданные для свойств символа без знака (unsigned character).

GParamSpec parent_instance;

закрытая часть GParamSpec

guint8 minimum;

минимальное значение для определённого свойства

guint8 maximum;

максимальное значение для определённого свойства

guint8 default_value;

значение по умолчанию для определённого свойства

g_param_spec_uchar ()

Создаёт новый экземпляр GParamSpecUChar определяющий свойство G_TYPE_UCHAR.

name :

каноническое имя определённого свойства

nick :

псевдоним определённого свойства

blurb :

описание определённого свойства

minimum :

минимальное значение для определённого свойства

maximum :

максимальное значение определённого свойства

default_value :

значение по умолчанию для определённого свойства

flags :

флаги для определённого свойства

Возвращает :

вновь созданная спецификация параметра

g_value_set_uchar ()

Устанавливает содержимое G_TYPE_UCHAR GValue в значение v_uchar.

value :

допустимая структура GValue типа G_TYPE_UCHAR

v_uchar :

беззнаковое символьное значение для установки

g_value_get_uchar ()

Получает содержимое G_TYPE_UCHAR GValue.

value :

допустимая GValue типа G_TYPE_UCHAR

Возвращает :

Беззнаковый символ содержимого value

G_IS_PARAM_SPEC_INT()

Определяет соответствует ли полученная GParamSpec типу G_TYPE_PARAM_INT.

pspec :

допустимый экземпляр GParamSpec

G_PARAM_SPEC_INT()

Преобразует экземпляр GParamSpec в GParamSpecInt.

pspec :

допустимый экземпляр GParamSpec

G_VALUE_HOLDS_INT()

Определяет может ли полученная структура GValue содержать значения типа G_TYPE_INT.

value :

допустимая структура GValue

G_TYPE_PARAM_INT

GType из GParamSpecInt.

GParamSpecInt

Производная структура GParamSpec которая содержит метаданные для свойств целочисленного.

GParamSpec parent_instance;

закрытая часть GParamSpec

gint minimum;

минимальное значение для определённого свойства

gint maximum;

максимальное значение определённого свойства

gint default_value;

значение по умолчанию для определённого свойства

g_param_spec_int ()

Создаёт новый экземпляр GParamSpecInt определяющий свойство G_TYPE_INT.

Смотрите детали имён свойств в g_param_spec_internal().

name :

каноническое имя определённого свойства

nick :

псевдоним определённого свойства

blurb :

описание определённого свойства

minimum :

минимальное значение для определённого свойства

maximum :

максимальное значение определённого свойства

default_value :

значение по умолчанию для определённого свойства

flags :

флаги для определённого свойства

Возвращает :

вновь созданная спецификация параметра

g_value_set_int ()

Устанавливает содержимое G_TYPE_INT GValue в значение v_int.

value :

допустимая структура GValue типа G_TYPE_INT

v_int :

integer value to be set

g_value_get_int ()

Получает содержимое G_TYPE_INT GValue.

value :

допустимая структура GValue типа G_TYPE_INT

Возвращает :

integer contents of value

G_IS_PARAM_SPEC_UINT()

Определяет соответствует ли полученная GParamSpec типу G_TYPE_PARAM_UINT.

pspec :

допустимый экземпляр GParamSpec

Last updated

Was this helpful?