gobject/org.gtkkn.bindings.gobject/ParamSpec

ParamSpec

open class ParamSpec(pointer: <Error class: unknown class><<Error class: unknown class>>)

#GParamSpec is an object structure that encapsulates the metadata required to specify parameters, such as e.g. #GObject properties.

Parameter names # {#canonical-parameter-names}

A property name consists of one or more segments consisting of ASCII letters and digits, separated by either the - or _ character. The first character of a property name must be a letter. These are the same rules as for signal naming (see g_signal_new()).

When creating and looking up a #GParamSpec, either separator can be used, but they cannot be mixed. Using - is considerably more efficient, and is the ‘canonical form’. Using _ is discouraged.

Skipped during bindings generation

method get_qdata: Return type gpointer is unsupported
parameter data: gpointer
method steal_qdata: Return type gpointer is unsupported

Inheritors

Constructors

ParamSpec

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gPointer

val gPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

getBlurb

open fun getBlurb(): String?

Get the short description of a #GParamSpec.

getDefaultValue

open fun getDefaultValue(): Value

Gets the default value of @pspec as a pointer to a #GValue.

getName

open fun getName(): String

Get the name of a #GParamSpec.

getNameQuark

open fun getNameQuark(): <Error class: unknown class>

Gets the GQuark for the name.

getNick

open fun getNick(): String

Get the nickname of a #GParamSpec.

getRedirectTarget

open fun getRedirectTarget(): ParamSpec?

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 #GParamSpecOverride. See g_object_class_override_property() for an example of the use of this capability.

sink

open fun sink()

The initial reference count of a newly created #GParamSpec is 1, even though no one has explicitly called g_param_spec_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).