Тип TObjectPropControlProc сервисной функции свойства объекта

Назначение

Сервисная функция свойства предназначена для управления свойством aPropName объекта типа aObjType, имеющего указатель aSelf. Управление свойством подразумевает установку, считывание или проверку значения свойства в зависимости от параметра aCommand.

Функция пишется для каждого свойства каждого объекта или для нескольких свойств или объектов.

Представляет собой callback-функцию. Передается в качестве параметра в функцию регистрации свойства объекта, где и производится регистрация данной callback-функции.

Описание

function TObjectPropControlProc (aObjType : longInt;
	aPropName : longInt;
	aSelf : pointer;
	aCommand : longInt;
	aInfo : pointer) : longInt;

Параметры

aObjType - тип объекта, к свойству которого мы обращаемся.

aPropName -код свойства, к которому мы обращаемся.

aSelf - указатель на объект, к свойству которого мы обращаемся.

aCommand - код операции. Может быть:

• cfmSetProp - установить свойство, то есть скопировать значение из поля типа pField по адресу aInfo в определенное параметром aPropName поле объекта aSelf. Значение поля в aInfo имеет тип, соответствующий зарегистрированному типу свойства;

• cfmGetProp - считать свойство, то есть скопировать значение из поля, определенного параметром aPropName объекта aSelf, в поле типа pField по адресу aInfo;

• cfmSetPropDefault - установить свойство в значение "по умолчанию";

• cfmCheckProp - проверить свойство на возможность редактирования;

• cfmGetPropList - получить список значений свойства.

aInfo - указатель на структуры дополнительной информации. Для cfmSetProp и cfmGetProp это pField типа, заданного при регистрации свойства. Для cfmGetPropList это pArrayField с типом элементов ftString.

Возвращаемое значение

Возвращает константу кода ошибки:

• cfErrInternalBadCommand;

• cfErrCantEditProp - при cfmSetProp;

• cfErrPropValueError - при cfmGetProp;

• cfOk.