From d0fb7f4dbfb238ab4b154ea3d089f9ce78af7942 Mon Sep 17 00:00:00 2001 From: dodi Date: Sun, 6 Nov 2011 03:49:34 +0000 Subject: [PATCH] Docs: Forms synced git-svn-id: trunk@33360 - --- docs/xml/lcl/forms.xml | 7343 ++++++++++++++++------------------- docs/xml/lcl/lresources.xml | 2596 ++++++------- 2 files changed, 4525 insertions(+), 5414 deletions(-) diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index cd0f87d207..b85c83eaca 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -159,7 +159,7 @@ - + Represents the Position and Size on Screen of an Form @@ -174,43 +174,43 @@ - - + The Form appears exactly as it is positioned and sized in the Form Designer. + - - + The window manager decides how the form is to appear, in a default position and size. + - - + Keeps the designed size, but position determined by windowmanager. + - - + Keeps the designed position, but size determined by windowmanager. + - - + Centers the form on screen. + - - + Centers the form on desktop (not recommended, use poScreenCenter). + - - + Centers the Form on the Main Form. + - - + Centers the Form on Owner form. + - + Represents the actual State of the window on the screen. -

The actual meaning of each value depends on the platform:

+

The actual meaning of each value depends on the platform:

Windows and Mac OS X - These operating systems support all values.

X11 - The window state is a hint sent to the Window Manager, so more primitive Window Managers might ignore this hints.

Windows CE - In Windows CE platforms where Application.ApplicationType = atKeyPadDevice or atPDA (like in Windows Phone, PocketPC and Windows Mobile), wsMinimized and wsNormal are understood as wsMaximized, which is the normal state for windows in this platform. An exception are windows with BorderStyle=bsDialog or bsNone, which are allowed to have a custom position and size. For more information please read http://wiki.lazarus.freepascal.org/Windows_CE_Development_Notes#Positioning_and_size_of_Dialogs_and_Forms

@@ -219,23 +219,24 @@

wsNormal - The window appears normal

wsMinimized - The window is minimized and is not shown in the screen, but only in the taskbar

wsMaximized - The window appears maximized

-

wsFullScreen - The window appears in full screen mode, as much as allowed by the platform.

+

wsFullScreen - The window appears in full screen mode, as much as allowed by the platform. +

