Libraries:Gtk:GObject:GParamSpec
Types
T
Inherits from:Constants
Nil : T
Functions
Boolean(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, default_value @ Std.Symbol.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecBoolean.T instance specifying a G_TYPE_BOOLEAN property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Boxed(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, boxed_type @ Gtk.GObject.Type.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecBoxed.T instance specifying a G_TYPE_BOXED derived property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
boxed_type | G_TYPE_BOXED derived type of this property |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Char(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Integer.SmallT, maximum @ Std.Integer.SmallT, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecChar.T instance specifying a G_TYPE_CHAR property.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Double(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Real.T, maximum @ Std.Real.T, default_value @ Std.Real.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecDouble.T instance specifying a G_TYPE_DOUBLE property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Enum(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, enum_type @ Gtk.GObject.Type.T, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecEnum.T instance specifying a G_TYPE_ENUM property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
enum_type | a GType derived from G_TYPE_ENUM |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Flags(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, flags_type @ Gtk.GObject.Type.T, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecFlags.T instance specifying a G_TYPE_FLAGS property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
flags_type | a GType derived from G_TYPE_FLAGS |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Float(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Real.T, maximum @ Std.Real.T, default_value @ Std.Real.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecFloat.T instance specifying a G_TYPE_FLOAT property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Gtype(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, is_a_type @ Gtk.GObject.Type.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecGType.T instance specifying a G_TYPE_GTYPE property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
is_a_type | a GType whose subtypes are allowed as values of the property (use G_TYPE_NONE for any type) |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Int(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Integer.SmallT, maximum @ Std.Integer.SmallT, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecInt.T instance specifying a G_TYPE_INT property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Int64(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Integer.T, maximum @ Std.Integer.T, default_value @ Std.Integer.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecInt64.T instance specifying a G_TYPE_INT64 property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Internal(param_type @ Gtk.GObject.Type.T, name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, flags @ Std.Integer.SmallT) : Std.Address.T
Creates a new T instance.
A property name consists of segments consisting of ASCII letters and digits, separated by either the '-' or '_' character. The first character of a property name must be a letter. Names which violate these rules lead to undefined behaviour.
When creating and looking up a T, either separator can be used, but they cannot be mixed. Using '-' is considerably more efficient and in fact required when using property names as detail strings for signals.
Beyond the name, Ts have two more descriptive strings associated with them, the nick, which should be suitable for use as a label for the property in a property editor, and the blurb, which should be a somewhat longer description, suitable for e.g. a tooltip. The nick and blurb should ideally be localized.
param_type | the GType for the property; must be derived from G_TYPE_PARAM |
name | the canonical name of the property |
nick | the nickname of the property |
blurb | a short description of the property |
flags | a combination of Gtk.GObject.GParamFlags.T |
Returns | a newly allocated T instance |
Long(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Integer.SmallT, maximum @ Std.Integer.SmallT, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecLong.T instance specifying a G_TYPE_LONG property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Object(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, object_type @ Gtk.GObject.Type.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecBoxed.T instance specifying a G_TYPE_OBJECT derived property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
object_type | G_TYPE_OBJECT derived type of this property |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Override(name @ Std.String.T, overridden @ Gtk.GObject.GParamSpec.T) : Gtk.GObject.GParamSpec.T
Creates a new property of type Gtk.GObject.GParamSpecOverride.T. This is used to direct operations to another paramspec, and will not be directly useful unless you are implementing a new base type similar to GObject.
name | the name of the property. |
overridden | The property that is being overridden |
Returns | the newly created T |
Param(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, param_type @ Gtk.GObject.Type.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecParam.T instance specifying a G_TYPE_PARAM property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
param_type | a GType derived from G_TYPE_PARAM |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Pointer(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecPointer.T instance specifying a pointer property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
String(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, default_value @ Std.String.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecString.T instance.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Uchar(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Integer.SmallT, maximum @ Std.Integer.SmallT, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecUChar.T instance specifying a G_TYPE_UCHAR property.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Uint(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Integer.SmallT, maximum @ Std.Integer.SmallT, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecUInt.T instance specifying a G_TYPE_UINT property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Uint64(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Integer.T, maximum @ Std.Integer.T, default_value @ Std.Integer.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecUInt64.T instance specifying a G_TYPE_UINT64 property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Ulong(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, minimum @ Std.Integer.SmallT, maximum @ Std.Integer.SmallT, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecULong.T instance specifying a G_TYPE_ULONG property.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
minimum | minimum value for the property specified |
maximum | maximum value for the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Unichar(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, default_value @ Std.Integer.SmallT, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecUnichar.T instance specifying a G_TYPE_UINT property. GValue structures for this property can be accessed with g_value_set_uint() and g_value_get_uint().
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
default_value | default value for the property specified |
flags | flags for the property specified |
Returns | a newly created parameter specification |
ValueArray(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, element_spec @ Gtk.GObject.GParamSpec.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecValueArray.T instance specifying a G_TYPE_VALUE_ARRAY property. G_TYPE_VALUE_ARRAY is a G_TYPE_BOXED type, as such, GValue structures for this property can be accessed with g_value_set_boxed() and g_value_get_boxed().
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
element_spec | a T describing the elements contained in arrays of this property, may be NULL |
flags | flags for the property specified |
Returns | a newly created parameter specification |
Variant(name @ Std.String.T, nick @ Std.String.T, blurb @ Std.String.T, type @ Std.Object.T, default_value @ Std.Object.T, flags @ Std.Integer.SmallT) : Gtk.GObject.GParamSpec.T
Creates a new Gtk.GObject.GParamSpecVariant.T instance specifying a GVariant property.
If default_value is floating, it is consumed.
See Internal for details on property names.
name | canonical name of the property specified |
nick | nick name for the property specified |
blurb | description of the property specified |
type | a GVariantType |
default_value | a GVariant of type type to use as the default value, or NULL. [allow-none] |
flags | flags for the property specified |
Returns | the newly created T |
Methods
:Blurb(self @ T) : Std.String.T
:Flags(self @ T) : Std.Integer.SmallT
:GetBlurb(self @ T) : Std.String.T
:GetName(self @ T) : Std.String.T
Get the name of a T.
The name is always an "interned" string (as per g_intern_string()). This allows for pointer-value comparisons.
pspec | a valid T |
Returns | the name of pspec. |
:GetNick(self @ T) : Std.String.T
:GetQdata(self @ T, quark @ Std.Integer.SmallT) : Std.Address.T
Gets back user data pointers stored via SetQdata.
pspec | a valid T |
quark | a GQuark, naming the user data pointer |
Returns | the user data pointer set, or NULL. [transfer none] |
:GetRedirectTarget(self @ T) : Gtk.GObject.GParamSpec.T
If the paramspec redirects operations to another paramspec, returns that paramspec. Redirect is used typically for providing a new implementation of a property in a derived type while preserving all the properties from the parent type. Redirection is established by creating a property of type Gtk.GObject.GParamSpecOverride.T. See g_object_class_override_property() for an example of the use of this capability.
pspec | a T |
Returns | paramspec to which requests on this paramspec should be redirected, or NULL if none. [transfer none] |
:Name(self @ T) : Std.String.T
:Nick(self @ T) : Std.String.T
:OwnerType(self @ T) : Gtk.GObject.Type.T
:ParamId(self @ T) : Std.Integer.SmallT
:Qdata(self @ T) : Gtk.Glib.GData.T
:Ref(self @ T) : Gtk.GObject.GParamSpec.T
Increments the reference count of pspec.
:RefCount(self @ T) : Std.Integer.SmallT
:RefSink(self @ T) : Gtk.GObject.GParamSpec.T
Convenience function to ref and sink a T.
:SetQdata(self @ T, quark @ Std.Integer.SmallT, data @ Std.Address.T) : Std.Object.T
Sets an opaque, named pointer on a T. The name is specified through a GQuark (retrieved e.g. via Gtk.Glib.GQuark.FromStaticString), and the pointer can be gotten back from the pspec with GetQdata. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.
pspec | the T to set store a user data pointer |
quark | a GQuark, naming the user data pointer |
data | an opaque user data pointer |
:SetQdataFull(self @ T, quark @ Std.Integer.SmallT, data @ Std.Address.T, destroy @ Std.Function.T) : Std.Object.T
This function works like SetQdata, but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the pspec is finalized, or the data is being overwritten by a call to SetQdata with the same quark.
pspec | the T to set store a user data pointer |
quark | a GQuark, naming the user data pointer |
data | an opaque user data pointer |
destroy | function to invoke with data as argument, when data needs to be freed |
:Sink(self @ T) : Std.Object.T
The initial reference count of a newly created T is 1, even though no one has explicitly called Ref on it yet. So the initial reference count is flagged as "floating", until someone calls g_param_spec_ref (pspec); g_param_spec_sink (pspec); in sequence on it, taking over the initial reference count (thus ending up with a pspec that has a reference count of 1 still, but is not flagged "floating" anymore).
pspec | a valid T |
:StealQdata(self @ T, quark @ Std.Integer.SmallT) : Std.Address.T
Gets back user data pointers stored via SetQdata and removes the data from pspec without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier.
pspec | the T to get a stored user data pointer from |
quark | a GQuark, naming the user data pointer |
Returns | the user data pointer set, or NULL. [transfer none] |