paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-17 07:49:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: New documentation files for LCL. Issue #36785, patch from Don Siders.

Browse Source 
git-svn-id: trunk@62778 -
This commit is contained in:
juha 2020-03-20 10:15:35 +00:00
parent f5c35fba4b
commit a3d4d06bf1
7 changed files with 1703 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.gitattributes vendored
View File

@ -6288,7 +6288,9 @@ docs/xml/lcl/arrow.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/asyncprocess.xml svneol=native#text/plain
docs/xml/lcl/buttonpanel.xml svneol=native#text/plain
docs/xml/lcl/buttons.xml svneol=native#text/xml
docs/xml/lcl/calcform.xml -text svneol=native#text/plain
docs/xml/lcl/calendar.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/calendarpopup.xml -text svneol=native#text/plain
docs/xml/lcl/checklst.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/clipbrd.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/colorbox.xml svneol=LF#text/xml eol=lf
@ -6310,6 +6312,7 @@ docs/xml/lcl/dbactns.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/dbctrls.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/dbextctrls.xml svneol=native#text/plain
docs/xml/lcl/dbgrids.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/dblogdlg.xml -text svneol=native#text/plain
docs/xml/lcl/defaulttranslator.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/dialogs.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/dialogs/displaymessagebox.pas svneol=native#text/pascal
@ -6325,6 +6328,7 @@ docs/xml/lcl/extctrls/statusbar.pas svneol=native#text/plain
docs/xml/lcl/extdlgs.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/extgraphics.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/filectrl.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/finddlgunit.xml svneol=native#text/plain
docs/xml/lcl/forms.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/forms/tapplication_queueasynccall.pas svneol=native#text/plain
docs/xml/lcl/fpmake.xml svneol=native#text/plain
@ -6410,6 +6414,7 @@ docs/xml/lcl/postscriptunicode.xml svneol=native#text/plain
docs/xml/lcl/printers.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/propertystorage.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/registerlcl.xml svneol=native#text/plain
docs/xml/lcl/replacedlgunit.xml -text svneol=native#text/plain
docs/xml/lcl/rubberband.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/shellctrls.xml svneol=native#text/plain
docs/xml/lcl/spin.xml svneol=LF#text/xml eol=lf
@ -6417,6 +6422,7 @@ docs/xml/lcl/stdactns.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/stdctrls.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/stdctrls/tcustomcheckbox_allowgrayed.pas svneol=native#text/plain
docs/xml/lcl/themes.xml svneol=native#text/plain
docs/xml/lcl/timepopup.xml -text svneol=native#text/plain
docs/xml/lcl/tmschema.xml svneol=native#text/plain
docs/xml/lcl/toolwin.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/utrace.xml svneol=LF#text/xml eol=lf

642
docs/xml/lcl/calcform.xml Normal file
View File

