Function

GObjectParamSpecinternal

Declaration

GObject.ParamSpec*
g_param_spec_internal (
  GType param_type,
  const gchar* name,
  const gchar* nick,
  const gchar* blurb,
  GParamFlags flags
)

Description

Creates a new GParamSpec instance.

See [canonical parameter names][canonical-parameter-names] for details of the rules for name. Names which violate these rules lead to undefined behaviour.

Beyond the name, GParamSpecs 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.

Parameters

param_type GType
 

The GType for the property; must be derived from #G_TYPE_PARAM.

name const gchar*
 

The canonical name of the property.

 The data is owned by the caller of the function.
 The string is a NUL terminated UTF-8 string.
nick const gchar*
 

The nickname of the property.

 The data is owned by the caller of the function.
 The string is a NUL terminated UTF-8 string.
blurb const gchar*
 

A short description of the property.

 The data is owned by the caller of the function.
 The string is a NUL terminated UTF-8 string.
flags GParamFlags
 

A combination of GParamFlags.

Return value

Returns: GParamSpec
 

(transfer floating): a newly allocated GParamSpec instance, which is initially floating.

 The data is owned by the called function.