From ef8ec5a97161a4d65789a34b1d9ae2f886593324 Mon Sep 17 00:00:00 2001 From: alexs75 Date: Thu, 17 Sep 2015 10:31:24 +0000 Subject: [PATCH] RxFPC: documentation git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@4333 8e941d3f-bd1b-0410-a28a-d453659cc2b4 --- components/rx/trunk/docs/makehtml.sh | 12 +- components/rx/trunk/docs/rxaboutdialog.xml | 24 +++ .../rx/trunk/docs/rxcloseformvalidator.xml | 22 +++ components/rx/trunk/docs/rxdbgrid.xml | 83 +++++++++ components/rx/trunk/docs/rxfpc.xml | 175 ------------------ components/rx/trunk/docs/rxinipropstorage.xml | 8 + components/rx/trunk/docs/rxversinfo.xml | 32 ++++ 7 files changed, 177 insertions(+), 179 deletions(-) create mode 100644 components/rx/trunk/docs/rxaboutdialog.xml create mode 100644 components/rx/trunk/docs/rxcloseformvalidator.xml create mode 100644 components/rx/trunk/docs/rxinipropstorage.xml create mode 100644 components/rx/trunk/docs/rxversinfo.xml diff --git a/components/rx/trunk/docs/makehtml.sh b/components/rx/trunk/docs/makehtml.sh index 6c1cb11b5..6b74db568 100755 --- a/components/rx/trunk/docs/makehtml.sh +++ b/components/rx/trunk/docs/makehtml.sh @@ -17,18 +17,22 @@ fpdoc --package=rxfpc --format=html --index-colcount=4 --hide-protected \ --input=../rxswitch.pas --descr=rxfpc.xml \ --input=../tooledit.pas --descr=rxfpc.xml \ --input=../pickdate.pas --descr=rxfpc.xml \ - --input=../rxversinfo.pas --descr=rxfpc.xml \ + --input=../rxversinfo.pas --descr=rxversinfo.xml \ --input=../rxtimeedit.pas --descr=rxfpc.xml \ --input=../rxdbcomb.pas --descr=rxfpc.xml \ --input=../rxdbtimeedit.pas --descr=rxfpc.xml \ - --input=../rxdbgrid.pas --descr=rxfpc.xml \ + --input=../rxdbgrid.pas --descr=rxdbgrid.xml \ --input=../rxdbgrid_columsunit.pas --descr=rxfpc.xml \ --input=../rxdbgrid_findunit.pas --descr=rxfpc.xml \ --input=../rxdbctrls.pas --descr=rxfpc.xml \ --input=../rxdbspinedit.pas --descr=rxfpc.xml \ --input=../rxaboutformunit.pas --descr=rxfpc.xml \ - --input=../rxaboutdialog.pas --descr=rxfpc.xml \ + --input=../rxaboutdialog.pas --descr=rxaboutdialog.xml \ --input=../dateutil.pas --descr=rxfpc.xml \ --input=../rxfileutils.pas --descr=rxfpc.xml \ --input=../rxdbgridexportspreadsheet_paramsunit.pas --descr=rxfpc.xml \ - --input=../rxdbgridexportspreadsheet.pas --descr=rxfpc.xml + --input=../rxdbgridexportspreadsheet.pas --descr=rxfpc.xml \ + --input=../rxcloseformvalidator.pas --descr=rxcloseformvalidator.xml \ + --input=../rxmdi.pas --descr=rxmdi.xml \ + --input=../rxinipropstorage.pas --descr=rxinipropstorage.xml + \ No newline at end of file diff --git a/components/rx/trunk/docs/rxaboutdialog.xml b/components/rx/trunk/docs/rxaboutdialog.xml new file mode 100644 index 000000000..1a31a4aeb --- /dev/null +++ b/components/rx/trunk/docs/rxaboutdialog.xml @@ -0,0 +1,24 @@ + +Параметры отображени окна информации о программе

Параметры отображени окна информации о программе

