KRIniConfig.pas

Типы данных

• TKRIniCfgValType – типы значений параметра ini-файла
  • icvtString – строковый
  • icvtInteger – целый со знаком
  • icvtFloat – значение с плавающей точкой
  • icvtBool – логическое значение
  • icvtDWORD – целое без знаковое

Интерфейсы

Интерфейс IKRCfgParam

IKRCfgParam – интерфейс компонентов, которые могут мониторить изменение значения параметра ini-файла

Методы интерфейса IKRCfgParam

procedure CfgParamChange(AParam: TKRIniCfgParam); stdcall;

• CfgParamChange – вызывается при изменении значения параметра ini-файла
  • AParam – параметр, значение которого было изменено

Интерфейс IKRCfgParamEditor

IKRCfgParamEditor – интерфейс компонентов редактирования, которые могут изменять значения параметра ini-файла

Методы интерфейса IKRCfgParamEditor

procedure OK;

• OK – подтверждение сохранения значения в параметр ini-файла

procedure Cancel;

• Cancel – отменяет сохранение значения в параметр ini-файла

Классы

Класс TKRIniCfgParam

Родительский класс TKRComponentCollectionItem

TKRIniCfgParam – параметр ini-файла

Свойства класса TKRIniCfgParam

property IniConfig: TKRIniConfig;

• IniConfig – указатель на коллекцию TKRIniConfig. Только чтение.

property Value: Variant;

• Value – чтение/запись значения параметра

property Section: String;

• Section – секция параметра в ini-файле

property Name: TComponentName;

• Name – является именем компонента и именем в ini-файле

property ValueType: TKRIniCfgValType;

• ValueType – тип параметра

property DefaultValue: String;

• DefaultValue – значение по умолчанию

property Encrypt: boolean;

• Encrypt – включение/выключение шифрования значения параметра в ini-файле. Шифруются только строковые значения относительно пароля указанного в свойстве TKRIniConfig

Методы класса TKRIniCfgParam

procedure AddMon(AMon: IKRCfgParam);

• AddMon – добавляет объект в список мониторинга для фиксирования изменения значения параметра ini-файла
  • AMon – объект соответствующий интерфейсу IKRCfgParam, в котором будет вызываться метод CfgParamChange при каждом изменении значения параметра

procedure DelMon(AMon: IKRCfgParam);

• DelMon – удаление объекта из списка мониторинга
  • AMon – объект, который будет удален

procedure UpValue;

• UpValue – обновляет значение параметра из ini-файла. Значение параметра считывается из файла только при первом запросе. Если необходимо повторно считать значение, используется данный метод

Класс TKRIniConfig

Родительский класс TKRComponentCollection

TKRIniConfig – класс, надстройка над классом TIniFile для более гибкого доступа к параметрам ini-файла. Является коллекцией компонентов TKRIniCfgParam

Свойства класса TKRIniConfig

property IniFile: TIniFile;

• IniFile – указатель на класс TIniFile. Только чтение

property FileName: TFileName;

• FileName – имя и путь к ini-файлу. Если используются свойства ApplicationPath или AppDataPath, то путь не указывается

property ApplicationPath: boolean;

• ApplicationPath – указывает на то, что ini-файл будет находится в той же папке, где находится файл приложения

property AppDataPath: boolean;

• AppDataPath – указывает на то, что ini-файл будет находится в папке пользовательский настроек APPDATA. В папке пользовательских настроек будет создана папке с именем из Application.Name. Если Application.Name не указано, то папка будет называться именем приложения без расширения

property Password: String;

• Password – пароль для шифрования значения параметров с включенным свойством Encrypt

Методы класса TKRIniConfig

class procedure SetOK(AParent: TComponent);

• SetOK – статический метод, который вызывает метод OK у всех дочерних компонентов, соответствующих интерфейсу IKRCfgParamEditor
  • AParent – компонент, в дочерних компонентах которого производится поиск всех элементов, соответствующих интерфейсу IKRCfgParamEditor

class procedure SetCancel(AParent: TComponent);

• SetCancel – статический метод, который вызывает метод Cancel у всех дочерних компонентов, соответствующих интерфейсу IKRCfgParamEditor
  • AParent – компонент, в дочерних компонентах которого производится поиск всех элементов, соответствующих интерфейсу IKRCfgParamEditor

procedure SaveConfig(AFileName: String);

• SaveConfig – сохранение данных в сторонний ini-файл
  • AFileName – имя ini-файла в который сохраняются данные

procedure LoadConfig(AFileName: String);

• LoadConfig – загрузка данных из стороннего ini-файла
  • AFileName – имя ini-файла из которого берутся данные

function AddParam(AName, ASection: String; AType: TKRIniCfgValType; ADefaultValue: Variant): TKRIniCfgParam;

• AddParam – добавляет новый параметр в коллекцию
  • AName – имя параметра
  • ASection – секция параметра
  • AType – тип параметра
  • ADefaultValue – значение по умолчанию

function ConfigPath: String;

• ConfigPath – возвращает путь к папке где находится ini-файл

function GetParamByName(AName: String; ACaseSensitive: boolean = false): TKRIniCfgParam;

• GetParamByName – возвращает параметр по имени. Если параметр не найден возвращает nil
  • AName – имя параметра
  • ACaseSensitive – учитывать регистра символов при поиске

Примеры использования:

• Пример использования компонента KRIniConfig в Delphi

Поделиться: