Class Scope

Hierarchy

Scope

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new Scope(): Template.Scope

- Defined in @types/Gjs/Template-1.0.d.ts:364
Creates a new scope to contain variables and custom expressions,

Returns Template.Scope

Properties

Static name

name: string

Methods

get

get(name: string): Template.Symbol

- Defined in @types/Gjs/Template-1.0.d.ts:275
If the symbol could not be found, it will be allocated.

Parameters
- name: string
Returns Template.Symbol

new_with_parent

new_with_parent(): Template.Scope

- Defined in @types/Gjs/Template-1.0.d.ts:280
Creates a new scope to contain variables and custom expressions, If parent is set, the parent scope will be inherited.

Returns Template.Scope

peek

peek(name: string): Template.Symbol

- Defined in @types/Gjs/Template-1.0.d.ts:285
If the symbol could not be found, %NULL is returned.

Parameters
- name: string
Returns Template.Symbol

ref

ref(): Template.Scope

- Defined in @types/Gjs/Template-1.0.d.ts:286
Returns Template.Scope

set

set(name: string, symbol: Template.Symbol): void

- Defined in @types/Gjs/Template-1.0.d.ts:294
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
- symbol: Template.Symbol
  
  An #TmplSymbol or %NULL.
Returns void

set_boolean

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

- Defined in @types/Gjs/Template-1.0.d.ts:300
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

- Defined in @types/Gjs/Template-1.0.d.ts:306
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_object

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

- Defined in @types/Gjs/Template-1.0.d.ts:312
Sets the value of the symbol named name to the object value.

Parameters
- name: string
  
  a name for the symbol
- value: GObject.Object
  
  a #GObject or %NULL.
Returns void

set_resolver

set_resolver(resolver: ScopeResolver): void

- Defined in @types/Gjs/Template-1.0.d.ts:313
Parameters
- resolver: ScopeResolver
Returns void

set_string

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

- Defined in @types/Gjs/Template-1.0.d.ts:319
Sets the value of the symbol named name to a string matching value.

Parameters
- name: string
  
  a name for the symbol
- value: string
  
  A string or %NULL.
Returns void

set_strv

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

- Defined in @types/Gjs/Template-1.0.d.ts:325
Sets the value of the symbol named name to the strv value.

Parameters
- name: string
  
  a name for the symbol
- value: string[]
  
  the value to set it to, or %NULL
Returns void

set_value

set_value(name: string, value: any): void

- Defined in @types/Gjs/Template-1.0.d.ts:331
Sets the contents of the symbol named name to the value value.

Parameters
- name: string
  
  a name for the symbol
- value: any
  
  A #GValue or %NULL
Returns void

set_variant

set_variant(name: string, value: GLib.Variant): void

- Defined in @types/Gjs/Template-1.0.d.ts:339
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
- value: GLib.Variant
  
  the variant to set it to, or %NULL
Returns void

take

take(name: string, symbol: Template.Symbol): void

- Defined in @types/Gjs/Template-1.0.d.ts:348
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
- symbol: Template.Symbol
  
  A #TmplSymbol or %NULL
Returns void

unref

unref(): void

- Defined in @types/Gjs/Template-1.0.d.ts:349
Returns void

Static new

new(): Template.Scope

- Defined in @types/Gjs/Template-1.0.d.ts:369
Creates a new scope to contain variables and custom expressions,

Returns Template.Scope