Class

GObjectParamSpecString

Description [src]

final class GObject.ParamSpecString : GObject.TypeInstance
{
  default_value: gchar*,
  cset_first: gchar*,
  cset_nth: gchar*,
  substitutor: gchar,
  null_fold_if_empty: guint,
  ensure_non_null: guint
}

A GParamSpec derived structure that contains the meta data for string properties.

Ancestors

GParamSpec

Instance methods

Methods inherited from GParamSpec (14)

g_param_spec_get_blurb

Get the short description of a GParamSpec.

g_param_spec_get_default_value

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

since: 2.38

g_param_spec_get_name_quark

Gets the GQuark for the name.

since: 2.46

g_param_spec_get_qdata

Gets back user data pointers stored via g_param_spec_set_qdata().

g_param_spec_get_redirect_target

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.

since: 2.4

g_param_spec_ref

Increments the reference count of pspec.

g_param_spec_ref_sink

Convenience function to ref and sink a GParamSpec.

since: 2.10

g_param_spec_set_qdata

Sets an opaque, named pointer on a GParamSpec. The name is specified through a GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the pspec with g_param_spec_get_qdata(). Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.

g_param_spec_set_qdata_full

This function works like g_param_spec_set_qdata(), 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 g_param_spec_set_qdata() with the same quark.

g_param_spec_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).

g_param_spec_steal_qdata

Gets back user data pointers stored via g_param_spec_set_qdata() 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.

g_param_spec_unref

Decrements the reference count of a pspec.