@ -0,0 +1,642 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="LCL">
<!--
====================================================================
CalcForm
====================================================================
-->
<module name="CalcForm">
<short>Contains classes and types used in TCalculatorForm</short>
<descr/>
<!-- used units -->
<element name="System"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Forms"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="StdCtrls"/>
<element name="ExtCtrls"/>
<element name="Buttons"/>
<element name="Menus"/>
<element name="Clipbrd"/>
<element name="CalcDefPrecision">
<short>
Defines the default number of digits of precision used for values in TCalculatorForm
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorCalcKeyEvent">
<short>
Specifies an event handler signalled for Key events occurring in TCalculatorForm
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorCalcKeyEvent.Key">
<short>Key value examined in the event handler</short>
</element>
<element name="TCalculatorDispChangeEvent">
<short>
Specifies an event handler signalled when the display in TCalculatorForm is changed
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorState">
<short/>
<descr>
<p>
<var>TCalculatorState</var> is an enumerated type with values that represent the status for keys/operations in the calculator. TCalculatorState is the type used to implement the <var>Status</var> property in <var>TCalculatorPanel</var>.
</p>
</descr>
<seealso>
<link id="TCalculatorPanel.Status"/>
</seealso>
</element>
<element name="TCalculatorState.csFirst">
<short>Value on the First key press</short>
</element>
<element name="TCalculatorState.csValid">
<short>Value after the oepration for the key has been applied successfully</short>
</element>
<element name="TCalculatorState.csError">
<short>Value when the operation resulted in an error</short>
</element>
<element name="TCalculatorLayout">
<short/>
<descr>
<p>
<var>TCalculatorLayout</var> is an enumerated type with values that represent the layout for keys and panels on a calculator form. TCalculatorLayout is passed as an argument to the <var>CreateCalculatorForm</var> routine, and to methods in <var>TCalculatorForm</var> and <var>TCalculatorPanel</var>.
</p>
</descr>
<seealso>
<link id="TCalculatorForm.Create"/>
<link id="TCalculatorForm.InitForm"/>
<link id="TCalculatorPanel.CreateLayout"/>
</seealso>
<notes><note>Use the content from the TCalcuatorDialog layout property</note></notes>
</element>
<element name="TCalculatorLayout.clNormal">
<short>The default layout with larger button sizes and more whitespace</short>
</element>
<element name="TCalculatorLayout.clSimple">
<short>The compact layout with smaller button sizes</short>
</element>
<element name="TCalculatorPanel">
<short>
Implements a panel used for buttons and the value display in a calculator form
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.FText"/>
<element name="TCalculatorPanel.FStatus"/>
<element name="TCalculatorPanel.FOperator"/>
<element name="TCalculatorPanel.FOperand"/>
<element name="TCalculatorPanel.FMemory"/>
<element name="TCalculatorPanel.FPrecision"/>
<element name="TCalculatorPanel.FBeepOnError"/>
<element name="TCalculatorPanel.FMemoryPanel"/>
<element name="TCalculatorPanel.FMemoryLabel"/>
<element name="TCalculatorPanel.FOnError"/>
<element name="TCalculatorPanel.FOnOk"/>
<element name="TCalculatorPanel.FOnCancel"/>
<element name="TCalculatorPanel.FOnResult"/>
<element name="TCalculatorPanel.FOnTextChange"/>
<element name="TCalculatorPanel.FOnCalcKey"/>
<element name="TCalculatorPanel.FOnDisplayChange"/>
<element name="TCalculatorPanel.FControl"/>
<element name="TCalculatorPanel.SetCalcText">
<short>Sets the value for the text property</short>
<descr/>
<seealso>
<link id="TCalculatorPanel.Text"/>
</seealso>
</element>
<element name="TCalculatorPanel.SetCalcText.Value">
<short>New value for the property</short>
</element>
<element name="TCalculatorPanel.CheckFirst">
<short>Ensures that Text is updated and displayed when Status is csFirst</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.CalcKey">
<short>
Performs actions for a key press not handled by a button in the calculator panel
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.CalcKey.Key">
<short/>
</element>
<element name="TCalculatorPanel.Clear">
<short>Clears the display and operator in the calculator panel</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Error">
<short>
Updates the calculator panel to reflect an error condition, and signals OnError
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.SetDisplay">
<short>
Sets the Text in the calculator panel to the specified value, and signals OnDisplayChange
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.SetDisplay.R">
<short>Double value formatted and assigned to the Text property</short>
</element>
<element name="TCalculatorPanel.GetDisplay">
<short>Gets the Double value represented in the Text property</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.GetDisplay.Result">
<short/>
</element>
<element name="TCalculatorPanel.FindButton">
<short>Finds the calculator button which handles the specified key character</short>
<descr>
<p>
<var>Key</var> contains a character value to locate in the button captions on the panel. Keys which are not represented by buttons, like <b>Enter</b> (#13) and <b>Escape</b> (#27), are translated to the value used for the target button. In addition, when ',' is used as the decimal separator on the system, it is translated into the '.' decimal notation.
</p>
<p>
FindButton iterates through the <var>Controls</var> on the panel to locate the button using the associated Key. The return value is <b>Nil</b> when a button is not located for the value in Key.
</p>
</descr>
<seealso/>
</element>
<element name="TCalculatorPanel.FindButton.Result">
<short>
Button which handles the Key, or Nil when no button is available for Key
</short>
</element>
<element name="TCalculatorPanel.FindButton.Key">
<short>Key character to locate in the buttons for the calculator panel</short>
</element>
<element name="TCalculatorPanel.BtnClick">
<short>Translates a mouse click on a button to the character key used in CalcKey</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.BtnClick.Sender">
<short>Calculator button for the button click notification</short>
</element>
<element name="TCalculatorPanel.ErrorBeep">
<short/>
<descr>
ErrorBeep is an empty implementation in the current LCL version.
</descr>
<seealso/>
</element>
<element name="TCalculatorPanel.TextChange">
<short>Sets the display text for the associated control and signals OnTextChange</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.CreateLayout">
<short>
Initializes and configures the calculator panel using the specified layout
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.CreateLayout.AOwner">
<short/>
</element>
<element name="TCalculatorPanel.CreateLayout.ALayout">
<short/>
</element>
<element name="TCalculatorPanel.CalcKeyPress">
<short>Locates the button using the specified Key and perform its Click method</short>
<descr>
CalcKey is called when a button is located using the specified Key.
</descr>
<seealso/>
</element>
<element name="TCalculatorPanel.CalcKeyPress.Sender">
<short>Object for the KeyPress event</short>
</element>
<element name="TCalculatorPanel.CalcKeyPress.Key">
<short>Key value captured in the panel</short>
</element>
<element name="TCalculatorPanel.Copy">
<short>Loads the value in Text into the Clipboard as a text value</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Paste">
<short>
Pastes text from the Clipboard into the text display for the calculator panel
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.WorkingPrecision">
<short>Gets the minumum number of precision digits allowable for the panel</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.WorkingPrecision.Result">
<short/>
</element>
<element name="TCalculatorPanel.UpdateMemoryLabel">
<short>
Updates the Memory indicator to reflect a non-zero value in the Memory property
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.DisplayValue">
<short>Contains the Double value representing the Text in the panel</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Memory">
<short>Contains the Double value stored in the memory fopr the calculator</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Precision">
<short>
Maximum number of digits of precision allowed for the Double value in the calculator
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.BeepOnError">
<short>
Indicates if a beep occurs when an error condition is detected in the calculator panel
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Status">
<short>
Contains the status or state for the calculator panel
</short>
<descr>
</descr>
<seealso/>
</element>
<element name="TCalculatorPanel.OperatorChar">
<short>Character representing the last operator entered in the calculator panel</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Text">
<short>Text representation for the Double value in the calculator</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.OnOkClick">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.OnCancelClick">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.OnResultClick">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.OnError">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.OnTextChange">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.OnCalcKey">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.OnDisplayChange">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCalculatorPanel.Color">
<short>Color for the calculator panel</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm">
<short>
Implements the form used to display a calculator in a TCalculatorDialog
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.FMainPanel"/>
<element name="TCalculatorForm.FCalcPanel"/>
<element name="TCalculatorForm.FDisplayPanel"/>
<element name="TCalculatorForm.FDisplayLabel"/>
<element name="TCalculatorForm.FOnCalcKey"/>
<element name="TCalculatorForm.FOnDisplayChange"/>
<element name="TCalculatorForm.FMenu"/>
<element name="TCalculatorForm.FormKeyPress">
<short>
Performs actions needed to handle OnKeyPress events in the calculator form
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.FormKeyPress.Sender">
<short>Object for the event notification</short>
</element>
<element name="TCalculatorForm.FormKeyPress.Key">
<short>Key handled in the event handler</short>
</element>
<element name="TCalculatorForm.CopyItemClick">
<short>Implements a copy menu item in the pop-up menu for the form</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.CopyItemClick.Sender">
<short>Object for the event notification</short>
</element>
<element name="TCalculatorForm.GetValue">
<short>Gets the value for the Value property</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.GetValue.Result">
<short>Value for the property</short>
</element>
<element name="TCalculatorForm.PasteItemClick">
<short>Implements a paste menu item in the pop-up menu for the form</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.PasteItemClick.Sender">
<short/>
</element>
<element name="TCalculatorForm.SetValue">
<short>Sets the value for the Value property</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.SetValue.AValue">
<short>New value for the property</short>
</element>
<element name="TCalculatorForm.OkClick">
<short>Performs actions needed when the OK button is clicked</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.OkClick.Sender">
<short/>
</element>
<element name="TCalculatorForm.CancelClick">
<short>Performs actions needed when the Cancel button is clicked</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.CancelClick.Sender">
<short>Object for the event notification</short>
</element>
<element name="TCalculatorForm.CalcKey">
<short>Performs actions needed for a key received in the calculator form</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.CalcKey.Sender">
<short>Object for the event notification</short>
</element>
<element name="TCalculatorForm.CalcKey.Key">
<short>Key examined in the method</short>
</element>
<element name="TCalculatorForm.DisplayChange">
<short>Performs actions needed when the calculator display is changed</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.DisplayChange.Sender">
<short>Object for the event notification</short>
</element>
<element name="TCalculatorForm.InitForm">
<short>Initializes the calculator form using the specified layout</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.InitForm.ALayout">
<short>Layout applied to the calculator form instance</short>
</element>
<element name="TCalculatorForm.Create">
<short>Constructor for the class instance</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.Create.AOwner">
<short>Owner of the class instance</short>
</element>
<element name="TCalculatorForm.Create.ALayout">
<short>TCalculatorLayout used for the form instance</short>
</element>
<element name="TCalculatorForm.Value">
<short>Value displayed or returned from the calculator</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.MainPanel">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.CalcPanel">
<short>Panel with the calculator keys, operators,memory buttons, et. al.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.DisplayPanel">
<short>Panel for the display area on the calculator form</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.DisplayLabel">
<short>Label used to display the value in the panel</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.OnCalcKey">
<short>Event handler signalled to handle keys press on the calculator form</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorForm.OnDisplayChange">
<short>Event handler signalled when the calculator display has been changed</short>
<descr/>
<seealso/>
</element>
<element name="CreateCalculatorForm">
<short>Creates and configures a new TCalculatorForm instance</short>
<descr/>
<seealso>
<link id="TCalculatorForm"/>
<link id="TCalculatorLayout"/>
</seealso>
</element>
<element name="CreateCalculatorForm.Result">
<short>Form instance created in the method</short>
</element>
<element name="CreateCalculatorForm.AOwner">
<short>Owner for the new form instance</short>
</element>
<element name="CreateCalculatorForm.ALayout">
<short>Layout for the calculator panel in the form instance</short>
</element>
<element name="CreateCalculatorForm.AHelpContext">
<short/>
</element>
<element name="cColorBtnDigits">
<short>Color for the numeric digit buttons in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnMemory">
<short>Color for the Memory button in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnClear">
<short>Color for the Clear button in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnOk">
<short>Color for the OK button in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnCancel">
<short>Color for the Cancel button in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cColorBtnOthers">
<short>Color for miscellaneous "other" buttons in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cColorDisplayText">
<short>Color for text on the display area for a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cColorDisplayBack">
<short>Color for the background of the display area in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cCalculatorFontName">
<short>Font name used for buttons and displays in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cCalculatorFontSize">
<short>Font size used for buttons and displays in a calculator</short>
<descr/>
<seealso/>
</element>
<element name="cCalculatorFontStyle">
<short>Font style used for buttons and displays in a calculator</short>
<descr/>
<seealso/>
</element>
</module>
<!-- CalcForm -->
</package>
</fpdoc-descriptions>

269
docs/xml/lcl/calendarpopup.xml Normal file
View File

@ -0,0 +1,269 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="LCL">
<!--
====================================================================
CalendarPopup
====================================================================
-->
<module name="CalendarPopup">
<short>Implements a pop-up form with a TCalendar control for TDateEdit</short>
<descr/>
<!-- used units -->
<element name="System"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Forms"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="Dialogs"/>
<element name="Calendar"/>
<element name="LCLProc"/>
<element name="LCLType"/>
<element name="TReturnDateEvent">
<short>
Specifies an event handler signalled when a date is selected on a pop-up calendar form
</short>
<descr>
<p>
<var>TReturnDateEvent</var> specifies an event handler signalled when a date is selected on a pop-up calendar form. TReturnDateEvent is the type used to implement the <var>OnReturnDate</var> event handler in <var>TCalendarPopupForm</var>. Applications must implement an object procedure used to respond to the event notification. It is passed as an argument to the <var>ShowCalendarPopup</var> routine.
</p>
</descr>
<seealso>
<link id="TCalendarPopupForm.OnReturnDate"/>
<link id="ShowCalendarPopup"/>
</seealso>
</element>
<element name="TReturnDateEvent.Sender">
<short>Object for the event notification; normally the pop-up calendar form</short>
</element>
<element name="TReturnDateEvent.Date">
<short>TDateTime value for the date selected on the calendar form</short>
</element>
<element name="TCalendarPopupForm">
<short>
Implements a non-modal pop-up form used to select a date from a TCalendar control
</short>
<descr>
<p>
<var>TCalendarPopupForm</var> is a <var>TForm</var> descendant which implements a non-modal pop-up form used to select a date with a TCalendar control. It includes the <var>OnReturnDate</var> event handler to perform the actions needed when a date is selected using the Calendar control.
</p>
<p>
TCalendarPopupForm is used as the non-modal dialog executed when the Button for the <var>TDateEdit</var> control is clicked.
</p>
<p>
Use the <var>ShowCalendarPopup</var> routine to create, configure, and display a pop-up calendar form.
</p>
</descr>
<seealso>
<link id="TCalendarPopupForm.Calendar"/>
<link id="TCalendarPopupForm.OnReturnDate"/>
<link id="ShowCalendarPopup"/>
<link id="#lcl.EditBtn.TDateEdit"/>
</seealso>
</element>
<element name="TCalendarPopupForm.Calendar">
<short>TCalendar control used to select a date on the form</short>
<descr>
<p>
<var>Calendar</var> is a <var>TCalendar</var> member which contains the calendar control displayed on the form. It allows selection of date, and calls the <var>ReturnDate</var> method when the Month, Day, or Year in the control is changed using either the mouse or the keyboard. Calendar is configured in the <var>Initialize</var> method using the <var>TDateTime</var> and <var>TDisplaySettings</var> provided as arguments.
</p>
<p>
Use the <var>ShowCalendarPopup</var> routine to provide the date/time value and display settings needed in the pop-up calendar form.
</p>
</descr>
<seealso>
<link id="TCalendar"/>
<link id="TCalendarPopupForm.ReturnDate"/>
<link id="TCalendarPopupForm.OnReturnDate"/>
<link id="TCalendarPopupForm.Initialize"/>
<link id="ShowCalendarPopup"/>
<link id="TDisplaySettings"/>
</seealso>
</element>
<element name="TCalendarPopupForm.CalendarDblClick">
<short>
Performs actions needed when a double click mouse event occurs in the Calendar control
</short>
<descr>
<p>
<var>CalendarDblClick</var> ensures that the mouse event is within the bounds for the <var>Calendar</var> control by calling its <var>HitTest</var> method. When the mouse event occurs on the Month or Year calendar parts, the <var>ReturnDate</var> method is called to signal the <var>OnReturnDate</var> event handler and close the form.
</p>
</descr>
<seealso>
<link id="TCalendarPopupForm.Calendar"/>
<link id="#lcl.Calendar.TCustomCalendar.HitTest"/>
<link id="#lcl.Calendar.TCalendarPart"/>
<link id="TCalendarPopupForm.ReturnDate"/>
<link id="TCalendarPopupForm.OnReturnDate"/>
</seealso>
</element>
<element name="TCalendarPopupForm.CalendarDblClick.Sender">
<short></short>
</element>
<element name="TCalendarPopupForm.CalendarKeyDown">
<short>Implements the OnKeyDown event handler for the Calendar control</short>
<descr>
<p>
<var>CalendarKeyDown</var> is a procedure which implements the <var>OnKeyDown</var> event handler for the <var>Calendar</var> control. The method ensures that the key down virtual key code represented by <var>Key</var> and <var>Shift</var> is applied to the Calendar control, and includes:
</p>
<dl>
<dt>VK_RETURN, VK_SPACE</dt>
<dd>
Calls <var>ReturnDate</var> to apply the selected date value in Month view, and signals the <var>OnReturnDate</var> event handler.
</dd>
<dt>VK_ESCAPE</dt>
<dd>Calls <var>Close</var> to close the form.</dd>
</dl>
<p>
If the virtual key code is handled in the method, the value in Key is set to zero (0). Otherwise, it is retained for use in event handlers at the Form or Application level.
</p>
</descr>
<seealso>
<link id="TCalendarPopupForm.Calendar"/>
<link id="TCalendarPopupForm.ReturnDate"/>
<link id="TCalendarPopupForm.OnReturnDate"/>
<link id="#lcl.Forms.TCustomForm.Close"/>
<link id="#lcl.Controls.TControl.OnKeyDown"/>
</seealso>
</element>
<element name="TCalendarPopupForm.CalendarKeyDown.Sender">
<short>Object for the event notification; the Calendar control in this case</short>
</element>
<element name="TCalendarPopupForm.CalendarKeyDown.Key">
<short>Virtual key code examined in the method</short>
</element>
<element name="TCalendarPopupForm.CalendarKeyDown.Shift">
<short>Virtual key modifier examined in the method</short>
</element>
<element name="TCalendarPopupForm.FormClose">
<short>Implements the OnClose event handler for the form</short>
<descr>
<p>
Ensures that the <var>FormDeactivate</var> method is removed from the registered OnDeactivate handlers in <var>Application</var>. The value in <var>CloseAction</var> is set to <var>caFree</var> in the method.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TCalendarPopupForm.FormClose.Sender">
<short>Object for the event notification</short>
</element>
<element name="TCalendarPopupForm.FormClose.CloseAction">
<short>Close action to perform on exit from the event handler</short>
</element>
<element name="TCalendarPopupForm.FormCreate">
<short>Implements the OnCreate event handler for the form</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarPopupForm.FormCreate.Sender">
<short>Object for the event notification</short>
</element>
<element name="TCalendarPopupForm.FormDeactivate">
<short>Implements the OnDeactivate event handler for the form</short>
<descr>
<p>
Ensures that the <var>FormDeactivate</var> method is added to the OnDeactivate handlers in <var>Application</var>.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TCalendarPopupForm.FormDeactivate.Sender">
<short>Object for the event notification</short>
</element>
<element name="TCalendarPopupForm.FCaller"/>
<element name="TCalendarPopupForm.FClosed"/>
<element name="TCalendarPopupForm.FOnReturnDate"/>
<element name="TCalendarPopupForm.Initialize">
<short>Configures the Calendar control in the pop-up form</short>
<descr>
<p>
Applies the values in the <var>ADate</var> and <var>DisplaySettings</var> arguments to the <var>Calendar</var> control.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TCalendarPopupForm.Initialize.ADate">
<short>Date value assigned to the Calendar control</short>
</element>
<element name="TCalendarPopupForm.Initialize.DisplaySettings">
<short>Display settings applied to the Calendar control</short>
</element>
<element name="TCalendarPopupForm.KeepInView">
<short>
Ensures that the form and the calling control are visible on the current monitor
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarPopupForm.KeepInView.PopupOrigin">
<short>Coordinates where the pop-up form is displayed</short>
</element>
<element name="TCalendarPopupForm.ReturnDate">
<short>
Signals the OnReturnDate event handler using the DateTime value in the Calendar control
</short>
<descr>
<p>
Calls <var>Close</var> to close the form if it has not already been executed.
</p>
</descr>
<seealso></seealso>
</element>
<element name="ShowCalendarPopup">
<short>Creates, configures, and displays a TCalendarPopupForm instance</short>
<descr>
<p>
<var>ShowCalendarPopup</var> is a procedure used to create, configure, and display a <var>TCalendarPopupForm</var> instance. ShowCalendarPopup stores arguments to the routine in properties for the pop-up calendar form, and calls its <var>Initialize</var> method to configure the <var>Calendar</var> control.
</p>
<p>
ShowCalendarPopup calls the <var>Show</var> in the form to make it visible, and calls <var>KeepInView</var> to ensure that the form is fully visible on the current monitor.
</p>
</descr>
<seealso>
<link id="TCalendarPopupForm"/>
<link id="TCalendarPopupForm.Calendar"/>
<link id="TCalendarPopupForm.Initialize"/>
<link id="TCalendarPopupForm.KeepInView"/>
<link id="TCalendarPopupForm.OnReturnDate"/>
<link id="TReturnDateEvent"/>
<link id="#lcl.Calendar.TDisplaySettings"/>
</seealso>
</element>
<element name="ShowCalendarPopup.APosition">
<short>Coordinates where the pop-up calendar form is displayed</short>
</element>
<element name="ShowCalendarPopup.ADate">
<short>Initial date displayed in the Calendar for the form</short>
</element>
<element name="ShowCalendarPopup.CalendarDisplaySettings">
<short>Display settings applied to the Calendar control</short>
</element>
<element name="ShowCalendarPopup.OnReturnDate">
<short>Event handler signalled when a new date value is selected</short>
</element>
<element name="ShowCalendarPopup.OnShowHide">
<short>Event handler signalled when the pop-up form is shown or hidden</short>
</element>
<element name="ShowCalendarPopup.ACaller">
<short>The control which creates the pop-up and captures its return value</short>
</element>
</module>
<!-- CalendarPopup -->
</package>
</fpdoc-descriptions>

157
docs/xml/lcl/dblogdlg.xml Normal file
View File

@ -0,0 +1,157 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="LCL">
<!--
====================================================================
DBLogDlg
====================================================================
-->
<module name="DBLogDlg">
<short>Contains forms and routines used to implement a database login dialog</short>
<descr/>
<!-- used units -->
<element name="System"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Forms"/>
<element name="Controls"/>
<element name="StdCtrls"/>
<element name="ButtonPanel"/>
<element name="DB"/>
<element name="TLoginDialog">
<short>Implements a database login dialog form</short>
<descr>
<p>
<var>TLoginDialog</var> is a <var>TForm</var> descendant which implements a database login form. TLoginDialog contains labels and edits used to display and/or edit Database Name, User Name, and Password values. Database Name is read-only and cannot be changed on the form. The User Name can optionally be read-only. It also has a button panel with Login and Cancel buttons.
</p>
<p>
Use <var>LoginDialogEx</var> to create, configure, and display an instance of TLoginDialog using the arguments passed to the routine.
</p>
</descr>
<seealso>
<link id="LoginDialogEx"/>
</seealso>
</element>
<element name="TLoginDialog.lDatabaseName">
<short>Label used to display the Database Name for the dialog form</short>
<descr/>
<seealso/>
</element>
<element name="TLoginDialog.lDatabase">
<short>Label for the Database Name field</short>
<short></short>
<descr/>
<seealso/>
</element>
<element name="TLoginDialog.lUserName">
<short>Label for the User Name field</short>
<descr/>
<seealso/>
</element>
<element name="TLoginDialog.lPassword">
<short>Label for the Password field</short>
<descr/>
<seealso/>
</element>
<element name="TLoginDialog.eUserName">
<short>Edit control used to enter the User Name</short>
<descr/>
<seealso/>
</element>
<element name="TLoginDialog.ePassword">
<short>Edit control used to enter the Password</short>
<descr/>
<seealso/>
</element>
<element name="TLoginDialog.BtnPanel">
<short>Button Panel for the OK and Cancel buttons on the dialog</short>
<descr/>
<seealso/>
</element>
<element name="TLoginDialog.Create">
<short>Constructor for the class instance</short>
<descr/>
<seealso/>
</element>
<element name="TLoginDialog.Create.TheOwner">
<short>Owner of the class instance</short>
</element>
<element name="LoginDialogEx">
<short>Creates, configures, and displays a TLoginDialog dialog form</short>
<descr>
<p>
<var>LoginDialogEx</var> is a <var>Boolean</var> function used to create, configure, and display a <var>TLoginDialog</var> dialog form. The return value contains <b>True</b> when the <var>ModalResult</var> for the form display contains the value <var>mrOk</var>.
</p>
<p>
LoginDialogEx creates an instance of TLoginDialog, and sets the values in the controls used on the form. The arguments in <var>ADatabaseName</var>, <var>AUserName</var>, and <var>APassword</var> are assigned to the corresponding controls. <var>UserNameReadOnly</var> indicates whether the edit control for UserName can be modified; the default value is <b>False</b>.
</p>
<p>
LoginDialogEx calls <var>ShowModal</var> to display the form as a modal dialog, and captures the <var>ModalResult</var>. When ModalResult contains <var>mrOk</var>, the return value is set to <b>True</b>.
</p>
<p>
LoginDialogEx frees the form instance prior to exiting from the routine.
</p>
</descr>
<seealso/>
</element>
<element name="LoginDialogEx.Result">
<short>True when the ModalResult for the form is mrOk</short>
</element>
<element name="LoginDialogEx.ADatabaseName">
<short>Database name displayed on the form</short>
</element>
<element name="LoginDialogEx.AUserName">
<short>User name edited on the form</short>
</element>
<element name="LoginDialogEx.APassword">
<short>Password edited on the form</short>
</element>
<element name="LoginDialogEx.UserNameReadOnly">
<short>True if the User Name cannot be changed in the form</short>
</element>
<element name="rsDBLogDlgCaption">
<short>Resource string with the Caption displayed on the dialog form</short>
<descr/>
<seealso/>
</element>
<element name="rsDBLogDlgDatabase">
<short>Resource string for the Database label</short>
<descr/>
<seealso/>
</element>
<element name="rsDBLogDlgUserName">
<short>Resource string for the User Name label</short>
<descr/>
<seealso/>
</element>
<element name="rsDBLogDlgPassword">
<short>Resource string for the Password label</short>
<descr/>
<seealso/>
</element>
<element name="rsDBLogDlgLogin">
<short>Resource string with the caption for the OK button</short>
<descr/>
<seealso/>
</element>
</module>
<!-- DBLogDlg -->
</package>
</fpdoc-descriptions>

126
docs/xml/lcl/finddlgunit.xml Normal file
View File

@ -0,0 +1,126 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="LCL">
<!--
====================================================================
FindDlgUnit
====================================================================
-->
<module name="FindDlgUnit">
<short/>
<descr>
<p>
Only the .lfm file is used by the LCL (dialogs.pp). This unit is itself is not compiled into the LCL. This form is used to design the .lfm file.
</p>
<p>
The source code is a copy of <file>../lcl/include/finddialog.inc</file>.
</p>
</descr>
<!-- used units -->
<element name="System"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Forms"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="Dialogs"/>
<element name="StdCtrls"/>
<element name="Buttons"/>
<element name="ExtCtrls"/>
<element name="TFindDialogForm">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.BtnPanel">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.EntireScopeCheckBox">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.FindButton">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.CancelButton">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.FlagsPanel">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.HelpButton">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.WholeWordsOnlyCheckBox">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.CaseSensitiveCheckBox">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.EditFind">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.FindLabel">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.DirectionRadioGroup">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.EditFindChange">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.EditFindChange.Sender">
<short/>
</element>
<element name="TFindDialogForm.FormCreate">
<short/>
<descr/>
<seealso/>
</element>
<element name="TFindDialogForm.FormCreate.Sender">
<short/>
</element>
</module>
<!-- FindDlgUnit-->
</package>
</fpdoc-descriptions>

132
docs/xml/lcl/replacedlgunit.xml Normal file
View File

@ -0,0 +1,132 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="LCL">
<!--
====================================================================
ReplaceDlgUnit
====================================================================
-->
<module name="ReplaceDlgUnit">
<short/>
<descr>
<p>
Only the .lfm file is used by the LCL (dialogs.pp). This unit is itself is not compiled into the LCL. This form is used to design the .lfm file.
</p>
<p>
The source code is a copy of <file>../lcl/include/finddialog.inc</file>.
</p>
</descr>
<!-- used units -->
<element name="System"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Forms"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="Dialogs"/>
<element name="StdCtrls"/>
<element name="Buttons"/>
<element name="FindDlgUnit"/>
<element name="ExtCtrls"/>
<element name="TReplaceDialog">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.PromptOnReplaceCheckBox">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.EntireScopeCheckBox">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.FindMoreButton">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.ReplaceButton">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.ReplaceAllButton">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.CancelButton">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.HelpButton">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.WholeWordsOnlyCheckBox">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.CaseSensitiveCheckBox">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.EditFind">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.EditReplace">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.TextLabel">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.ReplaceLabel">
<short/>
<descr/>
<seealso/>
</element>
<element name="TReplaceDialogForm.DirectionRadioGroup">
<short/>
<descr/>
<seealso/>
</element>
</module>
<!-- ReplaceDlgUnit -->
</package>
</fpdoc-descriptions>

371
docs/xml/lcl/timepopup.xml Normal file
View File

@ -0,0 +1,371 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="LCL">
<!--
====================================================================
TimePopup
====================================================================
-->
<module name="TimePopup">
<short>Contains Forms, Types, and routines used to display a pop-up for TTimeEdit</short>
<descr/>
<!-- used untis -->
<element name="System"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="DateUtils"/>
<element name="FileUtil"/>
<element name="LCLType"/>
<element name="Forms"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="Dialogs"/>
<element name="Grids"/>
<element name="ExtCtrls"/>
<element name="Buttons"/>
<element name="StdCtrls"/>
<element name="ActnList"/>
<element name="WSForms"/>
<element name="TReturnTimeEvent">
<short>Specifies an event handler signalled to get a time return value</short>
<descr>
<p>
<var>TReturnTimeEvent</var> specifies an event handler signalled to validate or assign a time value. It is an object procedure which must be implemented in an application to respond to the event notification.
</p>
<p>
<var>Sender</var> is the object generating the event notification.
</p>
<p>
<var>ATime</var> is a <var>TDateTime</var> value which contains the time value used in the event handler. Only the time portion of the type is significant.
</p>
<p>
<var>TReturnTimeEvent</var> is the type passed as an argument to the <var>ShowTimePopup</var> routine, and implemented as a private member in <var> TTimePopupForm</var>.
</p>
</descr>
<seealso>
<link id="TTimePopupForm"/>
<link id="ShowTimePopup"/>
</seealso>
</element>
<element name="TReturnTimeEvent.Sender">
<short>Object for the event notification</short>
</element>
<element name="TReturnTimeEvent.ATime">
<short>Time value examined or updated in the event handler</short>
</element>
<element name="TTimePopupForm">
<short>Implements a form displayed to capture a time value</short>
<descr>
<p>
<var>TTimePopupForm</var> implements a form displayed to capture and return a time value.
</p>
<p>
The form contains grids with Hour and Minute values which can be selected to form the time value. The Minutes displayed in the grid are in either 5 minute or 30 minute intervals, depending on the layout selected using the <var>SetLayout</var> method; Simple layout uses a 5 minute interval and is the default layout for the form.
</p>
<p>
It uses an internal <var>TReturnTimeEvent</var> handler to validate or update the time value. There are also internal members used to track the control associated with the form, and the coordinates where the form is displayed. These internals are assigned using values passed as arguments to the <var>ShowTimePopup</var> routine.
</p>
</descr>
<seealso>
<link id="ShowTimePopup"/>
<link id="TReturnTimeEvent"/>
<link id="#lcl.EditBtn.TTimeEdit"/>
</seealso>
</element>
<element name="TTimePopupForm.Bevel1"/>
<element name="TTimePopupForm.MainPanel"/>
<element name="TTimePopupForm.HoursGrid"/>
<element name="TTimePopupForm.MinutesGrid"/>
<element name="TTimePopupForm.MoreLessBtn"/>
<element name="TTimePopupForm.GridsDblClick">
<short>Implements the OnDblClick event handler for grids controls on the form</short>
<descr>
<p>
Calls <var>ReturnTime</var> to signal the <var>OnReturnTime</var> event handler (when assigned) and close the form.
</p>
</descr>
<seealso>
<link id="TTimePopupForm.OnReturnTime"/>
<link id="TCustomForm.Close"/>
<link id="TReturnTimeEvent"/>
</seealso>
</element>
<element name="TTimePopupForm.GridsDblClick.Sender">
<short>Object for the event notification</short>
</element>
<element name="TTimePopupForm.GridsKeyDown">
<short>Implements the OnKeyDown event handler for grid controls on the form</short>
<descr>
<p>
<var>GridsKeyDown</var> ensures that the virtual key in <var>Key</var> and <var>Shift</var> is applied, when required. GridsKeyDown calls for form methods for the following:
</p>
<dl>
<dt>VK_ESC</dt>
<dd>Calls the close method to close the Form.</dd>
<dt>VK_RETURN, VK_SPACE</dt>
<dd>Call ReturnTime to validate/update the time value, and close the Form.</dd>
</dl>
<p>
When <var>Key</var> is handled in the method, it is set to zero (0). Otherwise, it is retained for use in Form or Application key events.
</p>
</descr>
<seealso/>
</element>
<element name="TTimePopupForm.GridsKeyDown.Sender">
<short>Object for the event notification</short>
</element>
<element name="TTimePopupForm.GridsKeyDown.Key">
<short>Virtual key code examined in the method</short>
</element>
<element name="TTimePopupForm.GridsKeyDown.Shift">
<short>Key Modifier examined in the method</short>
</element>
<element name="TTimePopupForm.GridPrepareCanvas">
<short>
Sets the canvas text style for a grid on the form
</short>
<descr>
<p>
<var>GridPrepareCanvas</var> ensures that the Canvas used to draw grid controls (<var>TStringGrid</var>) on the form has been initialized. GridPrepareCanvas sets the text layout and alignment needed for the Canvas property in the control.
</p>
<p>
<var>Sender</var> contains the grid control updated in the method. All other parameters are ignored in the current implementation.
</p>
</descr>
<seealso/>
</element>
<element name="TTimePopupForm.GridPrepareCanvas.sender">
<short>Control updated in the method</short>
</element>
<element name="TTimePopupForm.GridPrepareCanvas.aCol">
<short>Ignored</short>
</element>
<element name="TTimePopupForm.GridPrepareCanvas.aRow">
<short>Ignored</short>
</element>
<element name="TTimePopupForm.GridPrepareCanvas.aState">
<short>Ignored</short>
</element>
<element name="TTimePopupForm.MoreLessBtnClick">
<short>
Implements the OnClick event handler for the MoreLessBtn button on the form
</short>
<descr>
</descr>
<seealso/>
</element>
<element name="TTimePopupForm.MoreLessBtnClick.Sender">
<short>Object for the event notification</short>
</element>
<element name="TTimePopupForm.FClosed"/>
<element name="TTimePopupForm.FOnReturnTime"/>
<element name="TTimePopupForm.FSimpleLayout"/>
<element name="TTimePopupForm.FPopupOrigin"/>
<element name="TTimePopupForm.FCaller"/>
<element name="TTimePopupForm.ActivateDoubleBuffered">
<short>
Ensures that the DoubleBuffered property is updated with the current value from the widget set class
</short>
<descr/>
<seealso/>
</element>
<element name="TTimePopupForm.CalcGridHeights">
<short>Calculates the total height for the Hours and Minutes grids on the form</short>
<descr/>
</element>
<element name="TTimePopupForm.GetTime">
<short>Gets a TDateTime value for the selected cells in Hours and Minutes grids</short>
<descr>
Calls EncodeTime to get the return value for the selected cells.
</descr>
<seealso/>
</element>
<element name="TTimePopupForm.GetTime.Result">
<short>
TDateTime value for the selected cells; only the time portion of the value is relevant
</short>
</element>
<element name="TTimePopupForm.Initialize">
<short>Initializes the form using the origin and time values specified</short>
<descr>
Calls KeepInView to ensure that the form origin remains visible on the current monitor. Called from the ShowTimePopup routine.
</descr>
<seealso/>
</element>
<element name="TTimePopupForm.Initialize.PopupOrigin">
<short>Upper left coordinates for the form</short>
</element>
<element name="TTimePopupForm.Initialize.ATime">
<short>Initial time value displayed on the form</short>
</element>
<element name="TTimePopupForm.KeepInView">
<short>Ensures that form remains visible on the current monitor</short>
<descr>
<p>
KeepInView ensures that form remains visible on the current monitor. KeepInView tries to put the form on a "nice" place on the screen and make sure the entire form is visible. TheCaller typically will be a TTimeEdit control, and uses the following logic:
</p>
<ul>
<li>Places the form right under Caller control. If it does not fit...</li>
<li>Place the form above the Caller control. If it does not fit...</li>
<li>Sets the top coordinate to 0 and allows covering the Caller control.</li>
</ul>
</descr>
<seealso/>
</element>
<element name="TTimePopupForm.KeepInView.PopupOrigin">
<short>Upper left coordinates where the form is displayed</short>
</element>
<element name="TTimePopupForm.ReturnTime">
<short>Validates the current time value for the form</short>
<descr>
<p>
<var>ReturnTime</var> is a procedure used to validate and possibly update the current time value for the form. <var>GetTime</var> is called to get the time value using the selected cells in the Hour and Minute grids.
</p>
<p>
ReturnTime signals the internal <var>TReturnTimeEvent</var> event handler (when assigned) to validate/update the time value. The TReturnTimeEvent event handler is passed as an argument to the <var>ShowTimePopup</var> routine.
</p>
<p>
The <var>Close</var> method is called to close the form if it has not already been hidden.
</p>
</descr>
<seealso>
<link id="TTimePopupForm.GetTime"/>
<link id="ShowTimePopup"/>
<link id="#lcl.Forms.TCustomForm.Close"/>
</seealso>
</element>
<element name="TTimePopupForm.SetLayout">
<short>Sets the layout used in Minute grid for the form</short>
<descr>
<p>
<var>SimpleLayout</var> indicates whether the Minutes grid on the form use the simple layout. Simple layout uses a 30 minute interval between cells in the grid, and offers a more compact appearance. When SimpleLayout is False, a 5 minute interval is used between cells in the Minute grid.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TTimePopupForm.SetLayout.SimpleLayout">
<short>Uses the compact 30 minute interval when True</short>
</element>
<element name="TTimePopupForm.SetTime">
<short>Sets the time value displayed on the form</short>
<descr/>
<seealso/>
</element>
<element name="TTimePopupForm.SetTime.ATime">
<short>Time value applied to the Hour and Minute grid</short>
</element>
<element name="TTimePopupForm.FormClose">
<short>Performs actions needed when the form is closed</short>
<descr>
<p>
<var>FormClose</var> reimplements the FormClose event handler for the form to ensure that the <var>FormDeactivate</var> method is removed from the registered deactivate handlers in the global <var>Application</var> instance. FormClose sets the value in <var>CloseAction</var> to <var>caFree</var> to free the form instance.
</p>
</descr>
<seealso>
<link id="TTimePopupForm.FormDeactivate"/>
<link id="#lcl.Forms.Application"/>
<link id="#lcl.Forms.TApplication.RemoveOnDeactivateHandler"/>
</seealso>
</element>
<element name="TTimePopupForm.FormClose.Sender">
<short>Object for the event notification</short>
</element>
<element name="TTimePopupForm.FormClose.CloseAction">
<short>Close action to perform on exit form the method</short>
</element>
<element name="TTimePopupForm.FormCreate">
<short>Performs actions needed when the form instance is created</short>
<descr>
<p>
<var>FormCreate</var> reimplements the FormCreate method to initialize the form instance, and register its deactivation handler. FormCreate sets the form to us the Simple layout, calls <var>SetLayout</var>, and registers the <var>FormDeactivate</var> method as a deactivation handler in the global <var>Application</var> instance.
</p>
</descr>
<seealso>
<link id="TTimePopupForm.FormDeactivate"/>
<link id="TTimePopupForm.SetLayout"/>
<link id="#lcl.Forms.Application"/>
<link id="#lcl.Forms.TApplication.AddOnDeactivateHandler"/>
</seealso>
</element>
<element name="TTimePopupForm.FormCreate.Sender">
<short>Object for the event notification</short>
</element>
<element name="TTimePopupForm.FormDeactivate">
<short>Performs action needed when the form is deactivated</short>
<descr>
<p>
<var>FormDeactivate</var> reimplements the FormDeactivate event handler for the form. FormDeactivate call the <var>Hide</var> method to immediately hide the form. Otherwise, it would remain visible while in a Drag operation, for example. If not already active, the <var>Close</var> method is called prior to exiting from the method.
</p>
</descr>
<seealso>
<link id="TCustomForm.Close"/>
<link id="TCustomForm.Hide"/>
</seealso>
</element>
<element name="TTimePopupForm.FormDeactivate.Sender">
<short>Object for the event notification</short>
</element>
<element name="ShowTimePopup">
<short>
Creates, initializes, and displays a TTimePopupForm instance
</short>
<descr>
<p>
<var>ShowTimePopup</var> is a routine used to create, initialize, and display a <var>TTimePopupForm</var> instance. Arguments passed to the routine identify the time value and the control associated with the pop-up, event handlers assigned to the form instance, and the layout and position for the form.
</p>
</descr>
<seealso>
<link id="TTimePopupForm"/>
<link id="TReturnTimeEvent"/>
</seealso>
</element>
<element name="ShowTimePopup.Position">
<short>Coordinates where the form is displayed</short>
</element>
<element name="ShowTimePopup.ATime">
<short>Initial time value for the form</short>
</element>
<element name="ShowTimePopup.DoubleBufferedForm">
<short>Indicates if DoubleBuffered is enabled in the form instance</short>
</element>
<element name="ShowTimePopup.OnReturnTime">
<short>Event handler signalled when the time value is changed</short>
</element>
<element name="ShowTimePopup.OnShowHide">
<short>Event handler signalled when the form is show or hidden</short>
</element>
<element name="ShowTimePopup.SimpleLayout">
<short>
True indicates the simple (compact) layout is used for the Minute grid on the form
</short>
</element>
<element name="ShowTimePopup.ACaller">
<short>Control with the time value updated using the pop-up form</short>
</element>
</module>
<!-- TimePopup -->
</package>
</fpdoc-descriptions>