+ + + + +
ЗначениеОписание
radHelpButtonОтображать кнопку "Помощь"
radLicenseTabОтображать закладку лицензии
radShowImageLogoОтображать логотип на первой закладке
+ + Модуль содержит компонент для окна О ПрограммеПараметры окна "О программе" + Компонента TRXAboutDialog предназначена для отображения информации о программе + Конструктор создаёт экземпляр класса + Уничтожает экземпляр класса + Метод отображет окно "О программе" + Параметры окна "О программе"

Набор флагов, определяющий +параметры отображения окна информации о программе

+ TRxAboutDialogOptions + Заголовок программы, выводимый на первой странице она + Файл лицензии + Заголовок окна + Логотип, отображаемый в окне "О программе" + + + + diff --git a/components/rx/trunk/docs/rxcloseformvalidator.xml b/components/rx/trunk/docs/rxcloseformvalidator.xml new file mode 100644 index 000000000..be9be05fe --- /dev/null +++ b/components/rx/trunk/docs/rxcloseformvalidator.xml @@ -0,0 +1,22 @@ + +Модуль содержит объекты проверки допустимости введённых данных диалоговых оконМодуль содержит объекты проверки допустимости введённых данных диалоговых оконЭлемент проверки данных + Метод проверки допустимости введённых данных + Сформированная строка сообщения об ошибке + Метод установит фокус клавиатурного ввода в проверяемые контрол + Контрол, в котором происходт проверка введённых данных + Признак необходимости выполнять проверку казанного контрола + Эаголовок проверяемого контрола

Эаголовок проверяемого контрола

Используется при формировании сообщения об ошибке

+ + Событие для ручной проверки допустимости введённых данных + Колекция элементов проверки введённых данных + Компонент визуальной настроки проверки введённых данных на диалоговых формахКомпонент визуальной настроки проверки введённых данных на диалоговых формах + Функция производит проверку введённых данных

Функция производит проверку введённых данных

В случае ошбочных данных вернёт false.

+ + Поиск элемента проверки по указателю на контрол + Общая маска сообщения об ошибке + Колекция элементов проверки введённых данных + Признак того, что запрещённые контролы проверки не подлежат + + + + diff --git a/components/rx/trunk/docs/rxdbgrid.xml b/components/rx/trunk/docs/rxdbgrid.xml index 8c7495597..2c3b98c95 100644 --- a/components/rx/trunk/docs/rxdbgrid.xml +++ b/components/rx/trunk/docs/rxdbgrid.xml @@ -3,6 +3,89 @@ Событие, возникающее до выполнения операции быстрого поиска данных в спике Событие, возникающее после выполнения операции быстрого поиска данных в спике + Данный тип описывает событие при отображении в списке заголовка колонки + Свойство определяет, могут ли заголовки колонок в Grid-е быть использованы как кнопки.Свойство определяет, могут ли заголовки колонок в Grid-е быть использованы как кнопки. По умолчанию - False. +При установке свойства в значение True Вы можете обработать события OnTitleBtnClick для обработки нажатия на такую кнопку и OnCheckButton, OnGetBtnParams для установки свойств кнопок в заголовке. + Событие получения параметров ячейки в RxDBGrid-е + Свойство позволяет автоматически сохранять специфические установки компоненты в INI-файле

Свойство позволяет автоматически сохранять специфические установки компоненты в INI-файле или (для 32-разрядной версии) в системном регистре при помощи компонент TFormPlacement или TFormStorage.

При задании значения свойству IniStorage (и непустом имени компоненты), некоторые ее настройки, которые не являются published-свойствами и не могут быть заданы для TFormStorage напрямую, будут сохраняться и восстанавливаться одновременни с другими значениями, заданными для соответствующей компоненты TFormPlacement (TFormStorage).

Для TSpeedbar - это расположение кнопок на панели и положение самой панели, для TMRUManager - список строк, для TRxDBGrid - ширины и положение полей в таблице и т.д. Все компоненты, имеющие свойство IniStorage, имеют также методы для сохранения и восстановления их настроек вручную, такие как Save/RestoreLayout и т.д.

