Class PluginDescription

Hierarchy

PluginDescription

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new PluginDescription(filename: string): PluginDescription

- Defined in Anjuta-3.0.d.ts:10262
Parameters
- filename: string
Returns PluginDescription

Properties

Static name

name: string

Methods

copy

copy(): PluginDescription

- Defined in Anjuta-3.0.d.ts:10192
Returns PluginDescription

free

free(): void

- Defined in Anjuta-3.0.d.ts:10196
Frees the #AnjutaPluginDescription instance.

Returns void

getBoolean

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

- Defined in Anjuta-3.0.d.ts:10203
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

getInteger

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

- Defined in Anjuta-3.0.d.ts:10210
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

getLocaleString

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

- Defined in Anjuta-3.0.d.ts:10217
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

getRaw

getRaw(sectionName: string, keyname: string, locale: string): [boolean, string]

- Defined in Anjuta-3.0.d.ts:10225
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
- sectionName: 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]

getString

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

- Defined in Anjuta-3.0.d.ts:10232
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(sectionName: string, keyname: string, val: string): boolean

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

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

remove

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

- Defined in Anjuta-3.0.d.ts:10246
Remove a key from the description.

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

toString

toString(): string

- Defined in Anjuta-3.0.d.ts:10251
Converts the description detains into string format, usually for saving it in a file.

Returns string

Static new

new(filename: string): PluginDescription

- Defined in Anjuta-3.0.d.ts:10263
Parameters
- filename: string
Returns PluginDescription

Static newFromString

newFromString(data: string): PluginDescription

- Defined in Anjuta-3.0.d.ts:10271
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