diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index 14c7299463..5b9b0fce63 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -9257,7 +9257,8 @@ Properties are defined in the parent class TPop - + + DoAddDockClient - add the specified control as a client for docking in the specified location (Arect) diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 26608c83b1..9ba7165788 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -260,9 +260,11 @@ wsMaximized - The window appears maximized - Scrolling Window Control + + TScrollingWinControl - a class of Window Contrl 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 +An ancestor class for many forms with scrolling windows + @@ -327,10 +329,12 @@ An ancestor class for many forms with scrolling windows - Control Scroll Bar + + 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 +This is an ancestor class for many form types and classes of windowed controls + @@ -396,13 +400,15 @@ This is an ancestor class for many form types and classes of windowed controls - + + FControl - local variable to hold the Window Control to which the scroll bar belongs - + + ControlAutoScroll - returns True if the control can Auto-Scroll @@ -413,7 +419,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + ControlHandle - the operating system handle for this control @@ -424,7 +431,8 @@ 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 @@ -435,7 +443,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + GetPage - returns the size of the Page-Down (or -Up) Increment for the scroll bar @@ -446,7 +455,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + GetPosition returns the position of the slider in the scroll bar @@ -457,7 +467,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + GetRange - returns the valid range of values for the scroll bar movement @@ -468,7 +479,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + GetSize - returns the size of the scroll bar @@ -479,7 +491,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + GetSmooth - returns True if smooth scrolling is to be used @@ -490,7 +503,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + GetVisible - returns True if the scroll bar is visible @@ -501,7 +515,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + HandleAllocated - returns True if a handle has been allocated @@ -512,7 +527,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + SmoothIsStored - returns True if the Smooth status has been stored @@ -523,7 +539,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + VisibleIsStored - returns True if the Visible status has been stored @@ -534,21 +551,24 @@ This is an ancestor class for many form types and classes of windowed controls - + + AutoCalcRange - method for automatically calculating the range of values for the scroll bar - + + ControlUpdateScrollBars - method to be used by the owner control for updating its scrollbars - + + ScrollHandler - message handler to control scrolling @@ -559,7 +579,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + SetIncrement - specifies the scrolling increment @@ -570,7 +591,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + SetPage - specifies the page scrolling increment @@ -581,7 +603,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + SetPosition - specifies the position of the slider in the scroll bar @@ -592,7 +615,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + SetRange - specifies the range of values for the scroll bar @@ -603,7 +627,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + SetSize - specifies the size of the scroll bar @@ -614,7 +639,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + SetSmooth - specifies whether smooth scrolling is to be used @@ -625,7 +651,8 @@ This is an ancestor class for many form types and classes of windowed controls - + + SetVisible - specifies whether the scroll bar is to be visible @@ -636,14 +663,16 @@ This is an ancestor class for many form types and classes of windowed controls - + + UpdateScrollBar - method to update the scroll bar (position etc) - + + InvalidateScrollInfo - method to render scroll information non-valid @@ -1315,7 +1344,9 @@ If the indicators are valid, re-computes position etc - Custom Frame: The base type for Frame + + TCustomFrame - the base type for TFrame + @@ -1413,7 +1444,8 @@ If the indicators are valid, re-computes position etc - Frame - a container for all the other components on a form, or for a group of components within a form + + TFrame - a container for all the other components on a form, or for a group of components within a form @@ -1697,14 +1729,16 @@ If the indicators are valid, re-computes position etc - Specifies which icon appears on the top border of the Form + + TBorderIcon - enumerated type to specify which icon appears on the top border of the Form biSystemMenu - The form has a System menu (Maybe not all windowmanager supports this)
biMinimize - The form has an minimize button
biMaximize - The form has a maximize button
-biHelp - When you click this button a Question Cursor appears and the help routines are called if you click on an control +biHelp - When you click this button a Question Cursor appears and the help routines are called if you click on an control + @@ -1725,7 +1759,8 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + TBorderIcons - set of TBorderIcon; the group of icons to appear at the top of the form @@ -1809,8 +1844,20 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - + + TFormStateType - enumerated type to describe the state of a form; whether it is being created or destroyed, its visibility, whether Modal etc + +

The valid states are:

+ 
fsCreating,  // initializing (form streaming)
+    fsVisible,   // form should be shown
+    fsShowing,
+    fsModal,     // form is modal
+    fsCreatedMDIChild,
+    fsBorderStyleChanged,
+    fsFormStyleChanged,
+    fsFirstShow,  // form is shown for the first time
+    fsDisableAutoSize
+ @@ -1851,13 +1898,15 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + TFormState - the set of form states that apply to this form - + + TModalResult - the range of values that can be returned as a modal result @@ -3705,14 +3754,16 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + TCustomFormClass - class of TCustomForm + - Form - the fundamental visual object that appears in every application with a Graphical User Interface. + Form - the fundamental visual object that appears in every application with a Graphical User Interface.

