You've already forked lazarus-ccr
RxFPC: documentation
git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@4333 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
alexs75
@ -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
|
||||
|
||||
24
components/rx/trunk/docs/rxaboutdialog.xml
Normal file
24
components/rx/trunk/docs/rxaboutdialog.xml
Normal file
@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="rxnew"><module name="RxAboutDialog"><element name="TRxAboutDialogOption"><short>Параметры отображени окна информации о программе</short><descr><p>Параметры отображени окна информации о программе</p><table><th><td>Значение</td><td>Описание</td>
|
||||
</th><tr><td>radHelpButton</td><td>Отображать кнопку "Помощь"</td>
|
||||
</tr><tr><td>radLicenseTab</td><td>Отображать закладку лицензии</td>
|
||||
</tr><tr><td>radShowImageLogo</td><td>Отображать логотип на первой закладке</td>
|
||||
</tr>
|
||||
</table>
|
||||
</descr>
|
||||
</element><short>Модуль содержит компонент для окна О Программе</short><element name="TRxAboutDialogOptions"><short>Параметры окна "О программе"</short>
|
||||
</element><element name="TRxAboutDialog"><short>Компонента TRXAboutDialog предназначена для отображения информации о программе</short>
|
||||
</element><element name="TRxAboutDialog.Create"><short>Конструктор создаёт экземпляр класса</short>
|
||||
</element><element name="TRxAboutDialog.Destroy"><short>Уничтожает экземпляр класса</short>
|
||||
</element><element name="TRxAboutDialog.Execute"><short>Метод отображет окно "О программе"</short>
|
||||
</element><element name="TRxAboutDialog.Options"><short>Параметры окна "О программе"</short><descr><p>Набор флагов, определяющий
|
||||
<link id="TRxAboutDialogOption">параметры</link> отображения окна информации о программе</p>
|
||||
</descr><seealso>TRxAboutDialogOptions</seealso>
|
||||
</element><element name="TRxAboutDialog.ApplicationTitle"><short>Заголовок программы, выводимый на первой странице она</short>
|
||||
</element><element name="TRxAboutDialog.LicenseFileName"><short>Файл лицензии</short>
|
||||
</element><element name="TRxAboutDialog.Caption"><short>Заголовок окна</short>
|
||||
</element><element name="TRxAboutDialog.Picture"><short>Логотип, отображаемый в окне "О программе"</short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
22
components/rx/trunk/docs/rxcloseformvalidator.xml
Normal file
22
components/rx/trunk/docs/rxcloseformvalidator.xml
Normal file
@ -0,0 +1,22 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="rxnew"><module name="RxCloseFormValidator"><short>Модуль содержит объекты проверки допустимости введённых данных диалоговых окон</short><descr>Модуль содержит объекты проверки допустимости введённых данных диалоговых окон</descr><element name="TValidateItem"><short>Элемент проверки данных</short>
|
||||
</element><element name="TValidateItem.CheckClose"><short>Метод проверки допустимости введённых данных</short>
|
||||
</element><element name="TValidateItem.ErrorMessage"><short>Сформированная строка сообщения об ошибке</short>
|
||||
</element><element name="TValidateItem.SetFocus"><short>Метод установит фокус клавиатурного ввода в проверяемые контрол</short>
|
||||
</element><element name="TValidateItem.Control"><short>Контрол, в котором происходт проверка введённых данных</short>
|
||||
</element><element name="TValidateItem.Enabled"><short>Признак необходимости выполнять проверку казанного контрола</short>
|
||||
</element><element name="TValidateItem.FieldCaption"><short>Эаголовок проверяемого контрола</short><descr><p>Эаголовок проверяемого контрола</p><p>Используется при формировании сообщения об ошибке</p>
|
||||
</descr>
|
||||
</element><element name="TValidateItem.OnValidate"><short>Событие для ручной проверки допустимости введённых данных</short>
|
||||
</element><element name="TValidateItems"><short>Колекция элементов проверки введённых данных</short>
|
||||
</element><element name="TRxCloseFormValidator"><short>Компонент визуальной настроки проверки введённых данных на диалоговых формах</short><descr>Компонент визуальной настроки проверки введённых данных на диалоговых формах</descr>
|
||||
</element><element name="TRxCloseFormValidator.CheckCloseForm"><short>Функция производит проверку введённых данных</short><descr><p>Функция производит проверку введённых данных</p><p>В случае ошбочных данных вернёт <var>false</var>.</p>
|
||||
</descr>
|
||||
</element><element name="TRxCloseFormValidator.ByControl.AControl"><short>Поиск элемента проверки по указателю на контрол</short>
|
||||
</element><element name="TRxCloseFormValidator.ErrorMsgCaption"><short>Общая маска сообщения об ошибке</short>
|
||||
</element><element name="TRxCloseFormValidator.Items"><short>Колекция элементов проверки введённых данных</short>
|
||||
</element><element name="TRxCloseFormValidator.IgnoreDisabled"><short>Признак того, что запрещённые контролы проверки не подлежат </short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
@ -3,6 +3,89 @@
|
||||
</descr>
|
||||
</element><element name="TRxDBGrid.BeforeQuickSearch"><short>Событие, возникающее до выполнения операции быстрого поиска данных в спике</short>
|
||||
</element><element name="TRxDBGrid.AfterQuickSearch"><short>Событие, возникающее после выполнения операции быстрого поиска данных в спике</short>
|
||||
</element><element name="TRxDBGrid.OnGetBtnParams"><short>Данный тип описывает событие при отображении в списке заголовка колонки</short>
|
||||
</element><element name="TRxDBGrid.TitleButtons"><short>Свойство определяет, могут ли заголовки колонок в Grid-е быть использованы как кнопки.</short><descr>Свойство определяет, могут ли заголовки колонок в Grid-е быть использованы как кнопки. По умолчанию - False.
|
||||
При установке свойства в значение True Вы можете обработать события OnTitleBtnClick для обработки нажатия на такую кнопку и OnCheckButton, OnGetBtnParams для установки свойств кнопок в заголовке.</descr>
|
||||
</element><element name="TRxDBGrid.OnGetCellProps"><short>Событие получения параметров ячейки в RxDBGrid-е</short>
|
||||
</element><element name="TRxDBGrid.PropertyStorage"><short>Свойство позволяет автоматически сохранять специфические установки компоненты в INI-файле</short><descr><p>Свойство позволяет автоматически сохранять специфические установки компоненты в INI-файле или (для 32-разрядной версии) в системном регистре при помощи компонент TFormPlacement или TFormStorage. </p><p>При задании значения свойству IniStorage (и непустом имени компоненты), некоторые ее настройки, которые не являются published-свойствами и не могут быть заданы для TFormStorage напрямую, будут сохраняться и восстанавливаться одновременни с другими значениями, заданными для соответствующей компоненты TFormPlacement (TFormStorage). </p><p>Для TSpeedbar - это расположение кнопок на панели и положение самой панели, для TMRUManager - список строк, для TRxDBGrid - ширины и положение полей в таблице и т.д. Все компоненты, имеющие свойство IniStorage, имеют также методы для сохранения и восстановления их настроек вручную, такие как Save/RestoreLayout и т.д.</p>
|
||||
</descr>
|
||||
</element><element name="TRxDBGrid.OptionsRx"><short>Набор флагов, управляющих поведением RxDBGrid</short>
|
||||
</element><element name="TRxColumn"><short>Этот клас представляет собой колонку в RxDBGrid</short>
|
||||
</element><element name="TRxColumn.Create"><short>Конструктор TRxColumn</short><descr>Конструктор constructor <b>TRxColumn.Create(ACollection: TCollection);</b>
|
||||
Создаёт класс столбца и заполняет начальные значения</descr>
|
||||
</element><element name="TRxQuickSearchNotifyEvent"><short>Тип описывает событие, возникающее во время операции быстрого поиска данных в спике</short><descr>Тип описывает событие, возникающее во время операции быстрого поиска данных в спике</descr>
|
||||
</element><element name="TSortMarker"><short>Маркер направления сортировки</short><descr><p>Маркер направления сортировки.</p><p>Определяет отображение маркера сортировки в заголовке столбца RxDBGrid-а.</p><table><th><td>Параметр</td><td>Описание</td>
|
||||
</th><tr><td>smNone</td><td>Не отображать маркер</td>
|
||||
</tr><tr><td>smDown</td><td>Отображать маркер "Вниз" - прямая сортировка</td>
|
||||
</tr><tr><td>smUp</td><td>Отображать маркер "Вверх" - обратная сортировка</td>
|
||||
</tr>
|
||||
</table>
|
||||
</descr>
|
||||
</element><element name="TGetBtnParamsEvent"><short>Данный тип описывает событие при отображении в списке заголовка колонки</short><descr><p>Данный тип описывает событие при отображении в списке заголовка колонки</p><table><th><td>Параметр</td><td>Тип</td><td>Описание</td>
|
||||
</th><tr><td>Sender: TObject</td><td>Вх.</td><td>Указывает на экземпляр объекта <link id="TRxDBGrid">RxDBGrid</link>
|
||||
</td>
|
||||
</tr><tr><td>Field: TField</td><td>Вх.</td><td>Определяет колонку, для которой необходимо определить параметры</td>
|
||||
</tr><tr><td>AFont: TFont</td><td>Вх.</td><td>С помощью данного объекта можно указать параметры шрифта заголовка</td>
|
||||
</tr><tr><td>Background: TColor</td><td>Вых.</td><td>Можно указать цвет фона заголовка колонки</td>
|
||||
</tr><tr><td>SortMarker: TSortMarker</td><td>Вых.</td><td>Можно указать <link id="TSortMarker">тип маркера сортировки</link>
|
||||
</td>
|
||||
</tr><tr><td>IsDown: Boolean</td><td>Вх.</td><td>Определяет, был ли клик мышкой по данному заголовку</td>
|
||||
</tr>
|
||||
</table>
|
||||
</descr>
|
||||
</element><element name="TGetCellPropsEvent"><short>Данный тип описывает событие получения параметров ячейки в RxDBGrid-е</short><descr><p>Данный тип описывает событие получения параметров ячейки в <link id="TRxDBGrid">RxDBGrid</link>-е</p><table><th><td>Параметр</td><td>Тип параметра</td><td>Описание</td>
|
||||
</th><tr><td>Sender: TObject</td><td>вх.</td><td>Указывает на экземпляр объекта <link id="TRxDBGrid">RxDBGrid</link>
|
||||
</td>
|
||||
</tr><tr><td>Field: TField</td><td>вх.</td><td>Определяет колонку, для которой произошло событие</td>
|
||||
</tr><tr><td>AFont: TFont</td><td>вх.</td><td>С помощью данного объекта можно указать параметры шрифта ячейки</td>
|
||||
</tr><tr><td>Background: TColor</td><td>вых.</td><td>Можно указать цвет фона ячейки</td>
|
||||
</tr>
|
||||
</table>
|
||||
</descr>
|
||||
</element><element name="TFooterValueType"><short>Определяем тип занчения, автоматически расчитываемого в итоговой строке</short><descr><p>Определяем тип занчения, автоматически расчитываемого в итоговой строке</p><table><th><td>Параметр</td><td>Значение</td>
|
||||
</th><tr><td>fvtNon</td><td>По умолчанию, ничего не отображаем</td>
|
||||
</tr><tr><td>fvtSum</td><td>Отображается сумма по указанной колонке</td>
|
||||
</tr><tr><td>fvtAvg</td><td>Расчитывается среднее значение по указанной колонке</td>
|
||||
</tr><tr><td>fvtCount</td><td>Отображается общее количество строк в списке</td>
|
||||
</tr><tr><td>fvtFieldValue</td><td>Отображается значение указанной колонки</td>
|
||||
</tr><tr><td>fvtStaticText</td><td>Отображается текст из поля <link id="TRxColumnFooter.Value">Value</link>
|
||||
</td>
|
||||
</tr><tr><td>fvtMin</td><td>Отображается минимальное значние указанного в свойстве <link id="TRxColumnFooter.FieldName">FieldName</link>поля</td>
|
||||
</tr><tr><td>fvtMax</td><td>Отображается максимальное значние указанного в свойстве <link id="TRxColumnFooter.FieldName">FieldName</link>поля</td>
|
||||
</tr><tr><td>fvtRecNo</td><td>Отображается номер текущей записи из списка</td>
|
||||
</tr>
|
||||
</table>
|
||||
</descr>
|
||||
</element><element name="TOptionRx"><short>Набор флагов, управляющих поведением RxDBGrid</short><descr><p>Набор флагов, управляющих поведением <link id="TRxDBGrid">RxDBGrid</link>
|
||||
</p><table><th><td>Параметр</td><td>Описание</td>
|
||||
</th><tr><td>rdgAllowColumnsForm</td><td>Разрешает вызов формы управления отображением и порядком расположения колонок в <link id="TRxDBGrid">RxDBGrid</link>-е</td>
|
||||
</tr><tr><td>rdgAllowDialogFind</td><td>Разрешает вызов формы поиска данных в <link id="TRxDBGrid">RxDBGrid</link>-е</td>
|
||||
</tr><tr><td>rdgHighlightFocusCol</td><td>Подсвечивать текущую колонку</td>
|
||||
</tr><tr><td>rdgHighlightFocusRow</td><td>Подсвечивать текущую строку</td>
|
||||
</tr><tr><td>rdgDblClickOptimizeColWidth</td><td>При двойном щелчке по разделителю между колонками в <link id="TRxDBGrid">RxDBGrid</link>-е автоматически подбирать размер колонки по ширине отображаемых данных</td>
|
||||
</tr><tr><td>rdgFooterRows</td><td>Отображать итоговую строку (подвал) спика</td>
|
||||
</tr><tr><td>rdgXORColSizing</td><td>При изменении размера колонки отображать только будущую границу колонки, саму колонку при этом не менять. В противном случае при изменении размера ширина колонки меняется сразу. Параметр полезен для медленных компьютеров или терминального режима</td>
|
||||
</tr><tr><td>rdgFilter</td><td>Разрешить локальную фильтрацию данных</td>
|
||||
</tr><tr><td>rdgMultiTitleLines</td><td>Разрешить объединение заголовков колонок</td>
|
||||
</tr><tr><td>rdgMrOkOnDblClik</td><td>При двойном щелчке мышки генерировать для формы-владельца грида событие mrOk - полезно при создании формы выбора из списка</td>
|
||||
</tr><tr><td>rdgAllowQuickSearch</td><td>Разрешить быстрыый поиск в гриде - в этом режиме нажатие клавиш включет механизм встроенного поиска по текущей колонке, прямое редактирование в списке будет запрещено. </td>
|
||||
</tr><tr><td>rdgAllowQuickFilter</td><td>Разрешить быструю фильтрацию в колонках - в заголовке списка будет доступна по нажатию клавиши <b>Ctrl+E</b> дополнительная строка, содержащая ComboBox-ы со значениями колонок. Аналогично сортировки в электронных таблицах.</td>
|
||||
</tr><tr><td>rdgAllowFilterForm</td><td>Разрешает к использованию форму фильтрации в <link id="TRxDBGrid">RxDBGrid</link>-е</td>
|
||||
</tr><tr><td>rdgAllowSortForm</td><td>Разрешает к использованию формы сортировки данных в <link id="TRxDBGrid">RxDBGrid</link>-е</td>
|
||||
</tr><tr><td>rdgAllowToolMenu</td><td>Включает отображение меню инструментов в <link id="TRxDBGrid">RxDBGrid</link>-е. При активации данного параметра в верхнем левом углу грида отрисовывается специальный значок и при его нажатии мышкой выдаётся меню иснтрументов</td>
|
||||
</tr><tr><td>rdgCaseInsensitiveSort</td><td>Параметр включает режим сортировки без учёта регистра символов в столбце <link id="TRxDBGrid">RxDBGrid</link>-а</td>
|
||||
</tr>
|
||||
</table>
|
||||
</descr>
|
||||
</element><element name="TRxColumnOption"><short>Параметры для столбца RxDBGrid</short><descr><b>Список флагов для настройки поведения столбца грида.</b><p>coCustomizeVisible - колонка доступна в окне настроки столбцов грида</p><p>coCustomizeWidth - разрешено изменять ширину колонки</p><p>coFixDecimalSeparator - при вводе значений в редакторе будет проверяться и исправляться запятая и точка в числовых значениях</p><p>coDisableDialogFind - запрет поиска по данной колонке в окне поиска</p>
|
||||
</descr>
|
||||
</element><element name="TRxColumnOption.coDisableDialogFind"><short>запрет поиска по данной колонке в окне поиска</short>
|
||||
</element><element name="TRxColumnOption.coCustomizeWidth"><short>разрешено изменять ширину колонки</short>
|
||||
</element><element name="TRxColumnOption.coFixDecimalSeparator"><short>при вводе значений в редакторе будет проверяться и исправляться запятая и точка в числовых значениях</short>
|
||||
</element><element name="TRxColumnOption.coCustomizeVisible"><short>колонка доступна в окне настроки столбцов грида</short>
|
||||
</element><element name="TRxDBGrid.OnRxColumnFooterDraw"><short>Событие возникает при отрисовке итоговой строк</short><descr>Событие возникает при отрисовке итоговой строк</descr>
|
||||
</element><element name="TRxDBGrid.OnRxCalcFooterValues"><short>Событие возникает при расчёте итоговой строк</short><descr>Событие возникает при расчёте итоговой строк</descr>
|
||||
</element><element name="TRxDBGrid.DrawFullLine"><short>Признак необходимости отрисовки вертикальных линий сетки до итоговой строки</short><descr>Признак необходимости отрисовки вертикальных линий сетки до итоговой строки</descr>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
|
||||
@ -2660,181 +2660,6 @@ Description
|
||||
</descr>
|
||||
</element>
|
||||
</module>
|
||||
<module name="RxVersInfo">
|
||||
<element name="TRxVersionInfo">
|
||||
<short>Класс TRxVersionInfo предоставляет доступ к информации о версии программы</short>
|
||||
<descr>
|
||||
<p>Класс TRxVersionInfo предоставляет доступ к информации о версии программы. </p>
|
||||
<p>После создания объекта этого класса вы можете получить доступ к информации из ресурса VERSIONINFO через свойства (только-для-чтения) объекта, если чтение ресурса из специфицированного файла окончилось успешно. Вы можете проверить результат чтения информации из файла по значению свойства <link id="TRxVersionInfo.Valid">Valid</link> - значение True соответствует успешному чтению данных. При изменении свойства, задающего имя исполняемого файла с ресурсом VERSIONINFO, происходит обновление данных объекта. Успешность обновления можно также проверить по значению свойства <link id="TRxVersionInfo.Valid">Valid</link>.
|
||||
</p>
|
||||
<p>Данный класс предоставляет информацию о наиболее часто используемых свойствах скомпилируемого исполняемого модуля. Фактически является надстройкой над пакетом fpc <b>fcl-res</b>
|
||||
</p>
|
||||
</descr>
|
||||
</element>
|
||||
<short>Модуль RxVersInfo содержит инструменты доступа к информации о версии программы</short>
|
||||
<descr>Модуль RxVersInfo содержит инструменты доступа к информации о версии программы</descr>
|
||||
<element name="TRxVersionInfo.LoadFromFile">
|
||||
<short>procedure LoadFromFile(const AFileName:string);</short>
|
||||
<descr>Процедура загружает данные о версии указанного исполняемого модуля</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.FileName">
|
||||
<short>property FileName: string</short>
|
||||
<descr>Свойство указываеет</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.Create">
|
||||
<descr>Создаёт объект и загружает данные о версии программы вызовом метода <link id="TRxVersionInfo.LoadFromFile">LoadFromFile</link>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.Destroy"/>
|
||||
<element name="TRxVersionInfo.Valid">
|
||||
<short>
|
||||
<b>property</b> Valid: Boolean;</short>
|
||||
<descr>Свойство Valid (только-для-чтения) позволяет вам определить результат чтения данных с информацией о версии из специфицированного исполняемого файла. Значение True говорит о том, что чтение данных прошло успешно, в противном случае Valid = False.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.FileLongVersion">
|
||||
<descr>Свойство задает имя исполняемого файла (EXE или DLL), из которого считывается информация о версии. При изменении значения свойства FileName происходит чтение ресурса VERSIONINFO из указанного файла. Если чтение данных окончилось успешно, свойство <link id="TRxVersionInfo.Valid">Valid</link> (только чтение) устанавливается в значение True, иначе - в False.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.ProductLongVersion"/>
|
||||
<element name="TRxVersionInfo.Translation">
|
||||
<descr>Значение свойства представляет собой указатель на массив идентификаторов языка (language) и набора символов (character-set), используемых при чтении данных из ресурса с информацией о версии.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.VersionLanguage">
|
||||
<descr>Идентификатор языка (language), используемого при чтении информации из ресурса.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.VersionCharSet">
|
||||
<descr>Идентификатор набора символов (character-set), используемого при чтении информации из ресурса</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.VersionNum">
|
||||
<descr>Свойство определяет номер версии файла как длинное целое.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.Comments">
|
||||
<descr>Свойство позволяет получить строку из информации о версии, обозначенную как комментарий.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.CompanyName">
|
||||
<descr>Свойство для доступа к строке из иформации о версии, специфицирующей имя компании-производителя.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.FileDescription">
|
||||
<descr>Свойство для доступа к описанию исполнимого файла из информации о версии.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.FileVersion">
|
||||
<descr>Свойство для доступа к строке, содержащей номер версии файла, полученной из ресурса типа VERSIONINFO.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.InternalName">
|
||||
<descr>Свойство для доступа к строке, содержашей "внутреннее" имя файла, если оно присутствует в информации о версии. Это, например, может быть имя модуля, если файл является динамически загружаемой библиотекой (DLL).</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.LegalCopyright">
|
||||
<descr>Свойство для доступа к строке из иформации о версии, специфицирующей авторские права.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.LegalTrademarks">
|
||||
<descr>Свойство для доступа к строке из иформации о версии, специфицирующей товарные знаки и зарегистрированные товарные знаки, применимые к файлу.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.OriginalFilename">
|
||||
<descr>Свойство для доступа к строке из иформации о версии, специфицирующей оригинальное (первоначальное) имя файла (не включая путь). Эта информация может понадобиться, если файл переименован пользователем.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.ProductVersion">
|
||||
<descr>Свойство для доступа к строке, содержащей номер версии продукта, полученной из ресурса типа VERSIONINFO, например "3.10" или "5.00.RC2".</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.ProductName">
|
||||
<descr>Свойство для доступа к имени продукта из информации о версии. Распространение продукта обычно производится с этим именем.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.SpecialBuild">
|
||||
<descr>Свойство для доступа к строке из иформации о версии, содержащей частную (конфиденциальную) информацию о предварительной версии продукта. Как правило, в окончательных версиях исполняемых файлов такая информация отсутствует.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.PrivateBuild">
|
||||
<descr>Свойство для доступа к строке из иформации о версии, содержащей частную (конфиденциальную) информацию о предварительной версии продукта. Как правило, в окончательных версиях исполняемых файлов такая информация отсутствует.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.Values">
|
||||
<short>Values Property</short>
|
||||
<descr>Свойство предоставляет доступ к любой текстовой информации из ресурса VERSIONINFO. Считываемая строка задается параметром Name.</descr>
|
||||
</element>
|
||||
<element name="TRxVersionInfo.VerFileDate"/>
|
||||
</module>
|
||||
<module name="RxAboutDialog">
|
||||
<element name="TRxAboutDialogOption">
|
||||
<short>Параметры отображени окна информации о программе</short>
|
||||
<descr>
|
||||
<p>Параметры отображени окна информации о программе</p>
|
||||
<table>
|
||||
<th>
|
||||
<td>Значение</td>
|
||||
<td>Описание</td>
|
||||
</th>
|
||||
<tr>
|
||||
<td>radHelpButton</td>
|
||||
<td>Отображать кнопку "Помощь"</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>radLicenseTab</td>
|
||||
<td>Отображать закладку лицензии</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>radShowImageLogo</td>
|
||||
<td>Отображать логотип на первой закладке</td>
|
||||
</tr>
|
||||
</table>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TRxAboutDialogOptions">
|
||||
<short>Параметры окна "О программе"</short>
|
||||
<descr>
|
||||
<p>Набор флагов, определяющий
|
||||
<link id="TRxAboutDialogOption">параметры</link> отображения окна информации о программе</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TRxAboutDialogOption"/>
|
||||
<link id="TRxAboutDialog.Options"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TRxAboutDialog">
|
||||
<descr>Компонента TRXAboutDialog предназначена для отображения информации о программе.</descr>
|
||||
</element>
|
||||
<element name="TRxAboutDialog.Create">
|
||||
<short>Конструктор создаёт экземпляр класса</short>
|
||||
<descr>Конструктор создаёт экземпляр класса</descr>
|
||||
</element>
|
||||
<element name="TRxAboutDialog.Destroy">
|
||||
<short>Уничтожает экземпляр класса</short>
|
||||
<descr>Уничтожает экземпляр класса</descr>
|
||||
</element>
|
||||
<element name="TRxAboutDialog.Execute">
|
||||
<short>Метод отображет окно "О программе"</short>
|
||||
<descr>Метод отображет окно "О программе"</descr>
|
||||
</element>
|
||||
<element name="TRxAboutDialog.Options">
|
||||
<short>Параметры окна "О программе"</short>
|
||||
<descr>
|
||||
<p>Набор флагов, определяющий
|
||||
<link id="TRxAboutDialogOption">параметры</link> отображения окна информации о программе</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TRxAboutDialogOptions"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TRxAboutDialog.ApplicationTitle">
|
||||
<short>Заголовок программы</short>
|
||||
<descr>Заголовок программы, выводимый на первой странице она</descr>
|
||||
</element>
|
||||
<element name="TRxAboutDialog.LicenseFileName">
|
||||
<descr>Файл лицензии</descr>
|
||||
</element>
|
||||
<element name="TRxAboutDialog.Caption">
|
||||
<short>Заголовок окна</short>
|
||||
<descr>Заголовок окна</descr>
|
||||
</element>
|
||||
<element name="TRxAboutDialog.Picture">
|
||||
<short>Логотип, отображаемый в окне "О программе"</short>
|
||||
<descr>Изображение логотипа</descr>
|
||||
</element>
|
||||
</module>
|
||||
<module name="rxAboutFormUnit">
|
||||
<element name="TrxAboutFormForm">
|
||||
<short>Класс представляет собой форму "О программе"</short>
|
||||
<descr>Класс представляет собой форму "О программе"</descr>
|
||||
</element>
|
||||
<element name="TrxAboutFormForm.LoadLicense">
|
||||
<descr>Загружает на страницу "Лицензия" формы "О программе" файл лицензионного соглашения</descr>
|
||||
</element>
|
||||
</module>
|
||||
<module name="rxdbgrid_findunit"/>
|
||||
<module name="rxdbgrid_columsunit"/>
|
||||
<module name="RxViewsPanel">
|
||||
|
||||
8
components/rx/trunk/docs/rxinipropstorage.xml
Normal file
8
components/rx/trunk/docs/rxinipropstorage.xml
Normal file
@ -0,0 +1,8 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="rxnew"><module name="RxIniPropStorage"><short>Модуль содержит компонент для визуального сохранения данных формы</short><descr>Модуль содержит компонент для визуального сохранения данных формы</descr><element name="TRxIniPropStorage"><short>Компонент для визуального сохранения данных формы</short><descr><p>Компонент для визуального сохранения данных формы</p><p>Отличается от стандартного возможностью сохранения данных в разных конфигурационных файлах.</p><p>Если SeparateFiles = true, то данных сохраняется в индивидуальные файлы для каждой формы. Имя файла формируется по наименованию класса формы.</p>
|
||||
</descr>
|
||||
</element><element name="TRxIniPropStorage.SeparateFiles"><short>Признак хранения данных в индивидуальных файлах</short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
32
components/rx/trunk/docs/rxversinfo.xml
Normal file
32
components/rx/trunk/docs/rxversinfo.xml
Normal file
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions><package name="rxnew"><module name="RxVersInfo"><element name="TRxVersionInfo"><short>Класс TRxVersionInfo предоставляет доступ к информации о версии программы</short><descr><p>Класс TRxVersionInfo предоставляет доступ к информации о версии программы. </p><p>После создания объекта этого класса вы можете получить доступ к информации из ресурса VERSIONINFO через свойства (только-для-чтения) объекта, если чтение ресурса из специфицированного файла окончилось успешно. Вы можете проверить результат чтения информации из файла по значению свойства <link id="TRxVersionInfo.Valid">Valid</link> - значение True соответствует успешному чтению данных. При изменении свойства, задающего имя исполняемого файла с ресурсом VERSIONINFO, происходит обновление данных объекта. Успешность обновления можно также проверить по значению свойства <link id="TRxVersionInfo.Valid">Valid</link>.
|
||||
</p><p>Данный класс предоставляет информацию о наиболее часто используемых свойствах скомпилируемого исполняемого модуля. Фактически является надстройкой над пакетом fpc <b>fcl-res</b>
|
||||
</p>
|
||||
</descr>
|
||||
</element><short>Модуль RxVersInfo содержит инструменты доступа к информации о версии программы</short><descr>Модуль RxVersInfo содержит инструменты доступа к информации о версии программы</descr><element name="TRxVersionInfo.LoadFromFile"><short>Процедура загружает данные о версии указанного исполняемого модуля</short>
|
||||
</element><element name="TRxVersionInfo.FileName"><short>Файл, для которого определяется информация по версии</short>
|
||||
</element><element name="TRxVersionInfo.Create"><short>Создаёт объект и загружает данные о версии программы</short><descr>Создаёт объект и загружает данные о версии программы вызовом метода <link id="TRxVersionInfo.LoadFromFile">LoadFromFile</link>
|
||||
</descr>
|
||||
</element><element name="TRxVersionInfo.Valid"><short>Свойство Valid (только-для-чтения) позволяет вам определить результат чтения данных с информацией о версии из специфицированного исполняемого файла. Значение True говорит о том, что чтение данных прошло успешно, в противном случае Valid = False.</short>
|
||||
</element><element name="TRxVersionInfo.FileLongVersion"><short>Свойство задает имя исполняемого файла (EXE или DLL), из которого считывается информация о версии.</short><descr>Свойство задает имя исполняемого файла (EXE или DLL), из которого считывается информация о версии. При изменении значения свойства FileName происходит чтение ресурса VERSIONINFO из указанного файла. Если чтение данных окончилось успешно, свойство <link id="TRxVersionInfo.Valid">Valid</link> (только чтение) устанавливается в значение True, иначе - в False.</descr>
|
||||
</element><element name="TRxVersionInfo.Translation"><short>Значение свойства представляет собой указатель на массив идентификаторов языка (language) и набора символов (character-set), используемых при чтении данных из ресурса с информацией о версии.</short>
|
||||
</element><element name="TRxVersionInfo.VersionLanguage"><short>Идентификатор языка (language), используемого при чтении информации из ресурса</short>
|
||||
</element><element name="TRxVersionInfo.VersionCharSet"><short>Идентификатор набора символов (character-set), используемого при чтении информации из ресурса</short>
|
||||
</element><element name="TRxVersionInfo.VersionNum"><short>Свойство определяет номер версии файла как длинное целое.</short>
|
||||
</element><element name="TRxVersionInfo.Comments"><short>Свойство позволяет получить строку из информации о версии, обозначенную как комментарий</short>
|
||||
</element><element name="TRxVersionInfo.CompanyName"><short>Свойство для доступа к строке из иформации о версии, специфицирующей имя компании-производителя</short>
|
||||
</element><element name="TRxVersionInfo.FileDescription"><short>Свойство для доступа к описанию исполнимого файла из информации о версии</short>
|
||||
</element><element name="TRxVersionInfo.FileVersion"><short>Свойство для доступа к строке, содержащей номер версии файла, полученной из ресурса типа VERSIONINFO.</short>
|
||||
</element><element name="TRxVersionInfo.InternalName"><short>Свойство для доступа к строке, содержашей "внутреннее" имя файла, если оно присутствует в информации о версии. Это, например, может быть имя модуля, если файл является динамически загружаемой библиотекой (DLL).</short>
|
||||
</element><element name="TRxVersionInfo.LegalCopyright"><short>Свойство для доступа к строке из иформации о версии, специфицирующей авторские права</short>
|
||||
</element><element name="TRxVersionInfo.LegalTrademarks"><short>Свойство для доступа к строке из иформации о версии, специфицирующей товарные знаки и зарегистрированные товарные знаки, применимые к файлу</short>
|
||||
</element><element name="TRxVersionInfo.OriginalFilename"><short>Свойство для доступа к строке из иформации о версии, специфицирующей оригинальное (первоначальное) имя файла (не включая путь). Эта информация может понадобиться, если файл переименован пользователем</short>
|
||||
</element><element name="TRxVersionInfo.ProductVersion"><short>Свойство для доступа к строке, содержащей номер версии продукта, полученной из ресурса типа VERSIONINFO, например "3.10" или "5.00.RC2"</short>
|
||||
</element><element name="TRxVersionInfo.ProductName"><short>Свойство для доступа к имени продукта из информации о версии. Распространение продукта обычно производится с этим именем</short>
|
||||
</element><element name="TRxVersionInfo.SpecialBuild"><short>Свойство для доступа к строке из иформации о версии, содержащей частную (конфиденциальную) информацию о предварительной версии продукта. Как правило, в окончательных версиях исполняемых файлов такая информация отсутствует</short>
|
||||
</element><element name="TRxVersionInfo.PrivateBuild"><short>Свойство для доступа к строке из иформации о версии, содержащей частную (конфиденциальную) информацию о предварительной версии продукта. Как правило, в окончательных версиях исполняемых файлов такая информация отсутствует</short>
|
||||
</element><element name="TRxVersionInfo.Values"><short>Свойство предоставляет доступ к любой текстовой информации из ресурса VERSIONINFO</short><descr>Свойство предоставляет доступ к любой текстовой информации из ресурса VERSIONINFO. Считываемая строка задается параметром Name.</descr>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
Reference in New Issue
Block a user