+ + Набор флагов, управляющих поведением RxDBGrid + Этот клас представляет собой колонку в RxDBGrid + Конструктор TRxColumnКонструктор constructor TRxColumn.Create(ACollection: TCollection); +Создаёт класс столбца и заполняет начальные значения + Тип описывает событие, возникающее во время операции быстрого поиска данных в спикеТип описывает событие, возникающее во время операции быстрого поиска данных в спике + Маркер направления сортировки

Маркер направления сортировки.

Определяет отображение маркера сортировки в заголовке столбца RxDBGrid-а.

+ + + + +
ПараметрОписание
smNoneНе отображать маркер
smDownОтображать маркер "Вниз" - прямая сортировка
smUpОтображать маркер "Вверх" - обратная сортировка
+ + Данный тип описывает событие при отображении в списке заголовка колонки

Данный тип описывает событие при отображении в списке заголовка колонки

+ + + + + + + +
ПараметрТипОписание
Sender: TObjectВх.Указывает на экземпляр объекта RxDBGrid +
Field: TFieldВх.Определяет колонку, для которой необходимо определить параметры
AFont: TFontВх.С помощью данного объекта можно указать параметры шрифта заголовка
Background: TColorВых.Можно указать цвет фона заголовка колонки
SortMarker: TSortMarkerВых.Можно указать тип маркера сортировки +
IsDown: BooleanВх.Определяет, был ли клик мышкой по данному заголовку
+ + Данный тип описывает событие получения параметров ячейки в RxDBGrid-е

Данный тип описывает событие получения параметров ячейки в RxDBGrid-е

+ + + + + +
ПараметрТип параметраОписание
Sender: TObjectвх.Указывает на экземпляр объекта RxDBGrid +
Field: TFieldвх.Определяет колонку, для которой произошло событие
AFont: TFontвх.С помощью данного объекта можно указать параметры шрифта ячейки
Background: TColorвых.Можно указать цвет фона ячейки
+ + Определяем тип занчения, автоматически расчитываемого в итоговой строке

Определяем тип занчения, автоматически расчитываемого в итоговой строке

+ + + + + + + + + + +
ПараметрЗначение
fvtNonПо умолчанию, ничего не отображаем
fvtSumОтображается сумма по указанной колонке
fvtAvgРасчитывается среднее значение по указанной колонке
fvtCountОтображается общее количество строк в списке
fvtFieldValueОтображается значение указанной колонки
fvtStaticTextОтображается текст из поля Value +
fvtMinОтображается минимальное значние указанного в свойстве FieldNameполя
fvtMaxОтображается максимальное значние указанного в свойстве FieldNameполя
fvtRecNoОтображается номер текущей записи из списка
+ + Набор флагов, управляющих поведением RxDBGrid

Набор флагов, управляющих поведением RxDBGrid +

+ + + + + + + + + + + + + + + + + +
ПараметрОписание
rdgAllowColumnsFormРазрешает вызов формы управления отображением и порядком расположения колонок в RxDBGrid-е
rdgAllowDialogFindРазрешает вызов формы поиска данных в RxDBGrid-е
rdgHighlightFocusColПодсвечивать текущую колонку
rdgHighlightFocusRowПодсвечивать текущую строку
rdgDblClickOptimizeColWidthПри двойном щелчке по разделителю между колонками в RxDBGrid-е автоматически подбирать размер колонки по ширине отображаемых данных
rdgFooterRowsОтображать итоговую строку (подвал) спика
rdgXORColSizingПри изменении размера колонки отображать только будущую границу колонки, саму колонку при этом не менять. В противном случае при изменении размера ширина колонки меняется сразу. Параметр полезен для медленных компьютеров или терминального режима
rdgFilterРазрешить локальную фильтрацию данных
rdgMultiTitleLinesРазрешить объединение заголовков колонок
rdgMrOkOnDblClikПри двойном щелчке мышки генерировать для формы-владельца грида событие mrOk - полезно при создании формы выбора из списка
rdgAllowQuickSearchРазрешить быстрыый поиск в гриде - в этом режиме нажатие клавиш включет механизм встроенного поиска по текущей колонке, прямое редактирование в списке будет запрещено.
rdgAllowQuickFilterРазрешить быструю фильтрацию в колонках - в заголовке списка будет доступна по нажатию клавиши Ctrl+E дополнительная строка, содержащая ComboBox-ы со значениями колонок. Аналогично сортировки в электронных таблицах.
rdgAllowFilterFormРазрешает к использованию форму фильтрации в RxDBGrid-е
rdgAllowSortFormРазрешает к использованию формы сортировки данных в RxDBGrid-е
rdgAllowToolMenuВключает отображение меню инструментов в RxDBGrid-е. При активации данного параметра в верхнем левом углу грида отрисовывается специальный значок и при его нажатии мышкой выдаётся меню иснтрументов
rdgCaseInsensitiveSortПараметр включает режим сортировки без учёта регистра символов в столбце RxDBGrid-а
+ + Параметры для столбца RxDBGridСписок флагов для настройки поведения столбца грида.