- - - - + + + + @@ -260,16 +261,6 @@ - - - TScrollingWinControl - a class of Window Control that has one or more scroll bars - Scrolling Window Control: A window control with scroll bars. -An ancestor class for many forms with scrolling windows - - - - - TCustomHintAction - Base class for THintAction, the action for displaying a Hint @@ -332,10 +323,9 @@ An ancestor class for many forms with scrolling windows TControlScrollBar - base class for defining scroll bars on Forms and windows - Control Scroll Bar: Scroll Bar control for adding to windows. Can be horizontal or vertical.
- -This is an ancestor class for many form types and classes of windowed controls - + Control Scroll Bar: Scroll Bar control for adding to windows. + Can be horizontal or vertical.
+ @@ -346,47 +336,14 @@ This is an ancestor class for many form types and classes of windowed controls - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + @@ -407,18 +364,6 @@ This is an ancestor class for many form types and classes of windowed controls - - - ControlAutoScroll - returns True if the control can Auto-Scroll - - - - - - - - - ControlHandle - the operating system handle for this control @@ -426,55 +371,39 @@ This is an ancestor class for many form types and classes of windowed controls - - - - GetIncrement - returns the size of the increment for each slick in the scroll bar - - - + + + + + + + + - + + + + + - - - GetPage - returns the size of the Page-Down (or -Up) Increment for the scroll bar - - - - - + - - - GetPosition returns the position of the slider in the scroll bar - - - - - + - - - GetRange - returns the valid range of values for the scroll bar movement - - - - - + @@ -486,35 +415,15 @@ This is an ancestor class for many form types and classes of windowed controls - - - - GetSmooth - returns True if smooth scrolling is to be used - - - - - + - - - GetVisible - returns True if the scroll bar is visible - - - - - - - - - HandleAllocated - returns True if a handle has been allocated @@ -527,28 +436,17 @@ This is an ancestor class for many form types and classes of windowed controls - - - SmoothIsStored - returns True if the Smooth status has been stored - - - + + + + + + + + - - - - - - - - VisibleIsStored - returns True if the Visible status has been stored - - - - - - - + + @@ -567,6 +465,19 @@ This is an ancestor class for many form types and classes of windowed controls + + + + + + + + + + + + + ScrollHandler - message handler to control scrolling @@ -574,56 +485,40 @@ This is an ancestor class for many form types and classes of windowed controls - - - - SetIncrement - specifies the scrolling increment - - - + + + + + + + + - + + + + + - - - SetPage - specifies the page scrolling increment - - - - - + - - - SetPosition - specifies the position of the slider in the scroll bar - - - - - + - - - SetRange - specifies the range of values for the scroll bar - - - - - - + + @@ -639,27 +534,26 @@ This is an ancestor class for many form types and classes of windowed controls - - - SetSmooth - specifies whether smooth scrolling is to be used - - - - - - + + - - - SetVisible - specifies whether the scroll bar is to be visible - - - + + + + + + + + - - + + + + + + @@ -678,79 +572,6 @@ This is an ancestor class for many form types and classes of windowed controls - - - - - - TObject.Create - - - Create - constructor for TControlScrollBar: performs inherited Create then initialises local flags for page, increment, position etc - - - - The identity of the windowed control in which the scroll bar is found - - - - Whether this is a horizontal or a vertical scrollbar - - - - - Assign - if Source is a TControlScrollBar, copies properties to itself, else performs inherited Assign - - Assigns the contents of the source object to the current object; in particular finds the increment, position, range and whether smooth scrolling is to be feature and whether the scroll bar is visible - - - - - - - - - The object that called this instance of the class - - - - Visibility of scroll bar - - - - - - - Returns 'True' if scroll bar visible - - - - Position of the indicator cursor on the scroll bar - - - - - - - Returns position of the scroll cursor as an integer - - - - Finds which kind of scroll bar this is: horizontal or vertical - Reads a flag to determine which kind of scroll bar - - - - - Finds out details of the other scroll bar - - - - - - - Returns a link to the details of the other scroll bar - @@ -775,12 +596,118 @@ This is an ancestor class for many form types and classes of windowed controls Returns details of the vertical scroll bar as a pointer to a structure - - - Determine the size of the scroll bar - Reads or writes a flag to determine the size; by default the size is not stored + + + + + + + + + + + + + + + + + The identity of the windowed control in which the scroll bar is found + + + Whether this is a horizontal or a vertical scrollbar + + + + If Source is a TControlScrollBar, copies properties to itself, else performs inherited Assign. + + Assigns the contents of the source object to the current object; + in particular finds the increment, position, range and whether smooth scrolling is to be feature and whether the scroll bar is visible + + + + + + + + The object that called this instance of the class + + + + Returns current widget state. + + + + + True if scroll bar visible. + + + + Position of the indicator cursor on the scroll bar + + + + + + Returns position of the scroll cursor as an integer + + + + Finds which kind of scroll bar this is: horizontal or vertical + Reads a flag to determine which kind of scroll bar + + + + + Finds out details of the other scroll bar + + + + + + Returns a link to the details of the other scroll bar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The size of the scrolling increment @@ -797,23 +724,41 @@ Reads or writes a flag to determine paging increment; default value is 80 pixels - - Determine whether smooth scrolling is to be implemented - Reads or writes a flag to determine smooth scrolling, and sets a flag is the scrolling status is stored - - - Position of the scroll bar Reads or writes a flag with the position; default is zero + + Determine whether smooth scrolling is to be implemented + Reads or writes a flag to determine smooth scrolling, and sets a flag is the scrolling status is stored + + + + + + + The range (extent) of the scroll bar Reads or writes a flag to determine the range; default is zero + + + Determine the size of the scroll bar + Reads or writes a flag to determine the size; by default the size is not stored + + + + + + + + + + Can the scroll bar be made visible? @@ -822,24 +767,18 @@ The Handle object (widget) is made visible if (Visible=true) and (Range>Page) To get the current visible state of the widget use the method IsScrollBarVisible. - - - - + + + Class of a Window Control that has one or more scroll bars. + + + - - - - - - - - - - - + + + @@ -847,49 +786,17 @@ To get the current visible state of the widget use the method IsScrollBarVisible - - - - - - - - - - - - - - - - - - + - - - - - - - + - - - - - - - - - - - + + @@ -900,11 +807,9 @@ To get the current visible state of the widget use the method IsScrollBarVisible TWinControl.AlignControls - - @@ -928,7 +833,6 @@ To get the current visible state of the widget use the method IsScrollBarVisible TControl.GetClientScrollOffset - @@ -942,7 +846,6 @@ To get the current visible state of the widget use the method IsScrollBarVisible TControl.GetLogicalClientRect - @@ -956,20 +859,6 @@ To get the current visible state of the widget use the method IsScrollBarVisible TControl.DoOnResize - - - - GetControlClassDefaultSize inserts its own defaults, overriding inherited values - - - - TControl.GetControlClassDefaultSize - - - - - - @@ -978,7 +867,6 @@ To get the current visible state of the widget use the method IsScrollBarVisible - @@ -990,26 +878,9 @@ To get the current visible state of the widget use the method IsScrollBarVisible - - - - - ScrollBy - amount by which to scroll - - - - - - - - - - - - @@ -1030,14 +901,17 @@ To get the current visible state of the widget use the method IsScrollBarVisible - - + + + + + @@ -1048,33 +922,26 @@ To get the current visible state of the widget use the method IsScrollBarVisible TWinControl.Loaded - - - This constructor can override the constructor of an ancestor class - - + + + + + + + - TCustomControl.Create - - Create - constructor for TScrollingWinControl: performs inherited Create then creates and intiialises the scrollbars - + + + + + - - Can override destructor of parent class - - - - - - - Destroy - destructor for TScrollingWinControl: frees the horizontal and vertical scrollbars, then performs inherited Destroy - - + Update the position of the scroll indicatores in the scroll bars @@ -1084,14 +951,34 @@ If the indicators are valid, re-computes position etc - - - Whether the scroll bars are visible + + + + GetControlClassDefaultSize inserts its own defaults, overriding inherited values + + + + TControl.GetControlClassDefaultSize + + + + + + + + + + ScrollBy - amount by which to scroll - + + + + + + @@ -1113,277 +1000,73 @@ If the indicators are valid, re-computes position etc - + - Scroll Box: A box with scroll bars + A box with scroll bars. + - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TCustomFrame - the base type for TFrame @@ -1399,7 +1082,6 @@ If the indicators are valid, re-computes position etc - @@ -1410,10 +1092,62 @@ If the indicators are valid, re-computes position etc - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1425,11 +1159,9 @@ If the indicators are valid, re-computes position etc TWinControl.GetChildren - - @@ -1444,11 +1176,9 @@ If the indicators are valid, re-computes position etc TControl.Notification - - @@ -1462,10 +1192,44 @@ If the indicators are valid, re-computes position etc TControl.SetParent - + + + DefineProperties- calculates low and high values for frame design from ancestor class + + TComponent.DefineProperties + TControl.DefineProperties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1476,33 +1240,12 @@ If the indicators are valid, re-computes position etc TControl.GetControlClassDefaultSize - - - - - Create - constructor for TCustomFrame: performs inherited Create then initialises styles, bounds etc - - - - TScrollingWinControl.Create - - - - - - - - - TCustomFrameClass - class of TCustomFrame - - - - - + + TFrame - a container for all the other components on a form, or for a group of components within a form @@ -1510,277 +1253,71 @@ If the indicators are valid, re-computes position etc - - - - - + + + + + + + + + - - - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TIDesigner - a class describing a Form Designer @@ -2024,82 +1561,42 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + - - TCustomForm - the base type for TForm + The base type for TForm. - - + + + FActionLists - local variable holding lists of actions asociated with the Form - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - - - - - - - + + + @@ -2112,224 +1609,131 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - + + + + + + + + + + + - - - - + + + + + + + + + - - - - + + + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + - - - - - + + + + + + + + - + + + + + + + + + + - - - - - - - + - - - - - - - + + + + + + - - - - - - - - + - - - - - - - + @@ -2341,193 +1745,139 @@ biHelp - When you click this button a Question Cursor appears and the help routi + + + + + + + + + + - - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - + + + - + + + + + + + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - + + + - + + + + + + + - - - - - - - + - - - - - - - + + + + + + + + + + + + + + @@ -2535,13 +1885,7 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - - - - + @@ -2552,7 +1896,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -2563,7 +1906,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -2574,20 +1916,21 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - - - + + + + + + + + - - - + + @@ -2612,6 +1955,19 @@ biHelp - When you click this button a Question Cursor appears and the help routi + + + + + + + + + + + + + @@ -2623,22 +1979,110 @@ biHelp - When you click this button a Question Cursor appears and the help routi + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + @@ -2648,11 +2092,9 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - @@ -2663,25 +2105,32 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - - FFormBorderStyle - local variable to hold style of border - - + + + + + + + + + - - - - FActionLists - local variable holding lists of actions asociated with the Form - - + + + + + + + + + + + CMShowingChanged - system message method for showing if the form has changed @@ -2689,10 +2138,13 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + + DoShowWindow automatically choose a control to focus + @@ -2710,6 +2162,17 @@ biHelp - When you click this button a Question Cursor appears and the help routi + + + AdjustClientRect - adjusts window size to accommodate borders + + TWinControl.AdjustClientRect + + + + + + BeginFormUpdate - start updating the Form @@ -2717,6 +2180,11 @@ biHelp - When you click this button a Question Cursor appears and the help routi + + + + + @@ -2727,7 +2195,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi TWinControl.CreateParams - @@ -2751,13 +2218,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - - - - DoClose - close the Form using the specified CloseAction @@ -2766,7 +2226,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -2821,14 +2280,61 @@ biHelp - When you click this button a Question Cursor appears and the help routi TWinControl.GetChildren - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2860,11 +2366,9 @@ biHelp - When you click this button a Question Cursor appears and the help routi TComponent.Notification - - @@ -2875,7 +2379,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -2887,6 +2390,25 @@ biHelp - When you click this button a Question Cursor appears and the help routi + + + + + + + + + + + + + + + + + + + SetZOrder - set the Z order for the Form; if Topmost is True, Form is on top of all other objects @@ -2894,7 +2416,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -2905,11 +2426,20 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + + + + + + + + + UpdateShowing - method to update the Visible property @@ -2931,6 +2461,16 @@ biHelp - When you click this button a Question Cursor appears and the help routi + + + + + + + + + + DoFirstShow - perform the first Show action since creation of the Form @@ -2955,6 +2495,16 @@ 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 @@ -2972,44 +2522,14 @@ biHelp - When you click this button a Question Cursor appears and the help routi TWinControl.WndProc - - - - - - - - - - - - - - - VisibleIsStored - True if the Visible property has been stored - - - - - + - - - - - - - - - - - @@ -3031,20 +2551,49 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - - - - + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -3053,11 +2602,9 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - @@ -3068,7 +2615,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -3080,7 +2626,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -3092,7 +2637,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -3104,7 +2648,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -3123,11 +2666,9 @@ biHelp - When you click this button a Question Cursor appears and the help routi

