Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

defaultValue: number

default value for the property specified

field
enumClass: GObject.EnumClass

the #GEnumClass for the enum

field

#GParamFlags flags for this parameter

field
gTypeInstance: TypeInstance

private #GTypeInstance portion

field
name: string

name of this parameter: always an interned string

field
ownerType: GType<unknown>

#GType type that uses (introduces) this parameter

field
parentInstance: ParamSpec

private #GParamSpec portion

field
valueType: GType<unknown>

the #GValue type for this parameter

field
name: string

Methods

  • getBlurb(): string
  • getDefaultValue(): any
  • getName(): string
  • Get the name of a #GParamSpec.

    The name is always an "interned" string (as per g_intern_string()). This allows for pointer-value comparisons.

    Returns string

  • getNameQuark(): number
  • getNick(): string
  • getQdata(quark: number): object
  • Gets back user data pointers stored via g_param_spec_set_qdata().

    Parameters

    • quark: number

      a #GQuark, naming the user data pointer

    Returns object

  • 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.

    Returns ParamSpec

  • setQdata(quark: number, data: object): void
  • 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.

    Parameters

    • quark: number

      a #GQuark, naming the user data pointer

    • data: object

      an opaque user data pointer

    Returns void

  • sink(): void
  • 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).

    Returns void

  • stealQdata(quark: number): object
  • 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.

    Parameters

    • quark: number

      a #GQuark, naming the user data pointer

    Returns object

  • isValidName(name: string): boolean
  • Validate a property name for a #GParamSpec. This can be useful for dynamically-generated properties which need to be validated at run-time before actually trying to create them.

    See [canonical parameter names][canonical-parameter-names] for details of the rules for valid names.

    Parameters

    • name: string

      the canonical name of the property

    Returns boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method