coCustomizeVisible - колонка доступна в окне настроки столбцов грида

coCustomizeWidth - разрешено изменять ширину колонки

coFixDecimalSeparator - при вводе значений в редакторе будет проверяться и исправляться запятая и точка в числовых значениях

coDisableDialogFind - запрет поиска по данной колонке в окне поиска

+ + запрет поиска по данной колонке в окне поиска + разрешено изменять ширину колонки + при вводе значений в редакторе будет проверяться и исправляться запятая и точка в числовых значениях + колонка доступна в окне настроки столбцов грида + Событие возникает при отрисовке итоговой строкСобытие возникает при отрисовке итоговой строк + Событие возникает при расчёте итоговой строкСобытие возникает при расчёте итоговой строк + Признак необходимости отрисовки вертикальных линий сетки до итоговой строкиПризнак необходимости отрисовки вертикальных линий сетки до итоговой строки diff --git a/components/rx/trunk/docs/rxfpc.xml b/components/rx/trunk/docs/rxfpc.xml index c11bd9ae0..c8969dad6 100644 --- a/components/rx/trunk/docs/rxfpc.xml +++ b/components/rx/trunk/docs/rxfpc.xml @@ -2660,181 +2660,6 @@ Description - - - Класс TRxVersionInfo предоставляет доступ к информации о версии программы - -

Класс TRxVersionInfo предоставляет доступ к информации о версии программы.

-

После создания объекта этого класса вы можете получить доступ к информации из ресурса VERSIONINFO через свойства (только-для-чтения) объекта, если чтение ресурса из специфицированного файла окончилось успешно. Вы можете проверить результат чтения информации из файла по значению свойства Valid - значение True соответствует успешному чтению данных. При изменении свойства, задающего имя исполняемого файла с ресурсом VERSIONINFO, происходит обновление данных объекта. Успешность обновления можно также проверить по значению свойства Valid. -

-

Данный класс предоставляет информацию о наиболее часто используемых свойствах скомпилируемого исполняемого модуля. Фактически является надстройкой над пакетом fpc fcl-res -