But first of all, the Form itself and the ActiveControl are asked to execute the given action.

 - True, if any control handles the action. - Action to execute. @@ -3141,11 +2682,9 @@ biHelp - When you click this button a Question Cursor appears and the help routi DoExecuteAction - - @@ -3168,7 +2707,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi TScrollingWinControl.Create - @@ -3180,14 +2718,24 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - + + + + + + + + + + + + @@ -3196,27 +2744,22 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - Find the handle for the Icon + + + - - + - - + - Destroy - destructor for TCustomForm: frees all menus, icons, actionlists, screens and handlers, then performs inherited Destroy - - - - - TScrollingWinControl.Destroy - + BigIconHandle - returns system Handle for large Icon + + + @@ -3231,33 +2774,26 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - Set free the resources of the form + + + DefocusControl - withdraws focus from the specified control, removing it if required - - + - - - - - - - - + + - - - Shows this form as the top (nearest) item of any stack of windows or images. + + + @@ -3269,58 +2805,168 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - - - - - - - - - - - + + - WantChildKey - returns True if the specified child control requires a key (Message) + FocusControl - giving focus to specified control, automatically bringing form to front + + If the control or one of its parents is not visible or disabled an exception will be raised. + + + + + + + + + - - - - - - - - - - + - + - DefocusControl - withdraws focus from the specified control, removing it if required + GetFormImage - gets a Bitmap image for the Form + + + + + + + + GetRolesForControl - returns a set of roles (default, cancel) for the Form - - + - - + + + + + + + + + + + IntfDropFiles - Invokes OnDropFilesEvent of the form. This function is called by the interface. + + + + + + + + + + + IntfHelp - Show help for control or menu item. This function is called by the interface. + + + + + + + + + + + IsShortcut - if True, the specified Key and Message are active as a shortcut + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Set free the resources of the form + + + + + + + + + + + + + + + + + + @@ -3335,39 +2981,13 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - - FocusControl - giving focus to specified control, automatically bringing form to front - - If the control or one of its parents is not visible or disabled an exception will be raised. - - - - - - - - - - Show this form as modal - ie control cannot be resumed by another form until the current form is closed - - - - - - - - - SetRestoredBounds - set the bounds defining the position of the restored control @@ -3375,36 +2995,63 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - - - - - GetRolesForControl - returns a set of roles (default, cancel) for the Form + + - - + + + Show this form as modal - ie control cannot be resumed by another form until the current form is closed + + + + + - - + + + Shows this form as the top (nearest) item of any stack of windows or images. + + + + + + + SmallIconHandle - returns system Handle for small Icon + + + + + + + + WantChildKey - returns True if the specified child control requires a key (Message) + + + + + + + + + + + @@ -3414,7 +3061,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -3426,12 +3072,10 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - + @@ -3442,7 +3086,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -3454,12 +3097,10 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - + @@ -3470,7 +3111,6 @@ biHelp - When you click this button a Question Cursor appears and the help routi - @@ -3482,12 +3122,10 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - + @@ -3498,49 +3136,50 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - - IsShortcut - if True, the specified Key and Message are active as a shortcut - - - + + + + + + + + - - - + + - - - + + + + + + + + + - - - - IntfDropFiles - Invokes OnDropFilesEvent of the form. This function is called by the interface. - - - + + - - - + + - - - - IntfHelp - Show help for control or menu item. This function is called by the interface. - - - + + + + + + + + + - - - + + @@ -3549,14 +3188,25 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - + + + + + + + + + + + + + Is true when the form has the focus @@ -3585,6 +3235,30 @@ biHelp - When you click this button a Question Cursor appears and the help routi + + + + + + + + + + + + + + + + + + + + + + + + Specifies which icons appear on the top of the form Use bordericons flags to get or set the icons that appear on the top border of the form.
@@ -3626,6 +3300,14 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + The form's colour; by default it is the same as the colour specified for button faces. @@ -3641,6 +3323,14 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + @@ -3696,6 +3386,17 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + + + + Specifies a MainMenu for this form Drop a TMainMenu on the form and select it here to show it on the form.
@@ -3712,6 +3413,10 @@ When the form is put into another control the window borders depend on the widge If the form is modal, returns an integer value. + + + Monitor - returns the monitor on which the form is mostly places (the biggest form area is placed) + Event called when the form receives focus @@ -3794,6 +3499,7 @@ When the form is put into another control the window borders depend on the widge + The scaling of the form in absolute terms @@ -3804,6 +3510,22 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + + + + + + + + + The position of the form on the screen Reads or writes a flag to determine screen position of form.
@@ -3815,6 +3537,12 @@ When the form is put into another control the window borders depend on the widge + + The height of the form when it is restored (ie changes from minimised or maximised) + + + + The position of the left edge of the form when it is restored (ie changes from minimised or maximised) @@ -3833,12 +3561,6 @@ When the form is put into another control the window borders depend on the widge - - The height of the form when it is restored (ie changes from minimised or maximised) - - - - Should the form be shown in the system Task Bar? @@ -3868,22 +3590,15 @@ When the form is put into another control the window borders depend on the widge - + TCustomFormClass - class of TCustomForm - + - - - - - - - @@ -3891,427 +3606,155 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + + + TComponent.Loaded + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The operating system handle for the client - - - - - - - - - - - - - - - - Use active control to set or get the control that has the focus on this form - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + The version of the LCL as string. Used to distinguish form streams of different versions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4320,7 +3763,7 @@ When the form is put into another control the window borders depend on the widge - + TCustomDockForm - Base class for docking forms @@ -4421,7 +3864,7 @@ When the form is put into another control the window borders depend on the widge - + Hint Window - the popup box containing helpful information that appears when the mouse pointer hovers over an object @@ -4434,32 +3877,30 @@ When the form is put into another control the window borders depend on the widge - - - - - - - + + - - - - + + + + + + + + + + + + + - - - - - - - + @@ -4470,7 +3911,6 @@ When the form is put into another control the window borders depend on the widge - @@ -4481,53 +3921,42 @@ When the form is put into another control the window borders depend on the widge - + - - - - - - - - - - - - - - - - - - - - - Create - constructor for THintWindow: performs inherited Create then initialises many properties including timers, styles, position, font and colour - - + + + + + + - TCustomForm.Create - + + + + + + + + + + + + + + + + + - - - Destroy - destructor for THintWindow: frees timers then performs inherited Destroy - - - - - TCustomForm.Destroy - - + Allow the hint message to be displayed in the specified rectangular space @@ -4535,11 +3964,9 @@ When the form is put into another control the window borders depend on the widge - - @@ -4550,15 +3977,12 @@ When the form is put into another control the window borders depend on the widge - - - @@ -4569,29 +3993,82 @@ When the form is put into another control the window borders depend on the widge - - - - + + + + + + + + + + Release the handle for the hint message and return it to the system + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Does the hint disappear (get hidden) after a while? @@ -4600,6 +4077,14 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + The time after which the displayed hint disappears @@ -4613,7 +4098,225 @@ When the form is put into another control the window borders depend on the widge - + + + + TMonitor - system monitor + TMonitor contains properties to access visible and work dimensions of the system monitor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + BoundsRect - the logical dimensions of the monitor + + + + Handle - system handle of monitor + + + + Height - the logical height of the monitor + + + + Left - the logical position of the left side of the monitor + + + + MonitorNum - index of the monitor in the screen monitors list + + + + Primary - indicates whether this monitor is primary + + + + Top - the logical position of the top side of the monitor + + + + Width - the logical width of the monitor + + + + WorkareaRect - the logical dimensions of the monitor except the unusable parts (like the taskbar, the dockbar, the global menu) + + + + + + TMonitorList - a list of monitors + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4643,7 +4346,7 @@ When the form is put into another control the window borders depend on the widge - + @@ -4657,21 +4360,7 @@ When the form is put into another control the window borders depend on the widge - - - - - - - - - - - - - - - + @@ -4685,29 +4374,45 @@ When the form is put into another control the window borders depend on the widge - + - - - - - + + + + + + + + + + + + + + + + + + + + + Screen - the visible area @@ -4715,30 +4420,10 @@ When the form is put into another control the window borders depend on the widge - - - - - - - - - - - - - - - - - - - - - - - - + + + + @@ -4751,50 +4436,21 @@ When the form is put into another control the window borders depend on the widge - - - - - - - - - - Specifies which style the form border has - - - - + + - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + @@ -4813,29 +4469,18 @@ When the form is put into another control the window borders depend on the widge - - - - - - - - - - - - - - - - - + + + + + + @@ -4843,7 +4488,6 @@ When the form is put into another control the window borders depend on the widge - @@ -4854,151 +4498,131 @@ When the form is put into another control the window borders depend on the widge - - - - - - + + + + + + + + + - + + - - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - - + - - - - - - + + + - + + + + + + + + + + + + + + + + + + + + - - - - - - - + - - - - - + + + - + + - - - - - - - + - - - - - - - + - - - - - - - - + - - - - - + + + - + + + + + + + + + + + + + + + @@ -5024,33 +4648,48 @@ When the form is put into another control the window borders depend on the widge - - - - - - + + + + - + + + + + - - - - - - - + - + + + + + + + + + + + + + + + + + + + + @@ -5058,22 +4697,39 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + + + + + + + + + + + + + - - - - + @@ -5083,53 +4739,106 @@ When the form is put into another control the window borders depend on the widge - - - - - - GetHintFont - find the correct font for displaying Hints - - - + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - TComponent.Create - TLCLComponent.Create - - - Create - constructor for TScreen: performs inherited Create then creates and initialises lists of fonts, strings and forms + + + + - + + + + + + + + + + + + - - - - - TComponent.Destroy - TLCLComponent.Destroy - - - Destroy - destructor for TForm: frees various lists then performs inherited Destroy - - + The Index number of a Custom Form on the screen @@ -5137,11 +4846,9 @@ When the form is put into another control the window borders depend on the widge - The Index number of the Custom Form, stored as an integer - The Custom Form to which the Index refers @@ -5152,11 +4859,9 @@ When the form is put into another control the window borders depend on the widge - The index number of the Form, stored as an integer - The Form to which the Index refers @@ -5168,11 +4873,9 @@ When the form is put into another control the window borders depend on the widge - - @@ -5184,7 +4887,6 @@ When the form is put into another control the window borders depend on the widge - @@ -5196,7 +4898,6 @@ When the form is put into another control the window borders depend on the widge - @@ -5208,7 +4909,6 @@ When the form is put into another control the window borders depend on the widge - @@ -5220,7 +4920,6 @@ When the form is put into another control the window borders depend on the widge - @@ -5232,11 +4931,9 @@ When the form is put into another control the window borders depend on the widge - - @@ -5248,14 +4945,55 @@ When the form is put into another control the window borders depend on the widge - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + FindDataModule - returns the Data Module with the specified name + Method for updating screen @@ -5264,6 +5002,15 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + + AddHandlerFormAdded - method for adding a form-adding handler @@ -5271,12 +5018,10 @@ When the form is put into another control the window borders depend on the widge - - - + @@ -5287,7 +5032,6 @@ When the form is put into another control the window borders depend on the widge - @@ -5299,12 +5043,10 @@ When the form is put into another control the window borders depend on the widge - - - + @@ -5315,7 +5057,6 @@ When the form is put into another control the window borders depend on the widge - @@ -5327,12 +5068,10 @@ When the form is put into another control the window borders depend on the widge - - - + @@ -5343,7 +5082,6 @@ When the form is put into another control the window borders depend on the widge - @@ -5355,12 +5093,10 @@ When the form is put into another control the window borders depend on the widge - - - + @@ -5376,14 +5112,113 @@ When the form is put into another control the window borders depend on the widge - - - - + + + + + + + + - - - + + + + + + + + + + + + + + + + + + + + + + + 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -5440,11 +5275,20 @@ When the form is put into another control the window borders depend on the widge - + + + CustomFormsZOrdered - the forms arranged in Z-plane order (ie Front to Back) + + + + + + + CustomFormZOrderCount - the number of forms arranged in Z-plane order (ie Front to Back) @@ -5452,21 +5296,45 @@ When the form is put into another control the window borders depend on the widge - - - CustomFormsZOrdered - the forms arranged in Z-plane order (ie Front to Back) - - + + The number of data modules on the screen - - - + + + The list of Data Modules + + + The total available height of the desktop in which the screen is to be placed + + + + + + + + + + + + + + + + + + + + + + + + The total available width of the desktop in which the screen is to be placed @@ -5478,6 +5346,12 @@ When the form is put into another control the window borders depend on the widge + + The fonts to be used in this screen + Reads a flag to determine the fonts to be used; their names are stored as a list of strings + + + The number of Forms on this screen Reads a flag to determine the number of Forms (integer) @@ -5489,17 +5363,10 @@ When the form is put into another control the window borders depend on the widge - Index number of a Form, stored as an integer - - The fonts to be used in this screen - Reads a flag to determine the fonts to be used; their names are stored as a list of strings - - - The height of the screen Reads a flag to determine screen height; stored as an integer @@ -5512,10 +5379,31 @@ When the form is put into another control the window borders depend on the widge - - The width of the screen - Reads flag to determine screen width, stored as an integer - + + + + + + + + + + + + + + + + + + MonitorCount - returns a number of monitors + + + + Monitors - provides access to the monitor list array + + + @@ -5535,13 +5423,71 @@ When the form is put into another control the window borders depend on the widge Reads a flag to determine number of pixels per inch (integer) - + + + + PrimaryMonitor - return the primary monitor of the system + + + + + + + + + + + + The width of the screen + Reads flag to determine screen width, stored as an integer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - @@ -5551,25 +5497,32 @@ When the form is put into another control the window borders depend on the widge - - + + + + + + + + + + + - - @@ -5579,11 +5532,9 @@ When the form is put into another control the window borders depend on the widge - - @@ -5663,19 +5614,16 @@ When the form is put into another control the window borders depend on the widge - + - - - @@ -5721,145 +5669,125 @@ When the form is put into another control the window borders depend on the widge - + - - - - - - + application has focus - - - - - - - + + initialization of application was done - + + + - - - - - - - - - + + - + + + - - - - + before interface and LCL - - + after interface and LCL - - - - - - - - + + + + + + - - - - - + + + + @@ -5889,39 +5817,129 @@ When the form is put into another control the window borders depend on the widge - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - + + - + + + + TApplicationShowGlyphs - enumerated type to describe the glyphs showing rule - whether to show them always, never or depends on system settings + +

