From 919b42775070b8ffa2636d8cae992965acfd7ca4 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Tue, 17 Feb 2009 18:09:19 +0000 Subject: [PATCH] FPDoc - some updates, additions and links for several classes in Forms.xml git-svn-id: trunk@18734 - --- docs/xml/lcl/forms.xml | 258 ++++++++++++++++++++++++++++++----------- 1 file changed, 191 insertions(+), 67 deletions(-) diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index edfbcd605f..a425f80af4 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -882,11 +882,14 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels - - + + + AlignControls - calls inherited AlignControls, then calculates sizes for the scrollbars if required - + + TWinControl.AlignControls + @@ -907,40 +910,52 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels - - + + + GetClientScrollOffset - finds the position for scrollbars from the client, if any, otherwise sets default postiions - + + TControl.GetClientScrollOffset + - - + + + GetLogicalClientRect - adjusts client rect to allow for size of scrollbars - + + TControl.GetLogicalClientRect + - - + + + DoOnResize - performs inherited DoOnResize then updates scrollbars if needed - + + TControl.DoOnResize + - - + + + GetControlClassDefaultSize inserts its own defaults, overriding inherited values - + + TControl.GetControlClassDefaultSize + @@ -1015,11 +1030,14 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels - - + + + Loaded - calls inherited Loaded and updates scroll bars - + + TScrollingWinControl.Loaded + @@ -1388,11 +1406,15 @@ If the indicators are valid, re-computes position etc - - + + + GetChildren - calls inherited GetChildren then accepts ownership of all owned components that have no parent - + + TComponent.GetChildren + TWinControl.GetChildren + @@ -1403,11 +1425,15 @@ If the indicators are valid, re-computes position etc - - + + + Notification calls inherited Notification then add or removes the component's action list (depending on what Operation specifies) - + + TComponent.Notification + TControl.Notification + @@ -1418,22 +1444,28 @@ If the indicators are valid, re-computes position etc - - + + + SetParent - calls inherited Setparent after validity checks, then updates the action lists - + + TControl.SetParent + - - + + + GetControlClassDefaultSize - returns its own defaults for frame design, overriding the inherited values - + + TControl.GetControlClassDefaultSize + @@ -2666,22 +2698,29 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - + + + CreateParams calls inherited CreateParams, and specifically copies style from parent - + + TWinControl.CreateParams + - - + + + CreateWnd calls inherited CreateWnd, signals if a handle is required and attaches a menu to the window if one does not yet exist; activates focus if visible - + + TWinControl.CreateWnd + TScrollingWinControl.CreateWnd + @@ -2752,11 +2791,15 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - + + + GetChildren calls inherited GetChildren then takes ownership of all components, including those without parents - + + TComponent.GetChildren + TWinControl.GetChildren + @@ -2767,11 +2810,15 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - + + + Loaded - calls inherited Loaded, makes this the active control and gives it focus - + + TComponent.Loaded + TScrollingWinControl.Loaded + @@ -2779,14 +2826,19 @@ biHelp - When you click this button a Question Cursor appears and the help routi ChildHandlesCreated - method for use when handles have been created for descendants - + + TWinControl.ChildHandlesCreated + - - + + + Notification calls inherited Notification then add or removes the component's action list (depending on what Operation specifies) - + + TComponent.Notification + @@ -2843,7 +2895,9 @@ biHelp - When you click this button a Question Cursor appears and the help routi UpdateShowing - method to update the Visible property - + + TWinControl.UpdateShowing + @@ -2881,11 +2935,22 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - + + + WndProc - performs actions specific to the message then calls inherited WndProc + + +

+ WndProc - performs actions specific to the message then calls inherited WndProc +

+

Specific messages include:

+

Activate, SetFocus. KillFocus; Exit, Enter; Window Position Changing; Draw Item

+ - + + TControl.WndProc + TWinControl.WndProc + @@ -3799,7 +3864,7 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + TCustomControl @@ -4302,7 +4367,7 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + @@ -5034,6 +5099,7 @@ biHelp - When you click this button a Question Cursor appears and the help routi TComponent.Create + TLCLComponent.Create Create - constructor for TScreen: performs inherited Create then creates and initialises lists of fonts, strings and forms @@ -5048,6 +5114,7 @@ biHelp - When you click this button a Question Cursor appears and the help routi TComponent.Destroy + TLCLComponent.Destroy Destroy - destructor for TForm: frees various lists then performs inherited Destroy @@ -6759,11 +6826,15 @@ If it is a form it will be added to the application's forms list - + This is a function that should be supplied by the application programmer, to override the placeholders declared in ancestor classes - + + TComponent.ExecuteAction + + + ExecuteAction - calls the OnActionExecute event hndler if it is assigned @@ -6774,11 +6845,14 @@ If it is a form it will be added to the application's forms list - - + + + UpdateAction - calls the OnUpdateAction event handler if it is assigned - + + TComponent.UpdateAction + @@ -6789,7 +6863,7 @@ If it is a form it will be added to the application's forms list - + Individual exception handler methods should be supplied by the application programmer, to override place-holder entries declared in ancestor classes.
This method checks whether the application is required to halt if an exception occurs, or invokes the appropriate handler.
@@ -6798,7 +6872,11 @@ This method checks whether the application is required to halt if an exception o It also writes details of the exception to the appropriate place for debugging. - + + TCustomApplication.HandleException + + + HandleException method for handling an exception; attempts to maintain program execution if possible, otherwise exits gracefully @@ -6928,11 +7006,15 @@ It also writes details of the exception to the appropriate place for debugging. - + Finds the appropriate widget set, reads the application's icon (if any) from the Lazarus Resource file, initialises the screen, and leaves it ready for processing. - + + TCustomApplication.Initialize + + + Initialize - calls inherited Initialize, then initialises widget set, loads icons from Laz resources and updates screen @@ -7074,11 +7156,15 @@ These constants are declared on the LCLType unit. - - + + + Notification if Operation is Remove, then sets any Component to nil, otherwise calls inherited Notification + - + + TComponent.Notification + @@ -8513,6 +8599,7 @@ Navigation Options is a set, so can take zero or more of the available values TComponent.Create + TLCLComponent.Create @@ -8528,6 +8615,7 @@ Navigation Options is a set, so can take zero or more of the available values TComponent.Destroy + TLCLComponent.Destroy @@ -9490,7 +9578,11 @@ Navigation Options is a set, so can take zero or more of the available values The version of the LCL as string. Used to distinguish form streams of different versions. - + + + TComponent.Loaded + + The number of data modules on the screen @@ -9506,7 +9598,14 @@ Navigation Options is a set, so can take zero or more of the available values - + + + DefineProperties- calculates low and high values for frame design from ancestor class + + TComponent.DefineProperties + TControl.DefineProperties + + @@ -9550,6 +9649,31 @@ Navigation Options is a set, so can take zero or more of the available values BidiMode - whether bi-directional mode is available + + + DoShowWindow automatically choose a control to focus + + + + AdjustClientRect - adjusts window size to accommodate borders + + TWinControl.AdjustClientRect + + + + + + DisableForms - disable all forms except SkipForm. If DisabledList is available then add forms to that list and return it, otherwise return new list. Used to show forms and other dialogs modal + + + + EnableForms - enable all forms from AFormList and destroy list. Used to restore state after DisableForms + + + + + DoArrowKey - method for processing an arrow key +