- - - Модуль RxVersInfo содержит инструменты доступа к информации о версии программы - Модуль RxVersInfo содержит инструменты доступа к информации о версии программы - - procedure LoadFromFile(const AFileName:string); - Процедура загружает данные о версии указанного исполняемого модуля - - - property FileName: string - Свойство указываеет - - - Создаёт объект и загружает данные о версии программы вызовом метода LoadFromFile - - - - - - property Valid: Boolean; - Свойство Valid (только-для-чтения) позволяет вам определить результат чтения данных с информацией о версии из специфицированного исполняемого файла. Значение True говорит о том, что чтение данных прошло успешно, в противном случае Valid = False. - - - Свойство задает имя исполняемого файла (EXE или DLL), из которого считывается информация о версии. При изменении значения свойства FileName происходит чтение ресурса VERSIONINFO из указанного файла. Если чтение данных окончилось успешно, свойство Valid (только чтение) устанавливается в значение True, иначе - в False. - - - - Значение свойства представляет собой указатель на массив идентификаторов языка (language) и набора символов (character-set), используемых при чтении данных из ресурса с информацией о версии. - - - Идентификатор языка (language), используемого при чтении информации из ресурса. - - - Идентификатор набора символов (character-set), используемого при чтении информации из ресурса - - - Свойство определяет номер версии файла как длинное целое. - - - Свойство позволяет получить строку из информации о версии, обозначенную как комментарий. - - - Свойство для доступа к строке из иформации о версии, специфицирующей имя компании-производителя. - - - Свойство для доступа к описанию исполнимого файла из информации о версии. - - - Свойство для доступа к строке, содержащей номер версии файла, полученной из ресурса типа VERSIONINFO. - - - Свойство для доступа к строке, содержашей "внутреннее" имя файла, если оно присутствует в информации о версии. Это, например, может быть имя модуля, если файл является динамически загружаемой библиотекой (DLL). - - - Свойство для доступа к строке из иформации о версии, специфицирующей авторские права. - - - Свойство для доступа к строке из иформации о версии, специфицирующей товарные знаки и зарегистрированные товарные знаки, применимые к файлу. - - - Свойство для доступа к строке из иформации о версии, специфицирующей оригинальное (первоначальное) имя файла (не включая путь). Эта информация может понадобиться, если файл переименован пользователем. - - - Свойство для доступа к строке, содержащей номер версии продукта, полученной из ресурса типа VERSIONINFO, например "3.10" или "5.00.RC2". - - - Свойство для доступа к имени продукта из информации о версии. Распространение продукта обычно производится с этим именем. - - - Свойство для доступа к строке из иформации о версии, содержащей частную (конфиденциальную) информацию о предварительной версии продукта. Как правило, в окончательных версиях исполняемых файлов такая информация отсутствует. - - - Свойство для доступа к строке из иформации о версии, содержащей частную (конфиденциальную) информацию о предварительной версии продукта. Как правило, в окончательных версиях исполняемых файлов такая информация отсутствует. - - - Values Property - Свойство предоставляет доступ к любой текстовой информации из ресурса VERSIONINFO. Считываемая строка задается параметром Name. - - - - - - Параметры отображени окна информации о программе - -

Параметры отображени окна информации о программе

- - - - - - - - - - - - - - - - -
- ЗначениеОписание
radHelpButtonОтображать кнопку "Помощь"
radLicenseTabОтображать закладку лицензии
radShowImageLogoОтображать логотип на первой закладке
- - - - Параметры окна "О программе" - -

Набор флагов, определяющий -параметры отображения окна информации о программе

- - - - - - - - Компонента TRXAboutDialog предназначена для отображения информации о программе. - - - Конструктор создаёт экземпляр класса - Конструктор создаёт экземпляр класса - - - Уничтожает экземпляр класса - Уничтожает экземпляр класса - - - Метод отображет окно "О программе" - Метод отображет окно "О программе" - - - Параметры окна "О программе" - -

Набор флагов, определяющий -параметры отображения окна информации о программе

- - - - - - - Заголовок программы - Заголовок программы, выводимый на первой странице она - - - Файл лицензии - - - Заголовок окна - Заголовок окна - - - Логотип, отображаемый в окне "О программе" - Изображение логотипа - - - - - Класс представляет собой форму "О программе" - Класс представляет собой форму "О программе" - - - Загружает на страницу "Лицензия" формы "О программе" файл лицензионного соглашения - - diff --git a/components/rx/trunk/docs/rxinipropstorage.xml b/components/rx/trunk/docs/rxinipropstorage.xml new file mode 100644 index 000000000..54698cf4a --- /dev/null +++ b/components/rx/trunk/docs/rxinipropstorage.xml @@ -0,0 +1,8 @@ + +Модуль содержит компонент для визуального сохранения данных формыМодуль содержит компонент для визуального сохранения данных формыКомпонент для визуального сохранения данных формы

Компонент для визуального сохранения данных формы

Отличается от стандартного возможностью сохранения данных в разных конфигурационных файлах.

Если SeparateFiles = true, то данных сохраняется в индивидуальные файлы для каждой формы. Имя файла формируется по наименованию класса формы.