sbgAlways - show glyphs always (inspite of system preferences)

+

sbgNever - show glyphs never (inspite of system preferences)

+

sbgSystem - use system preferences for glyphs showing

+ + + + show them always (default) + + + show them never + + + show them depending on OS + + + + + + + + + + + widgetset dependent + + + show buttons for Forms with ShowTaskBar = stDefault + + + hide buttons for Forms with ShowTaskBar = stDefault + + TApplication - the whole current program, described as an object -

- TApplication - the whole current program, described as an object.

Includes the useful function MessageBox, a simple dialog intended for displaying error messages internally, but available as an alternative to the various Message Dialogs

 @@ -5934,16 +5952,33 @@ When the form is put into another control the window borders depend on the widge - - - - + + + + + + + + - - - - + + + + + + + + + + + + + + + + + @@ -5958,65 +5993,24 @@ When the form is put into another control the window borders depend on the widge - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -6036,204 +6030,31 @@ When the form is put into another control the window borders depend on the widge - - - - - - + - - - - - - - - - - - - + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -6245,6 +6066,73 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6253,13 +6141,7 @@ When the form is put into another control the window borders depend on the widge - - - - - - - + @@ -6270,7 +6152,6 @@ When the form is put into another control the window borders depend on the widge - @@ -6281,20 +6162,21 @@ When the form is put into another control the window borders depend on the widge - - - - - - + + + + + + + + - - - + + @@ -6303,147 +6185,109 @@ When the form is put into another control the window borders depend on the widge - + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - - - - - + - - - - - + + + - + + + + + + + + + + + + + + + + + - - - - - - + + + + + + + + - - - + + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + - - - - - - - + @@ -6461,7 +6305,6 @@ When the form is put into another control the window borders depend on the widge - @@ -6472,7 +6315,6 @@ When the form is put into another control the window borders depend on the widge - @@ -6487,11 +6329,9 @@ When the form is put into another control the window borders depend on the widge - - @@ -6502,16 +6342,13 @@ When the form is put into another control the window borders depend on the widge - - - - + @@ -6521,11 +6358,9 @@ When the form is put into another control the window borders depend on the widge - - @@ -6547,6 +6382,9 @@ When the form is put into another control the window borders depend on the widge + + + @@ -6555,7 +6393,6 @@ When the form is put into another control the window borders depend on the widge - @@ -6567,7 +6404,6 @@ When the form is put into another control the window borders depend on the widge - @@ -6595,6 +6431,19 @@ When the form is put into another control the window borders depend on the widge + + + + + + + + + + + + + @@ -6603,14 +6452,34 @@ When the form is put into another control the window borders depend on the widge - - + + + + + + + + + + + + + + + + + + + + + + @@ -6627,7 +6496,6 @@ When the form is put into another control the window borders depend on the widge - @@ -6639,19 +6507,11 @@ When the form is put into another control the window borders depend on the widge - - - - SetTitle - method for writing the specified title string to local store - - - - - + @@ -6663,11 +6523,9 @@ When the form is put into another control the window borders depend on the widge - - @@ -6695,7 +6553,6 @@ When the form is put into another control the window borders depend on the widge - @@ -6715,11 +6572,20 @@ When the form is put into another control the window borders depend on the widge - + + + + + + + + + + DoBeforeFinalization - the things to be done before finalisation of the application @@ -6727,6 +6593,17 @@ When the form is put into another control the window borders depend on the widge + + + + GetParams - find the application's parameters (typically by parsing the command line that invoked the application) + + + + + + + This instance of the constructor performs most of the setting up of the environment for the application. The instances of Create that occur in some of the ancestor classes are place holders rather than actual instructions for constructing the object @@ -6739,20 +6616,36 @@ When the form is put into another control the window borders depend on the widge Create - constructor for TApplication: initialises a large number of local variables and properties, then calls inherited Create - The Owner object that invoked this instance of TApplication - + + + + + + + + + + + + + + + + + + + + - - TCustomApplication.Destroy - - - Destroy - destructor for TApplication: frees various handles and flags, then cals inherited Destroy - + + + + @@ -6761,11 +6654,26 @@ When the form is put into another control the window borders depend on the widge - + + + BigIconHandle - system Handle for large Icon + + + + + + + + SmallIconHandle - system handle for small Icon + + + + + BringToFront - Use the selected widget set's method to bring the application's form(s) to the front @@ -6787,11 +6695,9 @@ If it is a form it will be added to the application's forms list - - @@ -6803,7 +6709,6 @@ If it is a form it will be added to the application's forms list - @@ -6815,15 +6720,21 @@ If it is a form it will be added to the application's forms list - The method to be used for the asynchronous call - The data structure used by the asynchronous call method + + Removes all calls added via QueueAsyncCall + This is thread safe. + + + + + ReleaseComponent - method to release the specified component @@ -6831,7 +6742,6 @@ If it is a form it will be added to the application's forms list - @@ -6846,11 +6756,9 @@ If it is a form it will be added to the application's forms list ExecuteAction - calls the OnActionExecute event hndler if it is assigned - - @@ -6864,11 +6772,9 @@ If it is a form it will be added to the application's forms list TComponent.UpdateAction - - @@ -6888,7 +6794,6 @@ It also writes details of the exception to the appropriate place for debugging. HandleException method for handling an exception; attempts to maintain program execution if possible, otherwise exits gracefully - @@ -6900,6 +6805,25 @@ It also writes details of the exception to the appropriate place for debugging. + + + + + + + + + + + + + + + + + + + HelpContext - returns True if there is a specified context-dependent help message associated with the application, with an optionally specified position @@ -6907,19 +6831,15 @@ It also writes details of the exception to the appropriate place for debugging. - - - - @@ -6931,19 +6851,15 @@ It also writes details of the exception to the appropriate place for debugging. - - - - @@ -6955,17 +6871,34 @@ It also writes details of the exception to the appropriate place for debugging. - - - - HideAllFormsWithStayOnTop - hide all forms, but keep the curent top form on top - - - + + + + + + + + + + + + + + + + + + + + + + + + @@ -6975,7 +6908,6 @@ It also writes details of the exception to the appropriate place for debugging. - @@ -7009,12 +6941,6 @@ It also writes details of the exception to the appropriate place for debugging. - - - The icon to be associated with this application - - - 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. @@ -7065,7 +6991,6 @@ It also writes details of the exception to the appropriate place for debugging. - Result Result: integer value returned by the function to signify which box was selected
