Class PluginDescription

Hierarchy

PluginDescription

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new PluginDescription(filename: string): PluginDescription

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8298
Parameters
- filename: string
Returns PluginDescription

Properties

Static name

name: string

Methods

copy

copy(): PluginDescription

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8228
Returns PluginDescription

free

free(): void

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8232
Frees the #AnjutaPluginDescription instance.

Returns void

get_boolean

get_boolean(section: string, keyname: string, val: boolean): boolean

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8239
Returns the value of key as boolean in the given section.

Parameters
- section: string
  
  Section name.
- keyname: string
  
  Key name.
- val: boolean
  
  Pointer to value to store retured value.
Returns boolean

get_integer

get_integer(section: string, keyname: string, val: number): boolean

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8246
Returns the value of key as integer in the given section.

Parameters
- section: string
  
  Section name.
- keyname: string
  
  Key name.
- val: number
  
  Pointer to value to store retured value.
Returns boolean

get_locale_string

get_locale_string(section: string, keyname: string, val: string): boolean

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8253
Returns the value of key in the given section in current locale.

Parameters
- section: string
  
  Section name.
- keyname: string
  
  Key name.
- val: string
  
  Pointer to value to store retured value.
Returns boolean

get_raw

get_raw(section_name: string, keyname: string, locale: string): [boolean, string]

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8261
Retrieves the value of a key (in the given section) for the given locale. The value returned in val must be freed after use.

Parameters
- section_name: string
  
  Name of the section.
- keyname: string
  
  Name of the key.
- locale: string
  
  The locale for which the value is to be retrieved.
Returns [boolean, string]

get_string

get_string(section: string, keyname: string, val: string): boolean

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8268
Returns the value of key in the given section.

Parameters
- section: string
  
  Section name.
- keyname: string
  
  Key name.
- val: string
  
  Pointer to value to store retured value.
Returns boolean

override

override(section_name: string, keyname: string, val: string): boolean

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8276
Override the value of a key in the description. This can be removed using the function anjuta_plugin_description_remove().

Parameters
- section_name: string
  
  Section name.
- keyname: string
  
  Key name.
- val: string
  
  Pointer to value to store retured value.
Returns boolean

remove

remove(section_name: string, keyname: string): boolean

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8282
Remove a key from the description.

Parameters
- section_name: string
  
  Section name.
- keyname: string
  
  Key name.
Returns boolean

to_string

to_string(): string

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8287
Converts the description detains into string format, usually for saving it in a file.

Returns string

Static new

new(filename: string): PluginDescription

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8299
Parameters
- filename: string
Returns PluginDescription

Static new_from_string

new_from_string(data: string): PluginDescription

- Defined in @types/Gjs/Anjuta-3.0.d.ts:8307
Parses the given plugin description data (usally read from the plugin description file and creates an instance of #AnjutaPluginDescription. The format of the content string is similar to .ini format.

Parameters
- data: string
  
  The data to parse. The format of the data is .ini style.
Returns PluginDescription