Form - the fundamental visual object that appears in every GUI application.

Most of the properties are inherited from the ancestors

@@ -4161,21 +4212,22 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + TFormClass - class of TForm + - TCustomDockForm - Base class for docking forms + + TCustomDockForm - Base class for docking forms - - - DoAddDockClient - add the specified control as a client for docking in the specified location (Arect) + @@ -4443,7 +4495,9 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + THintWindowClass - class of THintWindow + @@ -5199,9 +5253,7 @@ biHelp - When you click this button a Question Cursor appears and the help routi - - - RemoveAllHandlersOfObject - method for removing all of an object's handlers + @@ -5742,10 +5794,12 @@ biHelp - When you click this button a Question Cursor appears and the help routi - Application - the whole current program, described as an object + + TApplication - the whole current program, described as an object -

Application - 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

+

+ 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

 @@ -6372,7 +6426,8 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + + GetConsoleApplication - returns True if this is a Console application (ie text-mode, non-GUI) @@ -6829,7 +6884,7 @@ It also writes details of the exception to the appropriate place for debugging. Message Box: a useful function to display a message.

- Message Box: a useful function to display a message.

+ MessageBox: a useful function to display a message.

The function is used internally to display messages during the handling of Exceptions , but is also available to application programmers as an alternative to some of the message dialogs found in Dialogs

@@ -8138,7 +8193,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetCaptureExceptions - specifies whether exceptions are to be captured @@ -8149,7 +8205,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetHelpFile - specifies which file is to be used for Help messages @@ -8160,7 +8217,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetHint - specifies the text for a Hint @@ -8171,7 +8229,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetHintColor - specifies the colour for displaying hints @@ -8182,7 +8241,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetHintHidePause - specifies the length of pause before a hint becomes hidden @@ -8193,7 +8253,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetHintPause - specifies the length of pause before a hint is displayed @@ -8204,7 +8265,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetHintShortCuts - specifies whether hints are to be displayed for Shortcut keys @@ -8215,7 +8277,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetHintShortPause - specifies the length of pause before a shortcut key hint is displayed @@ -8226,7 +8289,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetShowHint - specifies whether hints are to be displayed @@ -8237,7 +8301,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetTitle - specifies the title for the Form @@ -8248,7 +8313,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnException - specifies the event handler for exceptions @@ -8259,7 +8325,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnIdle - specifies the handler for Idle events @@ -8270,7 +8337,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnIdleEnd - specifies the handler to notify the end of an idle period @@ -8281,7 +8349,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnEndSession - specifies the event handler to notify the end of a session @@ -8292,7 +8361,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnQueryEndSession - specify the event handler for a query at the end of a session @@ -8303,7 +8373,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnMinimize - specify the event handler for minimising the application form @@ -8314,7 +8385,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnRestore - specify the event handler for restoring the application's form @@ -8325,7 +8397,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnDropFiles - specify the event handler for dropping files @@ -8336,7 +8409,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnHelp - specify the event handler for help requests @@ -8347,7 +8421,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnHint - specify the event handler for a request to show hints @@ -8358,7 +8433,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnShowHint - specify the event handler for showing hints @@ -8369,7 +8445,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + SetOnUserInput - specify the event handler for dealing with User input @@ -8431,14 +8508,14 @@ Navigation Options is a set, so can take zero or more of the available values - HintHidePause - the lenght of pause before a hint becomes hidden + HintHidePause - the length of pause before a hint becomes hidden - HintPause - th elenght of pause before a hint is desplayed + HintPause - the length of pause before a hint is displayed @@ -9282,7 +9359,8 @@ Navigation Options is a set, so can take zero or more of the available values - + + TMessageBoxFunction - the function to be used by a message box: specifies Text and Flags, and returns an integer value @@ -9397,6 +9475,11 @@ Navigation Options is a set, so can take zero or more of the available values SmallIconHandle - system handle for small Icon + + + + BidiMode - whether bi-directional mode is available + diff --git a/docs/xml/lcl/graphics.xml b/docs/xml/lcl/graphics.xml index 0ee8db5b18..bc0a95b509 100644 --- a/docs/xml/lcl/graphics.xml +++ b/docs/xml/lcl/graphics.xml @@ -14355,6 +14355,17 @@ be carefull with this, modify only within a begin/endupdate JoinStyle - the style of joint where two lines meet or cross + + + TPenHandleCacheDescriptor - a cache descriptor for Pen Handles + + + + ExtPen - an external pen + + + The Pattern for this pen + diff --git a/docs/xml/lcl/lclclasses.xml b/docs/xml/lcl/lclclasses.xml index 93b1c881da..05078b43d9 100644 --- a/docs/xml/lcl/lclclasses.xml +++ b/docs/xml/lcl/lclclasses.xml @@ -63,7 +63,7 @@ - RemoveAllHandlersOfObject - part of clean-up procedure + RemoveAllHandlersOfObject - method for removing all of an object's handlers: part of a clean-up procedure