@@ -7093,17 +7018,14 @@ Can be one of the following values:
IDHELP - Text: the string that is displayed as a prompt or instruction in the Box - Caption: the string label at the top of the message box - Flags - a long integer constructed by adding together various constants to define the contents and behaviour of the box Flags: longint - an integer constructed by adding together various constants to define the contents and behaviour of the box, for example
@@ -7159,6 +7081,26 @@ These constants are declared on the LCLType unit. + + + + + + + + + + + + + + + + + + + + Restore the application's form to the size it was before minimisation or maximisation @@ -7176,11 +7118,9 @@ These constants are declared on the LCLType unit. TComponent.Notification - - @@ -7200,7 +7140,6 @@ These constants are declared on the LCLType unit. - @@ -7217,7 +7156,6 @@ These constants are declared on the LCLType unit. - The exception that is to be displayed @@ -7254,7 +7192,6 @@ These constants are declared on the LCLType unit. - @@ -7266,15 +7203,12 @@ These constants are declared on the LCLType unit. - - - @@ -7286,15 +7220,12 @@ These constants are declared on the LCLType unit. - - - @@ -7306,15 +7237,12 @@ These constants are declared on the LCLType unit. - - - @@ -7326,15 +7254,12 @@ These constants are declared on the LCLType unit. - - - @@ -7346,12 +7271,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7362,7 +7285,6 @@ These constants are declared on the LCLType unit. - @@ -7374,12 +7296,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7390,7 +7310,6 @@ These constants are declared on the LCLType unit. - @@ -7402,12 +7321,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7418,7 +7335,6 @@ These constants are declared on the LCLType unit. - @@ -7430,12 +7346,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7446,7 +7360,6 @@ These constants are declared on the LCLType unit. - @@ -7458,12 +7371,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7474,7 +7385,6 @@ These constants are declared on the LCLType unit. - @@ -7486,12 +7396,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7502,7 +7410,6 @@ These constants are declared on the LCLType unit. - @@ -7514,12 +7421,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7530,7 +7435,6 @@ These constants are declared on the LCLType unit. - @@ -7542,12 +7446,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7558,7 +7460,6 @@ These constants are declared on the LCLType unit. - @@ -7570,12 +7471,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7586,7 +7485,6 @@ These constants are declared on the LCLType unit. - @@ -7598,12 +7496,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7614,7 +7510,6 @@ These constants are declared on the LCLType unit. - @@ -7626,12 +7521,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7642,11 +7535,68 @@ These constants are declared on the LCLType unit. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + AddOnRestoreHandler - method to add handler for Restore component @@ -7654,12 +7604,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7670,7 +7618,6 @@ These constants are declared on the LCLType unit. - @@ -7682,12 +7629,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7698,7 +7643,6 @@ These constants are declared on the LCLType unit. - @@ -7710,12 +7654,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7726,7 +7668,6 @@ These constants are declared on the LCLType unit. - @@ -7738,12 +7679,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7754,7 +7693,6 @@ These constants are declared on the LCLType unit. - @@ -7766,12 +7704,10 @@ These constants are declared on the LCLType unit. - - - + @@ -7782,11 +7718,39 @@ These constants are declared on the LCLType unit. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + RemoveAllHandlersOfObject - method to remove all handlers of an object @@ -7794,7 +7758,6 @@ These constants are declared on the LCLType unit. - @@ -7806,7 +7769,6 @@ These constants are declared on the LCLType unit. - @@ -7818,11 +7780,9 @@ These constants are declared on the LCLType unit. - - @@ -7834,7 +7794,6 @@ These constants are declared on the LCLType unit. - @@ -7847,6 +7806,26 @@ These constants are declared on the LCLType unit. + + + + + + + + + + + + + + + + + + + + IntfAppMinimize - called by the interface if an application is minimised @@ -7870,11 +7849,72 @@ These constants are declared on the LCLType unit. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + DoArrowKey - method for processing an arrow key + + + + + + + + + + + DoEscapeKey - method for processing the Escape key @@ -7882,15 +7922,12 @@ These constants are declared on the LCLType unit. - - - @@ -7902,15 +7939,12 @@ These constants are declared on the LCLType unit. - - - @@ -7922,15 +7956,12 @@ These constants are declared on the LCLType unit. - - - @@ -7942,6 +7973,21 @@ These constants are declared on the LCLType unit. + + + ApplicationType - The type of the application (ie the sort of device for which it is intended) + +

The type of the application:

+

Default, Desktop, Handheld, PDA, Smartphone

+ + + + + + + BidiMode - whether bi-directional mode is available + + CaptureExceptions - If exceptions have occurred, find out what they are, ready for processing @@ -8012,6 +8058,50 @@ Reads or writes a flag to determine the hint associated with the application + + The icon to be associated with this application + + + + + + The Main Form used by the application for process control and for data input/output + Reads a flag to get particulars of the main form + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Determine how the form is to be navigated Reads or writes a flag to determine the navigation method:
@@ -8036,12 +8126,6 @@ Navigation Options is a set, so can take zero or more of the available values - - The Main Form used by the application for process control and for data input/output - Reads a flag to get particulars of the main form - - - OnActionExecute - event handler for executing the application's main action @@ -8066,40 +8150,9 @@ Navigation Options is a set, so can take zero or more of the available valuesOnDeactivate - Event handler for deactivation of the application - + - OnIdle - event handler for the Idle state - - - - - - - OnIdleEnd - event handler for the end of the Idle state - - - - - - - OnEndSession - Event handler for ending a session of the application - - - - - OnQueryEndSession - event handler for processing a query at the end of a session - - - - - - - OnMinimize - Event handler for minimising the application's form - - - - - OnRestore - Event handler for restoring the application's form from minimised or maximised condition + OnDestroy - Event handler for destruction of the application @@ -8113,6 +8166,19 @@ Navigation Options is a set, so can take zero or more of the available values + + + OnEndSession - Event handler for ending a session of the application + + + + + + + + + + OnHelp - Event handler when help is required @@ -8127,6 +8193,53 @@ Navigation Options is a set, so can take zero or more of the available values + + + OnIdle - event handler for the Idle state + + + + + + + OnIdleEnd - event handler for the end of the Idle state + + + + + + + OnMinimize - Event handler for minimising the application's form + + + + + + + + + + + + + + + + + + + + + OnQueryEndSession - event handler for processing a query at the end of a session + + + + + + + OnRestore - Event handler for restoring the application's form from minimised or maximised condition + + OnShortcut - Event handler when a shortcut key is pressed @@ -8148,9 +8261,12 @@ Navigation Options is a set, so can take zero or more of the available values - - - OnDestroy - Event handler for destruction of the application + + + + + + @@ -8167,18 +8283,64 @@ Navigation Options is a set, so can take zero or more of the available values - - - - - ApplicationType - The type of the application (ie the sort of device for which it is intended) + + -

