Template-1.0 ▶ Template ▶ Scope

constructor

• new Scope(properties?: Partial<{}>): Scope

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Scope

Static$gtype

dup_string

• dup_string(name: string): string

  Gets a string if the symbol name is a string.

  Otherwise, null is returned.

  Parameters

  • name: string

  Returns string

  a string or null

get

• get(name: string): Symbol

  If the symbol could not be found, it will be allocated.

  Parameters

  • name: string

  Returns Symbol

  A Template.Symbol.

list_symbols

• list_symbols(recursive: boolean): string[]

  Gets the names of all symbols within the scope.

  Parameters

  • recursive: boolean

    if the parent scopes should be included

  Returns string[]

  an array containing the names of all symbols within the scope.

new_with_parent

• new_with_parent(): Scope

  Creates a new scope to contain variables and custom expressions, If parent is set, the parent scope will be inherited.

  Returns Scope

  A newly created Template.Scope.

peek

• peek(name: string): Symbol

  If the symbol could not be found, null is returned.

  Parameters

  • name: string

  Returns Symbol

  A Template.Symbol or null.

ref

• ref(): Scope

  Returns Scope

require

• require(namespace_: string, version?: string): boolean

  Imports namespace_ into self so it can be used by expressions.

  Parameters

  • namespace_: string

    the namespace to import into the scope

  • Optionalversion: string

    the version of namespace_ to import

  Returns boolean

  true if successful; otherwise false

set

• set(name: string, symbol?: Symbol): void

  If the symbol already exists, it will be overwritten.

  If symbol is null, the symbol will be removed from scope.

  Parameters

  • name: string

    the name of the symbol

  • Optionalsymbol: Symbol

    An Template.Symbol or null.

  Returns void

set_boolean

• set_boolean(name: string, value: boolean): void

  Sets the value of the symbol named name to a gboolean value of value.

  Parameters

  • name: string

    a name for the symbol

  • value: boolean

    a gboolean

  Returns void

set_double

• set_double(name: string, value: number): void

  Sets the value of the symbol named name to a gdouble value of value.

  Parameters

  • name: string

    a name for the symbol

  • value: number

    a gdouble

  Returns void

set_null

• set_null(name: string): void

  Parameters

  • name: string

  Returns void

set_object

• set_object(name: string, value?: GObject.Object): void

  Sets the value of the symbol named name to the object value.

  Parameters

  • name: string

    a name for the symbol

  • Optionalvalue: GObject.Object

    a GObject.Object or null.

  Returns void

set_resolver

• set_resolver(resolver: ScopeResolver): void

  Parameters

  • resolver: ScopeResolver

  Returns void

set_string

• set_string(name: string, value?: string): void

  Sets the value of the symbol named name to a string matching value.

  Parameters

  • name: string

    a name for the symbol

  • Optionalvalue: string

    A string or null.

  Returns void

set_strv

• set_strv(name: string, value?: string[]): void

  Sets the value of the symbol named name to the strv value.

  Parameters

  • name: string

    a name for the symbol

  • Optionalvalue: string[]

    the value to set it to, or null

  Returns void

set_value

• set_value(name: string, value?: GObject.Value): void

  Sets the contents of the symbol named name to the value value.

  Parameters

  • name: string

    a name for the symbol

  • Optionalvalue: GObject.Value

    A GObject.Value or null

  Returns void

set_variant

• set_variant(name: string, value?: GLib.Variant<any>): void

  Sets the value of the symbol named name to the variant value.

  If value has a floating reference, it is consumed.

  Parameters

  • name: string

    a name for the symbol

  • Optionalvalue: GLib.Variant<any>

    the variant to set it to, or null

  Returns void

take

• take(name: string, symbol?: Symbol): void

  Sets the symbol named name to symbol in scope.

  This differs from tmpl_scope_set() in that it takes ownership of symbol.

  Parameters

  • name: string

    The name of the symbol

  • Optionalsymbol: Symbol

    A Template.Symbol or null

  Returns void

unref

• unref(): void

  Returns void

Staticnew

• new(): Scope

  Returns Scope