+ + Признак хранения данных в индивидуальных файлах + + + + diff --git a/components/rx/trunk/docs/rxversinfo.xml b/components/rx/trunk/docs/rxversinfo.xml new file mode 100644 index 000000000..730f0cf5c --- /dev/null +++ b/components/rx/trunk/docs/rxversinfo.xml @@ -0,0 +1,32 @@ + +Класс TRxVersionInfo предоставляет доступ к информации о версии программы

Класс TRxVersionInfo предоставляет доступ к информации о версии программы.

После создания объекта этого класса вы можете получить доступ к информации из ресурса VERSIONINFO через свойства (только-для-чтения) объекта, если чтение ресурса из специфицированного файла окончилось успешно. Вы можете проверить результат чтения информации из файла по значению свойства Valid - значение True соответствует успешному чтению данных. При изменении свойства, задающего имя исполняемого файла с ресурсом VERSIONINFO, происходит обновление данных объекта. Успешность обновления можно также проверить по значению свойства Valid. +

Данный класс предоставляет информацию о наиболее часто используемых свойствах скомпилируемого исполняемого модуля. Фактически является надстройкой над пакетом fpc fcl-res +

+ + Модуль RxVersInfo содержит инструменты доступа к информации о версии программыМодуль RxVersInfo содержит инструменты доступа к информации о версии программыПроцедура загружает данные о версии указанного исполняемого модуля + Файл, для которого определяется информация по версии + Создаёт объект и загружает данные о версии программыСоздаёт объект и загружает данные о версии программы вызовом метода LoadFromFile + + Свойство Valid (только-для-чтения) позволяет вам определить результат чтения данных с информацией о версии из специфицированного исполняемого файла. Значение True говорит о том, что чтение данных прошло успешно, в противном случае Valid = False. + Свойство задает имя исполняемого файла (EXE или DLL), из которого считывается информация о версии.Свойство задает имя исполняемого файла (EXE или DLL), из которого считывается информация о версии. При изменении значения свойства FileName происходит чтение ресурса VERSIONINFO из указанного файла. Если чтение данных окончилось успешно, свойство Valid (только чтение) устанавливается в значение True, иначе - в False. + Значение свойства представляет собой указатель на массив идентификаторов языка (language) и набора символов (character-set), используемых при чтении данных из ресурса с информацией о версии. + Идентификатор языка (language), используемого при чтении информации из ресурса + Идентификатор набора символов (character-set), используемого при чтении информации из ресурса + Свойство определяет номер версии файла как длинное целое. + Свойство позволяет получить строку из информации о версии, обозначенную как комментарий + Свойство для доступа к строке из иформации о версии, специфицирующей имя компании-производителя + Свойство для доступа к описанию исполнимого файла из информации о версии + Свойство для доступа к строке, содержащей номер версии файла, полученной из ресурса типа VERSIONINFO. + Свойство для доступа к строке, содержашей "внутреннее" имя файла, если оно присутствует в информации о версии. Это, например, может быть имя модуля, если файл является динамически загружаемой библиотекой (DLL). + Свойство для доступа к строке из иформации о версии, специфицирующей авторские права + Свойство для доступа к строке из иформации о версии, специфицирующей товарные знаки и зарегистрированные товарные знаки, применимые к файлу + Свойство для доступа к строке из иформации о версии, специфицирующей оригинальное (первоначальное) имя файла (не включая путь). Эта информация может понадобиться, если файл переименован пользователем + Свойство для доступа к строке, содержащей номер версии продукта, полученной из ресурса типа VERSIONINFO, например "3.10" или "5.00.RC2" + Свойство для доступа к имени продукта из информации о версии. Распространение продукта обычно производится с этим именем + Свойство для доступа к строке из иформации о версии, содержащей частную (конфиденциальную) информацию о предварительной версии продукта. Как правило, в окончательных версиях исполняемых файлов такая информация отсутствует + Свойство для доступа к строке из иформации о версии, содержащей частную (конфиденциальную) информацию о предварительной версии продукта. Как правило, в окончательных версиях исполняемых файлов такая информация отсутствует + Свойство предоставляет доступ к любой текстовой информации из ресурса VERSIONINFOСвойство предоставляет доступ к любой текстовой информации из ресурса VERSIONINFO. Считываемая строка задается параметром Name. + + + +