The type of the application:

-

Default, Desktop, Handheld, PDA, Smartphone

 - + + - + + + + + + + + + + + + + default hint window color + + + + + + + + default pause before hint window displays (ms) + + + + + + + + default reshow pause + + + + + + + + default pause before hint is hidden (ms) + + + + + + + + added to DefHintHidePause (ms) + + + + + + TApplicationProperties: The properties of the current application @@ -8189,415 +8351,171 @@ Navigation Options is a set, so can take zero or more of the available values - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - SetCaptureExceptions - specifies whether exceptions are to be captured - - - - - + - - - SetHelpFile - specifies which file is to be used for Help messages - - - - - + - - - SetHint - specifies the text for a Hint - - - - - + - - - SetHintColor - specifies the colour for displaying hints - - - - - + - - - SetHintHidePause - specifies the length of pause before a hint becomes hidden - - - - - + - - - SetHintPause - specifies the length of pause before a hint is displayed - - - - - + - - - SetHintShortCuts - specifies whether hints are to be displayed for Shortcut keys - - - - - + - - - SetHintShortPause - specifies the length of pause before a shortcut key hint is displayed - - - - - + - - - SetShowHint - specifies whether hints are to be displayed - - - + + + - + + + + + + + - - - SetTitle - specifies the title for the Form - - - + + + - + + - - - SetOnException - specifies the event handler for exceptions - - - - - + - - - SetOnIdle - specifies the handler for Idle events - - - + + + - + + - - - SetOnIdleEnd - specifies the handler to notify the end of an idle period - - - - - + - - - SetOnEndSession - specifies the event handler to notify the end of a session - - - - - + - - - SetOnQueryEndSession - specify the event handler for a query at the end of a session - - - - - + - - - SetOnMinimize - specify the event handler for minimising the application form - - - - - + - - - SetOnRestore - specify the event handler for restoring the application's form - - - + + + - + + + + + + + - - - SetOnDropFiles - specify the event handler for dropping files - - - - - + - - - SetOnHelp - specify the event handler for help requests - - - - - + - - - SetOnHint - specify the event handler for a request to show hints - - - - - + - - - SetOnShowHint - specify the event handler for showing hints - - - - - + - - - SetOnUserInput - specify the event handler for dealing with User input - - - - - + @@ -8689,24 +8607,16 @@ Navigation Options is a set, so can take zero or more of the available values - + - ShowHint - Determines whether a hint is to be displayed - Read or write flag to determine whether to display hint (stored as boolean, True if hint is to be displayed) - - - - - - - ShowMainForm - Determines whether main form is to be displayed + OnDropFiles - Event handler when files are dropped on the form - + - Title to be shown in Application's top Border + OnEndSession - Event handler for the end of the session @@ -8718,6 +8628,28 @@ Navigation Options is a set, so can take zero or more of the available values + + + + + + + + + + + OnHelp - Event handler when help is needed + + + + + + + OnHint - Event handler when a hint is needed + + + + OnIdle - event handler for the Idle state @@ -8732,13 +8664,29 @@ Navigation Options is a set, so can take zero or more of the available values - + - OnEndSession - Event handler for the end of the session + OnMinimize - Event handler for minimising the form + + + + + + + + + + + + + + + + OnQueryEndSession - Event handler for a query at the end of a session @@ -8746,13 +8694,6 @@ Navigation Options is a set, so can take zero or more of the available values - - - OnMinimize - Event handler for minimising the form - - - - OnRestore - Event handler for restoring a form which has been minimised or maximised @@ -8760,27 +8701,6 @@ Navigation Options is a set, so can take zero or more of the available values - - - OnDropFiles - Event handler when files are dropped on the form - - - - - - - OnHelp - Event handler when help is needed - - - - - - - OnHint - Event handler when a hint is needed - - - - OnShowHint - Event handler for showing a hint @@ -8794,7 +8714,45 @@ Navigation Options is a set, so can take zero or more of the available values - + + + + ShowButtonGlyphs - determines whether to show show or not glyphs on TBitBtn controls + This option allows to set rule for all application TBitBtn controls which have GlyphShowMode = gsmApplication. + +Different operation systems has different preferences regards showing button glyphs. Mac OS X and Windows UI guidlines suggests not to use them. Gnome has a special theme setting for this. sbgSystem option allows application to use system preferences for glyphs showing. sbgAlways is the default value because of Delphi compatibility. + + + + + ShowHint - Determines whether a hint is to be displayed + Read or write flag to determine whether to display hint (stored as boolean, True if hint is to be displayed) + + + + + + + ShowMainForm - Determines whether main form is to be displayed + + + + + + + ShowMenuGlyphs - Deturmines whether show or not glyphs in menu + This option allows to set rule for all application TMenuItem components which have GlyphShowMode = gsmApplication. + +Different operation systems has different preferences regards showing images in menus. Mac OS X suggests not to use them. Gnome has a special theme setting for this. sbgSystem option allows application to use system preferences for menu icons showing. sbgAlways is the default value because of Delphi compatibility. + + + + + Title to be shown in Application's top Border + + + + IsDesignMsg - receives a message from Sender, and returns True if it is a design message @@ -8906,7 +8864,7 @@ Navigation Options is a set, so can take zero or more of the available values - + TFormPropertyStorage - class for storage of a Form's properties @@ -8915,15 +8873,17 @@ Navigation Options is a set, so can take zero or more of the available values - - - - - + + + + + + + + - - - + + @@ -8932,344 +8892,20 @@ Navigation Options is a set, so can take zero or more of the available values - - - - - - - - - + - - - - - - - - - Data Module - Data Module: for interfacing to the database - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + KeysToShiftState - converts an actual physical key code to a shift state (ie Shift, Ctrl, Alt etc) @@ -9277,11 +8913,9 @@ Navigation Options is a set, so can take zero or more of the available values - - @@ -9293,15 +8927,29 @@ Navigation Options is a set, so can take zero or more of the available values - - + + + + + + + + + + + + + + + + WindowStateToStr - converts a Window state to a string @@ -9309,11 +8957,9 @@ Navigation Options is a set, so can take zero or more of the available values - - @@ -9325,15 +8971,35 @@ Navigation Options is a set, so can take zero or more of the available values - - - + + + + + + + + + + + + + + + + + + + + + + + @@ -9346,7 +9012,6 @@ Navigation Options is a set, so can take zero or more of the available values - @@ -9357,7 +9022,6 @@ Navigation Options is a set, so can take zero or more of the available values - @@ -9367,12 +9031,10 @@ Navigation Options is a set, so can take zero or more of the available values - - - + @@ -9388,11 +9050,9 @@ Navigation Options is a set, so can take zero or more of the available values - - @@ -9403,11 +9063,9 @@ Navigation Options is a set, so can take zero or more of the available values - - @@ -9418,12 +9076,10 @@ Navigation Options is a set, so can take zero or more of the available values - - - + @@ -9433,12 +9089,10 @@ Navigation Options is a set, so can take zero or more of the available values - - - + @@ -9448,15 +9102,12 @@ Navigation Options is a set, so can take zero or more of the available values - - - @@ -9467,7 +9118,6 @@ Navigation Options is a set, so can take zero or more of the available values - @@ -9478,11 +9128,9 @@ Navigation Options is a set, so can take zero or more of the available values - - @@ -9493,15 +9141,13 @@ Navigation Options is a set, so can take zero or more of the available values - - - + @@ -9525,6 +9171,14 @@ Navigation Options is a set, so can take zero or more of the available values + + + + + + + + @@ -9585,194 +9239,6 @@ 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 - - - The list of Data Modules - - - - - - - - - - - - DefineProperties- calculates low and high values for frame design from ancestor class - - TComponent.DefineProperties - TControl.DefineProperties - - - - - - - - - - BigIconHandle - returns system Handle for large Icon - - - - SmallIconHandle - returns system Handle for small Icon - - - - GetFormImage - gets a Bitmap image for the Form - - - - - - - - - FindDataModule - returns the Data Module with the specified name - - - - GetParams - find the application's parameters (typically by parsing the command line that invoked the application) - - - - BigIconHandle - system Handle for large Icon - - - - SmallIconHandle - system handle for small Icon - - - - - 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 - - - - - - - - - ShowButtonGlyphs - determines whether to show show or not glyphs on TBitBtn controls - This option allows to set rule for all application TBitBtn controls which have GlyphShowMode = gsmApplication. - -Different operation systems has different preferences regards showing button glyphs. Mac OS X and Windows UI guidlines suggests not to use them. Gnome has a special theme setting for this. sbgSystem option allows application to use system preferences for glyphs showing. sbgAlways is the default value because of Delphi compatibility. - - - - ShowMenuGlyphs - Deturmines whether show or not glyphs in menu - This option allows to set rule for all application TMenuItem components which have GlyphShowMode = gsmApplication. - -Different operation systems has different preferences regards showing images in menus. Mac OS X suggests not to use them. Gnome has a special theme setting for this. sbgSystem option allows application to use system preferences for menu icons showing. sbgAlways is the default value because of Delphi compatibility. - - - - TApplicationShowGlyphs - enumerated type to describe the glyphs showing rule - whether to show them always, never or depends on system settings - -

