Flags

The GLib type system provides fundamental types for enumeration and flags types. (Flags types are like enumerations, but allow their values to be combined by bitwise or). A registered enumeration or flags type associates a name and a nickname with each allowed value, and the methods g_enum_get_value_by_name(), g_enum_get_value_by_nick(), g_flags_get_value_by_name() and g_flags_get_value_by_nick() can look up values by their name or nickname. When an enumeration or flags type is registered with the GLib type system, it can be used as value type for object properties, using g_param_spec_enum() or g_param_spec_flags().

GObject ships with a utility called glib-mkenums that can construct suitable type registration functions from C enumeration definitions.

Constructors

this
this(GFlagsValue* gFlagsValue)

Sets our main struct and passes it to the parent class

Members

Functions

getFlagsStruct
GFlagsValue* getFlagsStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

Static functions

completeTypeInfo
void completeTypeInfo(GType type, GTypeInfo* info, Flags _Values)

This function is meant to be called from the complete_type_info() function of a GTypePlugin implementation, see the example for g_enum_complete_type_info() above.

getFirstValue
Flags getFirstValue(GFlagsClass* flagsClass, uint value)

Returns the first GFlagsValue which is set in value.

getValueByName
Flags getValueByName(GFlagsClass* flagsClass, string name)

Looks up a GFlagsValue by name.

getValueByNick
Flags getValueByNick(GFlagsClass* flagsClass, string nick)

Looks up a GFlagsValue by nickname.

registerStatic
GType registerStatic(string name, Flags _StaticValues)

Registers a new static flags type with the name name. It is normally more convenient to let glib-mkenums generate a my_flags_get_type() function from a usual C enumeration definition than to write one yourself using g_flags_register_static().

Variables

gFlagsValue
GFlagsValue* gFlagsValue;

the main Gtk struct

Meta