Class TAdPluginPropertyList

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TAdPluginPropertyList = class(TObject)

Description

List used to store the plugin properties. TAdPluginPropertyList permits acces on available properties in the plugin and allows the user to set them. An instance of TAdPluginPropertyList is held by TAdDraw by default.

Hierarchy

Overview

Methods

Public constructor Create;
Public destructor Destroy; override;
Public procedure Clear;
Public procedure ReadProperties(ADllLoader: TAdDllLoader);
Public procedure WriteProperties(AAppl: TAd2DApplication);
Public procedure SetProp(AName: AnsiString; AValue: boolean); overload;
Public procedure SetProp(AName: AnsiString; AValue: integer); overload;
Public procedure SetProp(AName: AnsiString; AValue: TAd2dResolution); overload;
Public function PropertyExists(AName: AnsiString): boolean;

Properties

Public property Items[Index: integer]: TAd2dProperty read GetProperty;
Public property Count: integer read FCount;

Description

Methods

Public constructor Create;

Creates an instance of TAdPluginPropertyList. Properties from the plugin are read via the "ReadProperties" method.

Public destructor Destroy; override;

Destroys the instance of TAdPluginPropertyList.

Public procedure Clear;

Clears all read properties and all settings that have been made.

Public procedure ReadProperties(ADllLoader: TAdDllLoader);

Reads the available properties from a loaded plugin library. After this properties may be accesed by the "Items" property of TAdPluginPropertyList.

Public procedure WriteProperties(AAppl: TAd2DApplication);

Writes all set properties into a created Andorra 2D application. If a property does not exists, nothing will happen. The WriteProperties is normally automatically be called by TAdDraw.

Public procedure SetProp(AName: AnsiString; AValue: boolean); overload;

Sets a boolean property. Properties are stored when the "WriteProperties" method is called.

Public procedure SetProp(AName: AnsiString; AValue: integer); overload;

Sets a integer property. Properties are stored when the "WriteProperties" method is called.

Public procedure SetProp(AName: AnsiString; AValue: TAd2dResolution); overload;

Sets a resolution property. Properties are stored when the "WriteProperties" method is called.

Public function PropertyExists(AName: AnsiString): boolean;

Returns whether a certain property exists.

Properties

Public property Items[Index: integer]: TAd2dProperty read GetProperty;

Allows to read plugin the properties directly.

Public property Count: integer read FCount;

Returns the current property count.

SourceForge.net Logo


Generated by PasDoc 0.11.0 on 2008-12-31 14:31:59