sbgAlways - show glyphs always (inspite of system preferences)

-

sbgNever - show glyphs never (inspite of system preferences)

-

sbgSystem - use system preferences for glyphs showing

- - - - - TMonitor - system monitor - TMonitor contains properties to access visible and work dimensions of the system monitor. - - - - Hanlde - system handle of monitor - - - - MonitorNum - index of the monitor in the screen monitors list - - - - Left - the logical position of the left side of the monitor - - - - Height - the logical height of the monitor - - - - Top - the logical position of the top side of the monitor - - - - Width - the logical width of the monitor - - - - BoundsRect - the logical dimensions of the monitor - - - - WorkareaRect - the logical dimensions of the monitor except the unusable parts (like the taskbar, the dockbar, the global menu) - - - - Primary - indicates whether this monitor is primary - - - - TMonitorList - a list of monitors - - - - MonitorCount - returns a number of monitors - - - - Monitors - provides access to the monitor list array - - - - PrimaryMonitor - return the primary monitor of the system - - - - Monitor - returns the monitor on which the form is mostly places (the biggest form area is placed) - TDefaultMonitor - enumerated type to specify on which monitor to place the form @@ -9781,9 +9247,34 @@ dmPrimary - place the form on the primary monitor dmMainForm - place the form on the same monitor as the main form. If there is no main form then use dmPrimary behavior. dmActiveForm - place the form on the same monitor as the current active form. If there is no active form use dmMainForm behavior. - - Removes all calls added via QueueAsyncCall - This is thread safe. + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml/lcl/lresources.xml b/docs/xml/lcl/lresources.xml index 91ead2b8ec..b28c1649fe 100644 --- a/docs/xml/lcl/lresources.xml +++ b/docs/xml/lcl/lresources.xml @@ -8,16 +8,16 @@ --> This unit maintains and stores all standard Lazarus resources - in the global list + in the global LazarusResources list and provides methods and types for component streaming. -

A Lazarus resource is streamed as an ansistring [UTF-8?], +

A Lazarus resource is streamed as an UTF-8 string, with a name, value and valuetype.

Lazarus resources are normally included via an include directive in the initialization part of a unit. To create such include files use the BinaryToLazarusResourceCode procedure.

-

To create a LRS file from an LFM file use the LFMtoLRSfile function +

To create an LRS file from an LFM file use the LFMtoLRSfile function which transforms the LFM text to binary format and stores it as Lazarus resource include file.

 @@ -50,24 +50,20 @@ - + Text of the "automatically generated..." warning in resource files. - - - - + + - - - - - + [?] + + - + The Lazarus resource descriptor class. @@ -83,33 +79,33 @@ - [?] + The resource type, always uppercase. - [?] + The resource value. - + - The container class for all Lazarus resoucres. + The container class for all Lazarus resources. - - main list with all resource pointers + + Main list with all resource pointers. - list needed for mergesort + List needed for mergesort. @@ -135,7 +131,7 @@ - + @@ -197,7 +193,8 @@ Adds a resource. - + ValueType is stored in uppercase. + @@ -208,10 +205,10 @@ - + A sinlge value string. - + The value splitted into an string array. @@ -228,7 +225,7 @@ - + Should be uppercase, if present. @@ -249,36 +246,29 @@ - + - Helper class for streaming rescources [abstract?]. - - - - - - + Helper class for streaming resources (read only). + + + - + Resource in FPC format. - - - - + + Initializes the resource descriptor. The descriptor must already exist. - - EResNotFound if the resource does not yet exist. + EResNotFound if the resource does not yet exist. - - + The resource name. @@ -289,12 +279,9 @@ Creates an resource stream for a named resource. - - - - - - + + + The resource name. @@ -305,12 +292,9 @@ Creates an resource stream for a resource ID. - - - - - - + + + The resource ID. @@ -321,18 +305,15 @@ Creates an resource stream from an resource descriptor. - - - - - - + + + - + - + @@ -343,277 +324,239 @@ EStreamError SCantWriteResourceStreamError. - - + - + - + - + The resource descriptor, owned by the global resource list[?]. - - - - + + Abstract base class for translators [what's this?] [implemented where?] - - - - + + - Override this method to [do what?] - + The base class for an TReader.OnReadStringProperty handler. + + Override this method to [do what?] - - - - + + - + - + - + - + - + - The translator instance to use [for what?]. - - - - + The default translator instance to use in . + + + - + - - - - - + Stack item type for the nested resource reader/writer. + + - + A list terminated by an EndList [empty entry?]. - + A component has two lists: properties and children. - + A list with a known (stored) number of entries. - + - + - - - - - + Stack item for the nested resource reader. + + + - - - - - + + + - - - - - + + + - - - - - + + + - - - - - + The number of contained collections, needing an EndList. + + - - - - - + + + - - + + - Reader class for resource streams[?] - + Reader for resource streams. + Uses an stack for reading nested objects. + - + - + The input stream buffer. - + Size of the input buffer. - + Current position in the input buffer. - + The number of bytes in the buffer. - - - - - + The object stack. + + - - - - - + + + - - - - - + The Length of the allocated stack. + + - + - + Skip the property name, then the property value. - + Skips until the next empty string [EndList?]. - - - - - - - + Push a new resource item. + + + - + - + - + The Component whose properties follow. - + The number of contained lists, which need an EndList. - - + Pop an item, or decrement its PushCount. + Called on EndList (vaNull) encounterd[?] - - - - + + - - - - - - - + Destroys the stack, during reader destrucion. + + + + - - - - - - - + Reads the 1-byte value type. + + + - + - - - - - - - + Terminate reading a Component list (properties or children). + + + - + Reads an 4 byte integer value. @@ -630,17 +573,17 @@ - The input stream[?] + The input stream. - [?] + The stream buffer size to allocate. - + Peek the next byte (value type indicator). @@ -650,7 +593,7 @@ - + Reads the next ValueType. Pops or pushes a stack item if required (for list or collection). @@ -660,9 +603,10 @@ - + Reads the filer signature from the input. - + EReadError 'Invalid Filer Signature' on filer signature mismatch. + @@ -696,20 +640,17 @@ - - - - - - - + Returns the qualified current item name. + + + - + - + Read a number of bytes from the input stream. @@ -722,7 +663,7 @@ - + Reads binary data, stored with a Length prefix. @@ -732,8 +673,8 @@ - - + Reads an Extended value (10 Bytes). + The result may have less bytes, when Extended is not a 10 byte value. @@ -742,7 +683,7 @@ - + Reads an Single value (4 bytes). @@ -752,20 +693,17 @@ - - - - - - - + Reads an Currency value (8 bytes). + + + - + - + Reads an Date value (8 bytes). @@ -775,16 +713,18 @@ - + Reads an identifier, maybe a name or a standard key (which is not stored). + - + GDB error on an unexpected ValueType. - + The expected type: vaIdent for an stored name, or vaNil, vaFalse, vaTrue, vaNull for an standard string. + @@ -828,20 +768,20 @@ - + Reads enum member names, until an empty string is read. - + The constructed set, as an Integer. - + The expected set type. - + Reads an ShortString. @@ -864,72 +804,61 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + Skips an entire Component. + + + + + + If True: skip prefix, component class name and component object name. + + + - + Skips the next value. - - - - - + The input stream. + + - - - - - + The root component reader[?] + + - - + + - - - - - + Tracking what already has been stored or written. + + now writing header @@ -940,99 +869,78 @@ header written to stream, data written - + - - - - - + Stack item for the nested resource writer. + + + - - - - - + + + - - - - - + + + - - - - - + + + - waiting for this number of Pop + waiting for this number of Pops - - - - + + - nr in a collection or list + Index in a collection or list. - - - - + + - - - - - + + + - - - - - + + + - - - - - + + + - - - - - + + + - - - - - + + + - - + + Object writer for Lazarus Resource Streams. @@ -1073,109 +981,87 @@ - - - - - + + + - + - + - - - + - + - - - - - - - + + + + - + - + - + - + - + - - - - - - - + + + + - - - - - - - + + + + - + - - - - - - - + + + + - - - - - - - + + + + - - - - - - - + + + + - + - + @@ -1274,33 +1160,28 @@ - - - - - - - + + + + - + - - - - - - - + + + + - + - + Writes multiples words (WideChar) with reversed byte order. + @@ -1401,16 +1282,13 @@ - - - - - - - + + + + - + @@ -1477,16 +1355,13 @@ - - - - - - - + + + + - + @@ -1560,206 +1435,134 @@ - - - - - - - + + + + - + - - - - - - - + + + + - + - - - - - + + + - - - - - + + + - - + + - - - - - + [?] + + - - - - - + + + - - - - - + + + - - - - - + + + - - - - - - - - + + - - - - - + [?] + + - - - - - + + + - - - - - - - + - - - - - - - + - + - + - - - - - - - + - + - + - - - - - - - + - + - + - - - - - + + + - + - - - - - - - + - + - + - - - - - - - + - + - + - - - - - - - + - + - + @@ -1767,976 +1570,880 @@ - - - - - + + + - - - - - + Sort the items by LFM or LRS position. + + + - + True for sorting by LFM position. + - - - - - + Searches for an item by LFM or LRS position. + + + - + - + - + True for searching an LFM position. - - - - - + Find a random item within an position range. + + - + - + First acceptable position. - + First position after the range (exclude) - + True for searching LFM positions. - - - - - + Change the position of an item within the given position range. + + + - + First acceptable position. - + First position after the range (exclude) - + The new position. - + True for using LFM positions. - - - - - + + + - + - + - + - - - - - + Indexed access to the LFM positions. + + + - + - - - - - + Indexed access to the LRS positions. + + + - + - - - - - + Indexed access to the Data pointers. + + + - + - - - - - + + + - + Parser for identifiers, and string and number literals. +

+ Use to get the next token. + The token type also is available in Token. +

+ Allowed whitespace is newline (CR,LF), tab and space. +

+ Allowed identifiers consist of ASCII letters, digits or underscore. +

+ Strings are a sequence of quoted strings or #nn characters. +

+ Numbers are parsed as integer or floating point values, + with toFloat values subdivided into number, single, date or currency, + according to FloatType. +

+ All other characters are returned literally. +

- - + - - - - - + The input stream. + + - - - - - + The allocated buffer. + + - - - - - + Number of valid chars (bytes) in the buffer. + + - - - - - + Current position (index) in the buffer. + + - - + Buffer-relative begin of the current line. + + column = fPos - fLineStart + 1 - - + - - - + + + - - - - - + True when reached the end of the input stream. + + - - - - - + Holds the last parsed token text[?] + + - - - - - + The name of a token, maybe the Token character itself. + + - + - + - - - - - + Fills the buffer from the input stream. + + - - - - - + Skips to the next non-null character[?] + + - - - - - + Add the current character to the token string. + + - - - - - + True when the current character is a digit. + + - + - - - - - + True when the current character is a hex digit. + + - + - - + True when the current character is an ASCII character (or underscore). + Should mean: all allowed characters in an identifier. + [To be updated for Unicode identifiers] - - + - + - - - - - + True when the current character is a digit or IsAlpha. + + - + - - - - - + Returns the value of a hex digit. + + - + - + - - - - - + Parses and returns an identifier. + + + EParserError when the current character is not valid for an identifier. + - + - - - - - + Skip CR/LF, adjust SourceLine. + + - - - - - + Skip space and tab chars. + + - - - - - + Skip all whitespace characters. + + - - - - - + Marks end of input reached (fEofReached). + + - - - - - + Parse an identifier. + + - - - - - + Parse a number, + recognizing trailing floating point format specifiers. + + - - - - - + Parse a hex number, prefix the token string with '$'. + + + + EParserError when no valid hex digit was found. + - - - - - + Parse an quoted string, excluding the leading and trailing quotes. + + + EParserError on an unterminated string literal. + - + - - - - - + Parse an decimal Unicode codepoint, return it as an UTF-8 string. + + - + - + Is set to False on a non-ASCII character. - + Parses a string literal. +

+ The string can consist of quoted strings and Unicode codepoints. + Surrounding quote characters are removed. +

+ The result is stored in fLastTokenStr, in UTF-8 encoding. +

+ The resulting token is toString for all-ASCII strings, else toWString. +

- - + - - - - - + Tries to parse a negative number, or a single '-' character. + + + - - - - - + Sets Token to the unrecognized character (no error). + + + - + - - - - - + Asserts that Token is of the expected type. + + + EParserError when Token doesn't match the expected type. + - + The expected token type. - - - - - + Asserts that the given name was parsed (case insensitive). + + + + EParserError when Token doesn't match the expected type or name. + - + The expected identifier. - - - - - + Raises an EParserError with the given message. + + + - + The message text. - - - - - + Raises an EParserError with the formatted message. + + + - + The Format string. - + The arguments to be formatted. - - - - - + Raises an EParserError with the given message, adding source position information. + + + - + - + Writes an hex value into the output stream. + +

+ The hex digits must occur in pairs, for every byte. +

+ The binary bytes are written in input order (highest first). +

- - + + EParserError on unpaired hex digits. + - + The output stream. - - - - - + Parses the next token. + + - + The token type. - - - - - + Returns the current position in the input stream. + + - + - - - - - + Parses an (possibly) qualified identifer, after a symbol has been parsed. + + + EParserError when Token is not toSymbol. + - - - - - + Returns the binary value of a floating point number. + + + EParserError on an invalid number. + - + - - - - - + Returns the binary value of an integral number. + + - + - - - - - + Returns the last parsed token as an string. + + + - + - - - - - + Compares the parsed symbol with the given string (case-insensitive). + + + - + True when a matching symbol has been parsed. - + - - - - - + The type of the parsed floating point number. (number, date...) + + + - - - - - + The current line number in the input stream. + + + - - - - - + The current column number in the source line. + + + - + - - - - - + The last parsed token type. + + A queue to stream components, used for multithreading or network. - The function ConvertComponentAsString converts a component to binary format - with a leading size information (using WriteLRSInt64MB[?]). - When streaming components over network, they will arrive in chunks. - TCustomLazComponentQueue tells you, if a whole component has arrived and if - it has completely arrived. +

+ The function ConvertComponentAsString converts a component to binary format + with a leading size information (using WriteLRSInt64MB). +

+ When streaming components over network, they will arrive in chunks. +

+ TCustomLazComponentQueue tells you, if a whole component has arrived. +

- - - - + + - - - - - - - + - - - - - + + + - - - - - + + + - + - + - + - + - - - - - + + + - - - - - + + + - + - + - + - - - - - + + + - + - + - + - - - - - + + + - + - - - - - + + + - + - + - + - - - - - + Converts a component to binary format + with a leading size information (using WriteLRSInt64MB). + + + - + - + - - - - - + [?] + + - + [?] - + - + - - - - - + Item of TPropertiesToSkip[?] + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + [?] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The list of all loaded standard resources. + + + + - - - - - + [?] + + @@ -2752,22 +2459,19 @@ - - - - - - - + + + + - + - + - + @@ -2819,219 +2523,192 @@ - - - - - - - + + + + - + - + - + - - - - - - - + + + + - + - + - + - + - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + - + - + - + - + - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + - + - + - + - - - - - - - + + + + - + - + - + - - - - - - - + + + + - + - + - + - + - + - + - - - - - - - + + + + - + - + - + - - - - - - - + + + + - + - + - + - + FPC is not optimized for building a constant string out of thousands of lines. + It needs huge amounts of memory and becomes very slow. + Therefore big files are split into several strings. + @@ -3102,53 +2779,47 @@ - - - - - - - + + + + - + - + - + - + - + - - - - - - - + + + + - + - + - + - + - + @@ -3169,7 +2840,7 @@ - + @@ -3198,7 +2869,7 @@ - + @@ -3296,25 +2967,22 @@ - - - - - - - + + + + - + - + - + - + @@ -3378,67 +3046,55 @@ - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + @@ -3547,35 +3203,29 @@ - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + @@ -3594,51 +3244,42 @@ - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + @@ -3747,51 +3388,42 @@ - - - - - - - + + + + - + - + - - - - - - - + + + + - + - + - - - - - - - + Writes an integer value, using the smallest possible representation. + + + - + - + @@ -3885,19 +3517,16 @@ - - - - - - - + + + + - + - + @@ -3920,95 +3549,86 @@ - - - - - - - + + + + - + - + - + - + - - - - - - - + + + + - + - + - + - - - - - - - + + + + - + - + - + - - - - - - - + + + + - + - + - + - + - - - - - - - + Registers the component TLazComponentQueue. + + + + + + Raises an EReadError exception. + + + Raises an InvalidPropertyValue EReadError.