diff --git a/docs/xml/lcl/editbtn.xml b/docs/xml/lcl/editbtn.xml index 2717c26c32..80a6353e02 100644 --- a/docs/xml/lcl/editbtn.xml +++ b/docs/xml/lcl/editbtn.xml @@ -2,2657 +2,3370 @@ + ==================================================================== + EditBtn + ==================================================================== + --> - Defines some special Edit Boxes with attached Speed Buttons + Defines specialized edit controls with attached speed buttons - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a date type without a value assigned - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - DoPositionButton - perform the code to place the button in position - - - - - - - - DoButtonClick - software emulation of the OnButtonClick event - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ButtonWidth - the width of the SpeedButton attached to the Edit Box - - - - - - - DirectInput - if True, direct data input to the Edit Box is permitted - - - - - - - Glyph - the small graphic image on the SpeedButton, which ought to indicate its function - - - - - - - NumGlyphs - the number of available glyphs - - - - - - - OnButtonClick - event handler for a mouse click on the SpeedButton - - - - - - - Button - the SpeedButton that is attached to the Edit Box - - - - - - - Create - constructor for TCustomEditButton: calls inherited Create then sets some -defaults and initializes some variables + + + Implements the embedded edit control used in TCustomEditButton

- Create - constructor for TCustomEditutton: calls inherited Create then sets -some defaults and initializes some variables

-

Initializes height and width, cursor, glyph, style, checks visibility, event handler for click

+ TEbEdit is a TGEEdit descendant which implements the embedded edit control used in TCustomEditButton. TEbEdit provides overridden methods to alter the behavior of the control when handing OnEnter and OnExit notifications. +

- - TComponent.Create - TCustomEdit.Create - TWinControl.Create + - - - + + + + + - - - + + + + + + + + + Implements a speed button used in TCustomEditButton + +

+ TEditSpeedButton is a TSpeedButton descendant which provides support for change notifications for Glyphs used on the Button in TCustomEditButton. +

+ + + + + + + + + Performs actions needed when the glyph has changed for the Button in TCustomEditButton + + + + + + Object generating the event notification + + + + + TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button + + +

+ TCustomEditButton is a TCustomAbstractGroupedEdit descendant which implements a composite control with both an Edit and a Button. It provides overridden methods which extend or re-implement those found in the ancestor class. Most of the properties in the class are declared as protected, and must be exposed as public or published properties in an ancestor class like TEditButton. +

+ + + + + + + + + + + + + + Gets the value for the FocusOnButtonClick property - + + + + + + Value for the property + + + + Gets the value for the OnButtonClick property + + + + + + + Value for the property + + + + Gets the value for the Button property + + + + + + + Value for the property + + + + Gets the value for the Glyph property + + + + + + + Value for the property + + + + Gets the value for the NumGlyphs property + + + + + + + Value for the property + + + + Gets the value for the Edit property + + + + + + + Value for the property + + + + Sets the value for the FocusOnButtonClick property + + + + + + + New value for the property + + + + Sets the value for the OnButtonClick property + + + + + + + New value for the property + + + + Sets the value for the ButtonOnlyWhenFocused property + + + + + + + New value for the property + + + + Sets the value for the Flat property + + + + + + + New value for the property + + + + Sets the value for the Glyph property + + + + + + + New value for the property + + + + Sets the value for the NumGlyphs property + + + + + + + New value for the property + + + + Gets the value for the Images property + + + + + + + Value for the property + + + + Sets the value for the Images property + + + + + + + New value for the property + + + + Gets the value for the ImageIndex property + + + + + + + Value for the property + + + + Sets the value for the ImageIndex property + + + + + + + New value for the property + + + + Gets the value for the ImageWidth property + + + + + + + Value for the property + + + + Sets the value for the ImageWidth property + + + + + + + New value for the property + + + + Performs actions needed when the button for the control is clicked + +

+ The implementation for ButtonClick is empty in TCustomEditButton; use a descendent class which implements a specific functionality. +

+ - + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the default size used for new instances of the class + +

+ The return value is a TSize type with the dimensions for the control. The CX member contains the width needed for both the Edit and the Button controls in the grouped edit control. The CY member contains the height used for the Edit and the Button controls. +

+

+ GetControlClassDefaultSize is called in the constructor for the class instance, and used to set the initial bounds for the control. +

+ + + + + + + + + + TSize value with the dimensions for the new class instance + + + + Indicates whether the Button for the control should be visible + +

+ CalcButtonVisible is a Boolean function used to determine whether the Button for the control should be visible. The return value is True when the control is Visible and the Edit has focus, or the control is not configured to display its button only when focused. +

+ + Please note: The return value is always True at design-time. + +

+ CalcButtonVisible is used in the implementation of the CheckButtonVisible method. +

+ + + + + + + + + + + + + + + GetDefaultGlyphName finds the name of the default glyph used for the Button + + + + + + + + + + + + + + + Ensures the Button for the control is configured and its visibility is set + +

+ CheckButtonVisible is a procedure which ensures that the Button in the control is configured and its visibility is set. If Button has not been assigned (contains Nil), no actions are performed in the method. +

+

+ Otherwise, the Visible property in Button is set to the value returned by CalcButtonVisible. UpdateSpacing is called to adjust the space between Edit and Button as needed for its visibility and Layout. +

+ + + + + + + + + + + Loads the default glyph displayed on the Button for the control + + + + + + Performs action needed when the glyph assigned in Button has changed + + + + + + + + + + Button is the TSpeedButton that is attached to the grouped edit control + + + + + + + Contains the caption used for the Button on the grouped edit control + + + + + + + Cursor shape displayed when the mouse hovers over the Button in the control + + + + + + + + ButtonHint is the hint that pops up when the mouse hovers over the button + + + + + + + + ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control + + + + + + + + ButtonWidth is the width for the TSpeedButton used in the grouped edit control + + + + + + + + Edit is the TEbEdit control used to perform direct input for the value in the grouped edit control + + + + + Flat - if True, SpeedButton appears flat rather than three-dimensional - - + + - ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control - - + Indicates if the focus is changed to the Edit control after the Button is clicked + + + - - + + - TEditButton, an Edit Box with attached Speed Button - - - - - - - + Glyph - the small graphic image on the SpeedButton, which ought to indicate its function - - - TEditButton default is True - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - TAcceptFileNameEvent - generic event handling method to accept a filename from a dialog + NumGlyphs - the number of available glyphs - - - - - - - - - - + + - TDialogKind - enumerated type for kind of dialog: open, save, pictureopen or picturesave - - + Contains the Images that can be displayed on the Button for the grouped edit control + + + - - - - - - - - - - - - - - - - - - + + - TFileNameEdit - an EditBox to hold a filename, with an attached SpeedButton that will summon a File Open dialog - - - + Ordinal position in Images for the bitmap displayed on the Button control + + +

+ Read and write access for the property are redirected to the ImageIndex property in Button. +

+ + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - CreateDialog - creates the dialog for file open - - - + Specifies the width of the image displayed on the Button control + + + - - - - - - - - - - + + - SaveDialogResult - stores the result of the dialog - - - + Specifies the amount of space reserved between the Edit and Button controls when Button is visible + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - RunDialog - perform the function of the dialog - - - - - - - - - - - - - - - - - - - - - - - - - - DialogFiles - the list of files for the dialog - - - - - - - FileName - the name of the selected file: either the initial value placed in the Text Box, or the value selected from the dialog - - - - - - - InitialDir - the directory from which the search starts - - - - - - - OnAcceptFileName - event handler for accepting a filename - - - - - - - DialogKind - should be dkOpen + OnButtonClick - event handler for a mouse click on the SpeedButton - + + + + Create - constructor for TCustomEditButton: calls inherited Create then sets some defaults and initializes some variables + + +

+ Create - constructor for TCustomEditButton: calls inherited Create then sets some defaults and initializes some variables. +

+

+ Initializes height and width, cursor, glyph, style, checks visibility, event handler for click. +

+ + + TComponent.Create + TCustomEdit.Create + TWinControl.Create + + + + Owner of the class instance + + + + Destructor for the class instance + + + + + + + Implements a grouped edit control with both an Edit and a Button + + +

+ TEditButton implements a grouped edit control with both an Edit and a Button. TEditButton is derived from the TCustomEditButton class, and sets the visibility for properties declared in the ancestor classes. +

+ + + + + + + + + + + + + + + + + The default value is True in TEditButton + + + + + + + + + + + + Style for the Border drawn around the control + +

+ The default value for the property is bsNone in TEditButton. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + String filter options which can be enabled in controls + +

+ TFilterStringOption is an enumerated type with values representing string filter options which can be enabled in controls which support the feature. TFilterStringOption values are stored in the TFilterStringOptions set type used to implement the FilterOptions property in TCustomControlFilterEdit. +

+ + + + + + + + Value comparisons are case sensitive + + + Value comparisons start at the beginning to the string value + + + + Set type used to store values from the TFilterStringOption enumeration + + + + + + + + + + Specifies an event handler used to filter data items in TCustomControlFilterEdit + + +

+ TFilterItemEvent is a Boolean object function type that specifies an event handler used to filter data items in TCustomControlFilterEdit. The return value is True if an item matches a filter condition implemented in the event handler. Done can be updated to indicate if the item requires additional filtering on the title string in the data item; when it contains True, no additional filtering is needed. +

+

+ TFilterItemEvent is the type used for the OnFilterItem event handler in TCustomControlFilterEdit. +

+ + + + + + + + + True if the item matches the filter implemented in the event handler + + + Pointer to the data for the item examined in the event handler + + + Indicates if additional filtering is needed on the title of the item data + + + + + Specifies an event handler used to filter data items in TCustomControlFilterEdit + + +

+ TFilterItemExEvent is a Boolean object function type that specifies an event handler used to filter data items in TCustomControlFilterEdit. It is similar to TFilterItemEvent, but provides an additional argument with the caption for the data item. +

+

+ The return value is True if an item matches a filter condition implemented in the event handler. Done can be updated to indicate if the item requires additional filtering on the title string in the data item; when it contains True, no additional filtering is needed. +

+

+ TFilterItemEventEx is the type used for the OnFilterItemEx event handler in TCustomControlFilterEdit. +

+ + + + + + + + + True if the item matches the filter implemented in the event handler + + + Caption or display name for the item examined in the event handler + + + Pointer to the data for the item examined in the event handler + + + Indicates if additional filtering is needed for the caption or item data + + + + Specifies an event handler is to determine if the specified Item is checked + +

+ TCheckItemEvent specifies an event handler that can be used only for items that have a checkbox. Returns True when the item is checked. It will be necessary to cast the object instance in Item to the correct data type in the event handler to access properties introduced in a TObject descendant. +

+

+ TCheckItemEvent is the type used to implement the OnCheckItem event handler in TCustomControlFilterEdit. +

+ + + + + + + True when the item is checked + + + Object examined in the method + + + + + Base class for edit controls which filter data in an associated container control like TListbox or TTreeview + + +

+ When the container control is connected to a filter control, the filtering happens automatically as a user enters text. When the filter is empty and does not have focus, it displays the greyed value "(filter)". +

+ + + + + + + + + + + + + Sets the value for the Filter property + + + + + + + New value for the property + + + + Sets the value for the IdleConnected property + + + + + + + New value for the property + + + + + Event handler signalled to apply a filter when an Application becomes idle + + +

+ OnIdle is a procedure which implements a TIdleEvent event handler signalled to apply a filter when the Application becomes idle. OnIdle is assigned (using AddOnIdleHandler) or removed (using RemoveOnIdleHandler) in the global Application instance when the value in IdleConnected is changed. +

+

+ OnIdle uses an internal flag to determine if an update is needed, and when set, calls ApplyFilter to activate the filter and resets the flag value. Use the OnFilterItemEx or OnFilterItem (deprecated) event handlers to perform actions needed to implement the filter. +

+

+ OnIdle signals the OnAfterFilter event handler (when assigned). +

+ + + + + + + + + + + Object for the event notification + + + + + + + + Indicates if the value in TextHint is stored in the LCL component streaming mechanism + + +

+ The value is True when TextHint contains a value other than the rsFilter resource string. +

+ + + + + True when TextHint is included in the LCL component stream + + + + + Flag which indicates that the filter has been updated and needs to be applied + + + + + + Flag indicating if the filter has ever been applied + + + + + Node to select during the next update + + + + Stores the event handler in the OnFilterItem property + + + + Stores the event handler in the OnFilterItemEx property + + + + Stores the event handler in the OnCheckItem property + + + + + Ensures that the Canvas for the control is freed before the window handle is destroyed + + + Calls the inherited DestroyWnd method. + + + + + + + Provides a default routine used to examine an item in the filtered edit control + + +

+ Signals the OnFilterItemEx (preferred) or OnFilterItem (deprecated) event handlers (when assigned) to determine if the item meets the filter condition. Values in ACaption and ItemData are passed as arguments to the event handlers. +

+

+ The return value is True when the item meets the filter condition(s) implemented in the event handlers. The DoDefaultFilterItem method is called when the return value is False, or the event handlers are not assigned in the class instance. +

+ + + + + + + + + True when the item meets the filter condition + + + Caption for the item passed to DoDefaultFilterItem + + + Pointer to the data for the item examined in the method + + + + Filters items using the handlers for the control + + + + + Returns True when the item meets the filter criterion + + + Caption for the item + + + Pointer to the data for the item + + + + Gandles a KeyDown event for the Edit control + + + + + + + + + + + + Performs actions needed when the Edit is changed + + + + + + + + + + + + + +

+ SortAndFilter is an abstract virtual method in TCustomControlFilterEdit. It must be implemented in a descendent class to provide the specific functionality needed. +

+ + + + + + Filters the data and updates the container + +

+ Does its job at once when Immediately is set to True. Otherwise, it connects the OnIdle event handler which applies the filter when the Application is idle. +

+ + + + Indicates the filter is applied immediately + + + + + Applies the Filter data to the container component + + + Method that actually filters data in the container component. ApplyFilterCore is a virtual abstract method, and must be implemented in a derived classes. + + + + + + + + Abstract virtual method that must be implemented in a descendent class. + + + + + + + + + + + Abstract virtual method that must be implemented in a descendent class. + + + + + + + + + + + Abstract virtual method that must be implemented in a descendent class. + + + + + + + + + + + Abstract virtual method that must be implemented in a descendent class. + + + + + + + + + + + Abstract virtual method that must be implemented in a descendent class. + + + + + + + + + + + Abstract virtual method that must be implemented in a descendent class. + + + + + + + + + + + Abstract virtual method that must be implemented in a descendent class. + + + + + + + + + + + + Registers the class reference used to create new instances of the class + + + + + + Constructor for the class instance + +

+ Create is the constructor for the class instance, and calls the inherited constructor. Create sets the default values for properties used to configure the Edit and Button in the class instance as well as its internal flags, including: +

+
+
CharCase
+
Set to ecLowerCase
+
Button.Enabled
+
Set to False
+
FilterOptions
+
Set to an empty set
+
FIsFirstUpdate, fIsFirstSetFormActivate
+
Set to True
+
TextHint
+
Set to rsFilter
+
+ + + + + Owner for the class instance + + + + Destructor for the class instance + + + + + + Should be called when data was changed and it must be filtered again + Connects to OnIdle handler which filters the data later. + + + + Removes the filter text and shows all items in the container + + + + Applies a new filter immediately without waiting for idle. Returns the previous filter. + + + + + Stores the current selection for the associated control in the class instance + + +

+ StoreSelection is an abstract virtual method, and must be implemented in a derived class to use the correct class type for items in the associated control. +

+

+ Used in the implementation of the ApplyFilter method. +

+ + + + + + + + + + + + + + + The textual representation for the filter + + Typically a user types it in the edit control but it can also be set in code. Filtering is done during idle time after the value of Filter text has changed. + + + + + Lowercase variant of the Filter property + +

+ FilterLowercase is a read-only String property which contains a variant of Filter converted to lowercase characters. It is used in the implementation of the DoDefaultFilterItem method when case sensitivity is not enabled in the FilterOptions property ( fsoCaseSensitive is not included). The property can be used in a similar manner in routines assigned to the OnFilterItem and OnFilterItemEx event handlers. +

+

+ The value for FilterLowercase is derived and assigned when the value in the Filter property is changed. +

+ + + + + + + + + + + + Indicates if OnIdle has been connected to the Application singleton + + +

+ IdleConnected is a Boolean property which indicates if the OnIdle event handler in the class instance has been connected to the Application singleton. When set to True, the Filter in the control will be applied when the application is in an idle state. +

+

+ Changing the value in the property causes the Application singleton to be updated by calling either the AddOnIdleHandler or the RemoveOnIdleHandler method. The address for the OnIdle method in the class is passed as an argument. +

+

+ IdleConnected is set to True in the InvalidateFilter method. +

+

+ IdleConnected is set to False in the OnIdle method after the Filter has been applied for the control. +

+

+ The default value for the property is False. +

+ + + + + + + + + + + + + + + Items can be sorted while they are filtered. + + + + + For retaining selection in the filtered control. The actual type depends on the control. + + + + + + + + Contains options which control string comparisons for filters in the control + + +

+ FilterOptions is a TFilterStringOptions property which contains zero (0) or more TFilterStringOption enumeration values(s). Values in FilterOptions determine how string comparisons are performed in the DoDefaultFilterItem method. See for more information about the enumeration values and their meanings. +

+

+ The default value for the property is an empty set ([]). +

+ + + + + + + + + + + Called after all items are filtered. + + + + + An event handler to give extra conditions for filtering, in addition to the default behavior. Returns True if the passes the filter. + + + This feature has for example enabled filtering the Options windows in Lazarus IDE, based on captions of all controls on the options pages. Deprecated. Use OnFilterItemEx with a caption parameter instead. + + + + + + + + + + + + Has effect when items in the filtered container can be checked. Typically a CheckListbox. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TAcceptFileNameEvent - generic event handling method to accept a filename from a dialog + + + + + + Object for the event notification + + + File name examined in the event handler + + + + + Enumerated type representing dialog styles used in TFileNameEdit + + +

+ TDialogKind is an enumerated type representing the dialog styles available for use in TFileNameEdit. Values in the enumeration influence the common dialog type created for a control which displays a dialog when its button is clicked. +

+

+ TDialogKind is the type used to implement the DialogKind property in TFileNameEdit. +

+ + + + + + + An Open dialog + + + A Save dialog + + + An Open dialog for image types + + + A Save dialog for image types + + + + + TFileNameEdit - an EditBox to hold a filename, with an attached SpeedButton that summons a File Open dialog + + +

+ TFileNameEdit is a TCustomEditButton descendant which implements a grouped edit control used to select and edit a file name on the local file system. The control provides the Edit and Button properties from the ancestor class, and executes a dialog when the Button is clicked. New properties are introduced which allow configuring the control to a specific file path, filters to select files of particular type or file extension, and to hide or show directories in its dialog. +

+ + + + + + + + + + + + + + + + + + + + Sets the value for the FileName property + + + + + + + New value for the property + + + + Gets the default glyph name used for the Button on the control + +

+ The return value contains the resource ID in the ResBtnFileOpen constant. The value is used in the LoadDefaultGlyph method defined in TCustomEditButton. +

+ + + + + + + + + Creates the dialog for the control + +

+ CreateDialog is a TCommonDialog function which creates and returns the dialog for the grouped edit control. +

+

+ AKind contains the TDialogKind value that identifies the dialog type required for the control, and normally has the value from the DialogKind property. AKind determines the class type instantiated and used as the return value. For example: +

+
+
dkOpen
+
TOpenDialog is the type in return value
+
dkPictureOpen
+
TOpenPictureDialog is the type in return value
+
dkSave, dkPictureSave
+
TSaveDialog is the type in return value
+
+

+ Properties relevant to the dialog kind are copied into the dialog, and mat include: +

+
    +
  • FileName
    • +
  • Path information extracted from FileName
    • +
  • InitialDir
    • +
  • DefaultExt
    • +
  • Filter
    • +
  • FilterIndex
    • +
  • DialogOptions
    • +
  • DialogTitle
    • +
+

+ CreateDialog is used in the implementation of the RunDialog method. +

+ + + + + + + + + Dialog class instance created in the method + + + Identifies the dialog kind or type created in the method + + + + + SaveDialogResult - stores the result of the dialog + + +

+ SaveDialogResult is a procedure used to capture the results from the dialog when it has finished execution. The values are stored in the corresponding properties in the class instance, and depending on the DialogKind, may include: +

+
    +
  • FilterIndex
    • +
  • FileName
    • +
  • DialogFiles
    • +
+

+ SaveDialogResult is used in the implementation of the RunDialog method. +

+ + + + + Dialog type in the D argument + + + Dialog examined in the method + + + + Performs actions needed when the Button for the control is clicked + +

+ ButtonClick is an overridden method used to perform actions needed when the Button for the control is clicked. For TFileNameEdit, the RunDialog method is called to execute the dialog for the control and to capture it results. When FocusOnButtonClick is set, the FocusAndMaybeSelectAll method is called to give focus to the Edit control in the class. +

+ + + + + + + + + + + + Performs actions needed when the value for the control has been changed + + + + + + Signals the OnFolderChange event handler (when assigned) + + + + + + + + + Constuctor for the class instance + +

+ Create is the overridden constructor for the class instance, and calls the inherited constructor. Create allocates resource needed for the DialogFiles property, and sets the default values for the DialogKind and DialogOptions properties. +

+ + + + + + + + + Owner of the class instance + + + + Destructor for the class instance + + + + + + + RunDialog executes the dialog for the control + + + + + + + + + + + DialogFiles is the list of files for the dialog + + +

+ DialogFiles is a read-only TStrings property used to store one or more file names found when the dialog for the control is executed. DialogFiles is updated in the SaveDialogResult method. For open dialogs, DialogFiles is set to the files returned by the dialog. For save dialogs, the content in DialogFiles is cleared. +

+ + + + + + + + + + + FileName - the name of the selected file: either the initial value placed in the Text Box, or the value selected from the dialog + + + + + + + + InitialDir is the directory from which the search starts + + + + + + + + OnAcceptFileName is an event handler for accepting a filename + + + + + + + Event handler signalled when the path to FileName has changed + + + + + + + Determines the dialog type executed when the Button in the control is clicked + + +

+ DialogKind is a TDialogKind property that indicates the type of dialog executed when the Button for the control is clicked. The default value for the property is dkOpen, as assigned in the constructor. Use one of the other TDialogKind enumeration values to perform its corresponding action. +

+ + + + + + + + + - DialogTitle - the title to appear on the dialog - - + DialogTitle - the title to appear on the dialog + + +

+ DialogTitle is a String property that contains the title displayed on the dialog executed by clicking on Button. The value in DialogTitle is assigned to the TCommonDialog descendant created in the CreateDialog method. +

+ + + + + - + - DialogOptions - set of options for the open file dialog - - + DialogOptions - set of options enabled for the file open dialog + + +

+ DialogOptions is a TOpenOptions property which contains the options enabled for a File Open dialog. The default value for the property is defined in the DefaultOpenDialogOptions constant. +

+

+ Values in DialogOptions control the functionality and visual appearance of the dialog displayed for the control. See for more information about the enumeration values used in DialogOptions. +

+ + + + + + + - + Filter - the filtering string to help search for the required file - + - FilterIndex - index value for the filtering string + FilterIndex - index value for the filtering string + - - - - - + + + Default file extension used in the dialog for the component + + - - - - - + + + Hide directory name from edit + +

+ If HideDirectories is set to true, the file name editor displays only a file name, without path. +

+ + This may be useful if application allows user to select files from a fixed directory with a long path. + + - + + + Text displayed on the button for the control + + + + + + + Cursor shape displayed when hovering the mouse over the button for the control + + + + + + + Text displayed in the balloon hint for the button in the control + + + + - + Controls visibility of the Button when the control loses focus - - - + + + Width of the Button displayed in the control - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - TDirectoryEdit - an EditBox to hold a directory name, with an attached SpeedButton that will summon a Directory Open dialog + TDirectoryEdit - an EditBox to hold a directory name, with an attached SpeedButton that summons a Directory Open dialog + - - TSelectDirectoryDialog + - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + - + Gets the value for the Directory property - - + + + - - + Value for the property - + - + Sets the value for the Directory property - - + + + - - + New value for the property - + + + + + + + - CreateDialog - create the Directory Open dialog - - - + Creates and configures the dialog for the control + + +

+ CreateDialog is a TCommonDialog function which creates and configures the Directory Open dialog executed when the Button is clicked for the control. In TDirectoryEdit, the class type instantiated and used as the return value is actually TSelectDirectoryDialog. +

+

+ CreateDialog ensures that values for the InitialDir and FileName properties in the dialog are set using the properties in the class instance. Directory and Filename are used in the the dialog when the directory exists on the local file system. Otherwise, the initial directory is set to the value in RootDir and the file name is set to the value in Directory. +

+

+ CreateDialog set the options in the dialog to the values specified in DialogOptions, and the value in DialogTitle is used as the title for the dialog. +

+

+ CreateDialog is used in the implementation of the RunDialog method. +

+ + + + + + + + + + - - + Dialog created and configured in the method - + - - GetDialogResult - find the result of the Directory Open dialog - - - + Gets the result from the specified dialog + +

+ GetDialogResult is a String function used to get the result from the Select Directory dialog. The return value contains the value from the FileName property in the TSelectDirectoryDialog instance in D. The return value, when accepted in OnAcceptDirectory, is stored in the Directory property. +

+

+ GetDialogResult is used in the implementation of the RunDialog method. +

+ + + + + + + + - - + Directory name from the dialog - - + Dialog examined in the method - - - - - - + + + Implements the button handler for the Button in the control + +

+ ButtonClick is an overridden method used to implement the button click handler for the Button in the control. ButtonClick calls the inherited method, and calls RunDialog to display the dialog and capture the directory name. When the dialog has completed, and FocusOnButtonClick is set to True, the FocusAndMaybeSelectAll method is called to give focus to the Edit control and select text as needed. +

+

+ ButtonClick is called from the BuddyClick method in the ancestor class. +

+ + + + + + + + + - - - + + + + + Constructor for the class instance + +

+ Create is the overridden constructor for the class instance, and calls the inherited constructor. Create sets the values in the DialogOptions property to the defaults in DefaultOpenDialogOptions. +

+ + + + + - - - - - - + + Owner of the class instance - - - - - + - RunDialog - perform the function of the dialog - - - + Executes the dialog for the control and stores the return value + + +

+ RunDialog is a procedure used to execute the dialog for the control, and to store the selected directory name in the control. RunDialog calls CreateDialog to create and configure the dialog executed in the method. When the dialog has completed successfully, GetDialogResult is called to capture the selected directory name. +

+

+ When assigned, the OnAcceptDirectory event handler is signalled to accept or reject the selected directory name. When rejected, the return value is ignored. When accepted, the value returned from the dialog is stored in the Directory property. +

+

+ RunDialog is used in the implementation of the ButtonClick method. +

+ + + + + + + + + + - - - - - - - - - - - - - - - - - - - + The Directory selected by the dialog - - + +

+ Directory is a String property which contains the active directory, and the value displayed in the Edit for the control. +

+

+ Directory and RootDir determine the values used in the Select Directory dialog executed when the Button is clicked for the control. When Directory is a valid file path on the local file system, it is used as the initial directory displayed in the dialog. Otherwise, the value in RootDir is used as the initial directory and Directory is used as the file name in the dialog. +

+

+ The value in Directory is updated in the RunDialog method when the dialog for the control has been executed successfully. +

+ + + + + + + - + - RootDir - the root directory for searching - - + The root directory for file system navigation in the control + + +

+ RootDir is a String property which identifies the root directory for file system navigation in the Select Directory dialog for the control. Its value, along with Directory, is used in the CreateDialog method to configure the dialog. +

+

+ RootDir is relevant when Directory does not represent a valid path on the local file system. It is used as the initial directory in the Select Directory dialog. When Directory is a valid file path, RootDir is ignored. +

+ + + + + + - + - OnAcceptDirectory - event handler for accepting the name of a directory + OnAcceptDirectory - event handler for accepting the name of a directory + - + DialogTitle - the title that appears on the Select Directory dialog - - - - ShowHidden - if True, display names of hidden directories + + +

- ShowHidden - if True, display names of hidden directories

-

In Windows etc, show directories under 'Windows' and branches; in Linux etc show directories with preceding dot e.g. '.Lazarus'

+ The default value for the property is defined in the DefaultOpenDialogOptions set type. +

+ + + + + + + ShowHidden - if True, display names of hidden directories + + +

+ ShowHidden - if True, display names of hidden directories. In Windows etc, show directories under 'Windows' and branches; in Linux etc show directories with preceding dot e.g. '.Lazarus'. +

- - - - - + + + Text displayed on the button for the control + + - - - - - + + + + Cursor shape displayed when the mouse hovers over the button for the control + + + - - - - - + + + Hint displayed when the mouse hovers over the button for the control + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - TAcceptDateEvent - generic event handling method for accepting a date from a dialog - - + TAcceptDateEvent - generic event handling method for accepting a date from a dialog + + +

+ TAcceptDateEvent is an object procedure which specifies an event handler used to examine and verify a TDateTime value. +

+

+ Senderis the object generating the event notification. +

+

+ ADate is the TDateTime value examined in the event handler. +

+

+ AcceptDate is a variable Boolean argument which indicates if the TDateTime value meets the criteria implemented in the event handler. Set AcceptDate to False to indicate that the TDateTime value should be rejected. +

+

+ TAcceptDateEvent is the type used to implement the OnAcceptDate property in TDateEdit. +

+ + + + - - + Object generating the event notification - - + TDateTime value examined in the method - - - + + Indicates if the Date/Time can be accepted when True - + + + + Specifies an event handler used to examine or alter a String with a date value + + +

+ TCustomDateEvent is an object procedure which specifies an event handler used to examine or alter a String with a date value in an arbitrary format. +

+

+ Sender is the object generating the event notification. +

+

+ ADate is a variable String argument which can be examined or altered in the event handler. +

+

+ TCustomDateEvent is the type used to implement the OnCustomDate event handler in TDateEdit. +

+ + + + + + + + Object generating the event notification + + + + Variable String argument which can be examined or altered in the event handler + + + + + + Controls the display order for Month, Day, and Year portions of a date value + + +

+ TDateOrder is an enumerated type with values that indicate the display order for the Month, Day, and Year portions of a date value. +

+

+ TDateOrder is the type used to implement the DateOrder property in TDateEdit, and passed as an argument to the ParseDate routine. +

+ + + + + + + + No order is specified for the Year, Month, and Day values + + + Displayed in Month, Day, Year order + + + Displayed in Day, Month, Year order + + + Displayed in Year, Month, Day order + + - TDateEdit - an EditBox to hold a date, with an attached SpeedButton that will summon a date selection (calendar) dialog - - - + TDateEdit - an EditBox to hold a date, with an attached SpeedButton that will summon a date selection (calendar) dialog + + +

+ TDateEdit is a TCustomEditButton descendant which implements a grouped edit control for entering a date value. The control uses an Edit and a Button, as defined in the ancestor class, and implements a Calendar dialog to select a date value when the Button is clicked. The value is stored in the Date property as a TDateTime value. +

+

+ TDateEdit provides additional properties which are used to configure the Edit and Button controls and the dialog executed when Button is clicked. +

+ + + + - - - + + + + + + + + + + + + + + Sets the value for the DateFormat property - + + + - - - - - + + New value for the property - - - - - + + + + Converts the specified text to a TDateTime value with an optional default value + + + - + + TDateTime value for the specified text + + + Text examined in the method + + + Default TDateTime value used when the text cannot be converted + + - + Gets the value for the Date property - - + + + - - + Value for the property - + - + Sets the value for the Date property - - + + + - - + New value for the property - - + + + + Implements the OnReturnDate event handler used in the dialog in the control + + +

+ CalendarPopupReturnDate is a procedure which implements the TReturnDateEvent event handler used to validate and store the date returned from the dialog for the control. It is passed as an argument when calling the ShowCalendarPopup routine in the ButtonClick method. +

+

+ CalendarPopupReturnDate signals the OnAcceptDate event handler (when assigned) to accept or reject the value in ADate. The value in ADate is stored in the Date property when accepted in OnAcceptDate. +

+

+ CalendarPopupReturnDate handles any exception which occurs in the method, or in the OnAcceptDate event handler, and displays a Message Dialog with the message from the exception. +

+ + + + + + + + + + + Object generating the event notification + + + Date/Time value examined and stored in the method + + + + + Implements the event handler used to toggle the visibility of the dialog form for the control + + +

+ CalendarPopupShowHide is a procedure which implements the event handler used to toggle the visibility of the dialog form for the control. CalendarPopupShowHide is passed as an argument when calling the ShowCalendarPopup routine in the ButtonClick method. +

+

+ CalendarPopupShowHide checks the visibility of the form in Sender (a TCalendarPopupForm in this usage), and assigns the value to the DroppedDown property in the class instance. +

+ + + + + + + + + + + + Object generating the event notification; the TCalendarPopupForm instance in this case + + + + + Sets the value for the DateOrder property + + + + + + + New value for the property + + + + Converts the specified TDateTime value to a string + +

+ DateToText is a String function used to convert the TDateTime value in the Value parameter to its textual representation. The return value is an empty String ('') when Value is equal to the NullDate constant. +

+

+ DateToText uses DefaultFormatSettings to generate the return value when DateOrder is doNone using the short date format in the DateFormat property. When DateOrder contains another value from the enumeration, the edit mask for the fixed date format is used to generate the return value. +

+

+ DateToText is used in the implementation of the SetDate, RealSetText, and EditEditingDone methods. +

+ + + + + + + + + + + + + Text for the converted date/time value + + + TDateTime vale converted in the method + + + - - + Registers the class reference used to create new instances of the class - - - + + + Gets the default glyph name displayed on the Button for the control + +

+ GetDefaultGlyphName is overridden in TDateEdit to return the resource name specified in the ResBtnCalendar constant. +

+ + + + + - - - - - - + + Resource name for the default glyph - - - + + + + Implements the handler executed when the Button for the control is clicked + + + - - - - - - + + + Performs actions needed when the Edit in the control is double clicked + +

+ EditDblClick is an overridden procedure in TDateEdit. It calls the inherited method, and checks to ensure that the control is not marked as ReadOnly before calling the ButtonClick method. +

+ + + + + - - - + + + Implement the OnEditingDone event handler for the Edit in the control + + - - - - - - + + + Sets the value in the DirectInput property + +

+ SetDirectory is overridden in TDateEdit to synchronize the values in the Text and Date properties when DirectInput is changed. +

+ + + + + + + + + - + + New value for the property + + + + Sets the value for the control + +

+ RealSetText is overridden in TDateEdit to ensure that DefaultToday is used to set the Date when Text is an empty string. Calls the inherited RealSetText method. +

+ + + + + + + + + New value for the control + + + + + Applies a mask to the Edit control suitable for the DateOrder in the control + + + + + + + + Performs actions needed when the component has finished loading in the LCL streaming mechanism + + + + + Create - constructor for TDateEdit: calls inherited Create and sets defaults

- Create - constructor for TDateEdit: calls inherited Create and sets defaults

-

Initializes dialog title, captions, display settings and default date

+ Create - constructor for TDateEdit: calls inherited Create and sets defaults. +

+

+ Initializes the dialog title, caption, display settings, and the default date. +

- TCustomEditButton.Create + - - + Owner of the class instance - - - - - - + + + + GetDateFormat - returns the format for the date + + + - - - + + + + + + + + Contains the TDateTime value for the control - + + + + + Indicates the dialog for control is visible when True + + + + - CalendarDisplaySettings - governs how the calendar dialog is to be displayed + CalendarDisplaySettings - governs how the calendar dialog is displayed + - + - OnAcceptDate - event handler for accepting the date selected in the calendar dialog + OnAcceptDate - event handler for accepting the date selected in the calendar dialog + - - + + - DialogTitle - the caption to appear on the dialog - - + OnCustomDate - event handler for inserting a custom date + + + - - - - - + + + Indicates if the value for the control can be changed + + - - - - - + + + + DefaultToday - if True, the current date is offered as the default date (value is False by default) + + + Default value for the property is False. + + - - - - - + + + + Controls the display order for Year, Month, and Day parts of the date value + + + - - - - - + + + Specifies the editing format used for the date value in the control + +

+ DateFormat is a String property which contains the format used when converting the Date value to and from text. DateFormat is relevant when DateOrder contains the value doNone; when another TDateOrder value is used, the fixed format needed for the date order is automatically used. +

+

+ DateFormat is used in the implementation of the TextToDate and DateToText methods. +

+ + + + + + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies an event handler used to validate and accept/reject a time value + + +

+ TAcceptTimeEvent specifies an event handler used to validate and accept/reject a time value in TTimeEdit. TAcceptTimeEvent is the type used to implement the OnAcceptTime property in TTimeEdit. +

+ + + + - - - - - + + Object generating the event notification - - - - - + + Time value examined in the method - - - - - + + Indicates the time value is accepted when True - - - - - + + + + Specifies an event handler used to generate an arbitrary time value + + +

+ TCustomTimeEvent specifies an event handler used to generate an arbitrary TDateTime value. TCustomTimeEvent is the type used to implement the OnCustomTime property in TTimeEdit. +

+ + + + - - - - - + + Object generating the event notification - - - - - + + TDateTime value generated in the event handler - - - - - + + + Implements a control used to edit time values + +

+ TTimeEdit is a TCustomEditButton descendant which implements a control used to edit a time value. TTimeEdit provides the Edit and Button properties defined in the ancestor class, and a dialog that is executed to select a time value when the Button is clicked. +

+

+ The time value in the control is represented using the TDateTime type; only the time portion of the value is significant. +

+ + + + - - - + + + + + + + + + + + Gets the value for the Time property - + + + - - - + + Value for the property + + + + Sets the value for the Time property - + + + - - - + + New value for the property + + + + Sets the value in the Time property to the empty time value + +

+ SetEmptyTime is a procedure used to set the value in the Time property to the empty time value. The value in NullDate is assigned as the value for the Time property. In addition, the EmptyStr constant is assigned as the value for the Text property. An internal flag is set to indicate that the time value is empty. +

+

+ SetEmptyTime is used in the implementation of the ParseInput method, and in the constructor for the class instance. +

+ + + + + + + + + + + Gets the value for the SimpleLayout property + + + + + + + Value for the property + + + + Sets the value for the SimpleLayout property - + + + - - - - - + + New value for the property - - - - - + + + + Implements the event handler used to display the popup dialog for the control, and to capture the returned time value + + + - - - - - + + Object generating the event notification - - - - - + + Time value returned from the popup dialog - - - - - + + + + Implements an event handler used to toggle the visibility of the popup dialog for the control + + + - - - - - + + Object generating the event notification - - - - - + + + + Configures and displays the popup dialog for the control + + + Used in the implementation of the ButtonClick and EditDblClick methods. + + - - - - - + + + + Parses text in the Edit control and stores the value in the Time property + + + Used in the implementation of the OpenTimePopup and EditEditingDone methods. + + - - - - - + + + + + - - - - - + + - - - - - + + - - - - - + + - - - - - + + + + Gets the resource name for the default glyph displayed on the Button for the control + + + - - - - - + + Resource name for the glyph - - - - - + + + + Performs actions needed when the Button for the control is clicked + + + - - - - - + + + + Implements the OnDblClick event handler for the Edit in the control + + + - - - - - + + + + Implements the OnEditingDone event handler for the Edit in the control + + + - - - - - + + + Constructor for the class instance + + - - - - - + + Owner of the class instance - - - - - + + + Represents the time value in the control + + - - - - - + + + + + Indicates if the popup dialog for the control is visible + + DroppedDown is read-only Boolean property which indicates if the popup dialog for the control is visible. + + - - - - - + + + Indicates the current time is used for an empty time value + +

+ DefaultNow is a Boolean property which indicates if the time value defaults to the current system time when a empty time value assigned in the control. The default value for the property is False. +

+

+ DefaultNow is used in the implementation of the GetTime method which gets the value for the Time property. +

+ + + + + - - - - - + + + + Event handler signalled to validate and accept/reject the time value for the control + + + - - - - - + + + + Event handler signalled to get an arbitrary time value for the control + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ SimpleLayout is a Boolean property which indicates if the popup dialog for the control uses the 2 (rows) by 6 (columns) layout with 30 minute intervals between time values. The default value for the property is True. When set to False, a more detailed layout with 12 rows by 5 columns using 5 minute time intervals is used. +

+ + - - - - - - - + + + + + + + + - TAcceptValueEvent - generic event handling method for accepting a value from a (calculator) dialog + TAcceptValueEvent - generic event handling method for accepting a value from a (calculator) dialog + - - - - + - TCalcEdit - an EditBox to hold a numeric value, with an attached SpeedButton that will summon a calculator dialog - - - - - - - + TCalcEdit - an EditBox to hold a numeric value, with an attached SpeedButton that displays a calculator dialog + - - - - - - - - - - - - - + + + + + + + + - + Gets the value for the AsFloat property - - + + + - - + Value for the property - + - + Gets the value for the AsInteger property - - + + + - - + Value for the property - + - + Sets the value for the AsFloat property - - + + + - - + New value for the property - + - + Sets the value for the AsInteger property - - + + + - - + New value for the property - + - - - + - FCalcDialog - local variable holding the Calculator Dialog for use with this class + FCalcDialog - local variable holding the Calculator Dialog for use with this class + - - - - - + + + + + + Performs actions needed when the button for the control is clicked + +

+ ButtonClick is an overridden method used to perform actions needed when the Button for the control is clicked. For TCalcEdit, the RunDialog method is called to execute the dialog for the control and to capture it results. When FocusOnButtonClick is set, the FocusAndMaybeSelectAll method is called to give focus to the Edit control in the class. +

+ + + + + + Constructor for the class instance + +

+ Create is the overridden constructor for the class instance. Create calls the inherited constructor, and sets the default values for the following properties: +

+
+
DialogTitle
+
Uses the value in the rsCalculator constant
+
DialogPosition
+
Set to poScreenCenter
+
+ - - - + + Owner of the class instance - - - - - - - - - - - - + - RunDialog - perform the function of the dialog - - + RunDialog - perform the function of the dialog + + +

+ RunDialog is a procedure used display the form which captures the value for the control. For TCalcEdit, a TCalculatorForm instance is used instead of a TCommonDialog descendant as used in other grouped edit controls. +

+

+ Property values in the class are assigned to the form, such as: DialogTitle, DialogTop, DialogLeft, DialogPosition, and AsFloat. The form is displayed modally, and its value is passed to the OnAcceptValue event handler (when assigned). The accepted value is stored in the AsFloat property. +

+ - - - - - - - - - - - - - - - - - - - + + + - CalculatorLayout - normal or simple + CalculatorLayout - normal or simple + - + - AsFloat - holds the result of the calculation as a floating-point (double precision) number + AsFloat - holds the result of the calculation as a floating-point (double precision) number + - + - AsInteger - holds the result of the calculation as an Integer + AsInteger - holds the result of the calculation as an Integer + - + - OnAcceptValue - event handler for accepting the result of the calculation + OnAcceptValue - event handler for accepting the result of the calculation + - + - DialogTitle - the caption to be used for the dialog + DialogTitle - the caption to be used for the dialog + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - GetDefaultGlyph - find the default glyph for the SpeedButton - - - - GetDefaultGlyphName - find the name for the default glyph for the SpeedButton - - - - ButtonHint - the hint that pops up when the mouse hovers over the button - - - - - - - - DateFormatChanged - method for changing date format - - - - GetDateFormat - returns the format for the date - - - - - OKCaption - the caption to be used for the OK button in the calendar dialog - - - - CancelCaption - the caption to be used for the Cancel button in the Calendar dialog - - - - DefaultToday - if True, the current date is offered as the default date (value is False by default) - - - - - - - - - - - - - - - - - - - - - - - - - OnCustomDate - event handler for inserting a custom date - - - - - - - - - - - - - - - - - - TCustomDateEvent - generic event handler method for date-related events - - - Hide directory name from edit + + + + + + + + + + -

If HideDirectories is set to true, the file name editor displays -only a file name, without path.

-This may be useful if application allows user to select files from a fixed directory with a long path. + The default value for the property is poScreenCenter. + - TCustomEditBtn sets default to True + + + Vertical coordinate for the dialog displayed for the control + + - Base class for filter controls which associate to a container control like Listbox or Treeview. - When the container control is connected to the filter control, the filtering happens automatically as a user enters text. When the filter is empty and does not have focus, it shows a grey "(filter)" text. - + + + Horizontal coordinate for the dialog displayed for the control + + - An event handler to give extra conditions for filtering, in addition to the default behavior. Returns True if the passes the filter.This feature has for example enabled filtering the Options windows in Lazarus IDE, based on captions of all controls on the options pages. - - Has effect when items in the filtered container can be checked. Typically a CheckListbox. - Called after all items are filtered. - The actual filter text.Typically a user types it in the edit control but it can also be set in code. -Filtering is done during idle time after the value of Filter text has changed. - - Items can be sorted while they are filtered. - For retaining selection in the filtered control. The actual type depends on the control. - Should be called when data was changed and it must be filtered again.Connects to OnIdle handler which filters the data later. - Removes the filter text and shows all items in the container. - Applies a new filter immediately without waiting for idle. Returns the previous filter. - Method that actually filters data in the container component. Must be implementation inherited classes. - Filters the data and updates the container.Does its job at once if Immediately=True. Otherwise connects to OnIdle handler which does it later. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Resource name for the default glyph used on the Button in TCustomControlFilterEdit + + + + + Resource name for the default glyph used on the Button in TFileNameEdit + + + + + + Resource name for the default glyph used on the Button in TDirectoryEdit + + + + + + Resource name for the default glyph used on the Button in TDateEdit + + + + + + Resource name for the default glyph used on the Button in TCalcEdit + + + + + + Resource name for the default glyph used on the Button in TTimeEdit + + + + + + Registers components in the unit for use in the Lazarus IDE + + + diff --git a/docs/xml/lcl/extctrls.xml b/docs/xml/lcl/extctrls.xml index 1ce49c631c..68bc182ddf 100644 --- a/docs/xml/lcl/extctrls.xml +++ b/docs/xml/lcl/extctrls.xml @@ -2,142 +2,91 @@ + ==================================================================== + ExtCtrls + ==================================================================== + --> - Some extra controls commonly used in Lazarus forms + Contains extra controls commonly used in Lazarus forms - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - TPageFlag - enumerated type containing possible values for page flags for notebook pages + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies an event handler triggered before a page in displayed

- TPageFlag - enumerated type containing possible values for page flags for notebook pages

- 
pfAdded,  // handle of page added to notebook handle
-    pfAdding, // currently handle of page adding to notebook handle
-    pfRemoving, // currently removing page handle from notebook handle
-    pfInserting // currently inserting page into notebook
-
+ TBeforeShowPageEvent is an object procedure which specifies an event handler triggered before a page in displayed. TBeforeShowPageEvent can be used to perform actions needed to configure the page or its parent control before the new page is displayed. +

+

+ TBeforeShowPageEvent is the type used to implement the OnBeforeShow event handler in TPage. +

- + + + - - - Internal flag set after page handle was connected to the notebook handle + + Object for the event notification - - - + + The page instance for the notification - - - - TPageFlags - set of TPageFlag - - - + + The ordinal position for the page in the parent control - + + + Specifies an event handler signalled to draw the background for an image + +

+ TImagePaintBackgroundEvent is an object procedure which specifies an event handler signalled to draw the backgound for a TImage class instance. TImagePaintBackgroundEvent is the type used to implement the OnPaintBackground event handler in TCustomImage. +

+ + + + + + + Object for the event notification + + + Canvas for the image is drawn + + + Rectangle with the dimensions for the image + + TPage: One of the pages in a tabbed Notebook

- TPage: One of the pages in a tabbed Notebook

-

Inherits most of its properties from TCustomPage + TPage is a TCustomControl descendant that implements a page displayed in a tabbed Notebook.

@@ -145,1094 +94,1575 @@ Multi-PageControls - - + + + + + Gets the ordinal position for the page in the TNotebook + +

+ GetPageIndex is an Integer function used to get the ordinal position for the page in the TNotebook. +

+

+ GetPageIndex checks the value in Parent to ensure that a TNotebook instance has been assigned as the parent control. The IndexOf method in TNotebook is used to get the position for the current page. When Parent is unassigned, or not derived from TNotebook, the value -1 is used as the return value. +

+ + + + + + + + + Ordinal position for the page, or -1 when the Parent control is unassigned or not a TNotebook instance + + + + - - - - - + + + Sets the value for the Parent property + + + + - - - - - + + New value for the property - - - - - + + + Constructor for the class instance + +

+ Create is the overridden constructor for the class instance. Create calls the inherited constructor, and sets the default values for properties in the class instance. The following properties are updated in the method: +

+
+
ControlStyle
+
+ Includes the values csAcceptsControls, csDesignFixedBounds, csNoDesignVisible, and csNoFocus in the set. +
+
Align
+
+ Set to alClient. The height and width for the page depend on the dimensions for the parent control. +
+
Caption
+
Set to an empty string ('').
+
Visible
+
Set to False.
+
+ + - - - - - + + Owner of the class instance - - - - - + + + Destructor for the class instance + +

+ Destroy is the overridden destructor for the class instance. Destroy ensures that the page is also removed from the page list maintained in the Parent control (TNotebook). The action is not performed when the Parent control has csDestroying in its ComponentState, or when Parent has not been assigned. +

+

+ Destroy calls the inherited destructor prior to exiting from the method. +

+ + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + Ordinal position for the page in its Notebook + +

+ PageIndex is a read-only Integer property which contains the ordinal position for the page in its TNotebook container. The return value is -1 when the Parent control is unassigned, or not derived from TNotebook. +

+ + + + + + + + + Event handler signalled before a page is displayed + +

+ OnBeforeShow is a TBeforeShowPageEvent property that contains the event handler signalled before a page is displayed. Applications must assign an object procedure to the event handler to respond to the event notification. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents page names and class instances for a notebook + +

+ TUNBPages is a TStrings descendant used to represent the names, TPage instances, and the owner class in TNotebook. TUNBPages extends the ancestor class by providing overridden methods needed to add, insert, delete and locate pages with a specified name or TPage class instance. +

+

+ TUNBPages is used in the implementation of the TNotebook class. +

+ + + + + + + + + + + Gets the owner for the TNotebook instance for the pages + + + + + Owner of the TNotebook instance for the pages + + + + + Gets the name for the page stored at the specified position in the list of pages + + +

+ Get is an overridden String function used to get the name for the page stored at the specified position in the list of pages. +

+

+ Index contains the ordinal position in the page list for the requested page. Index must be a valid position in the page list or an Exception is raised. The return value contains the name assigned to the TPage instance stored at the specified position. +

+ + + Calls RaiseGDBException to raise an exception when Index is not valid for the page list in the class instance. Raised with the exception message: 'TUNBPages.Get Index out of bounds'. + + + + + Name for the page at the specified position + + + Ordinal position for the page requested in the method + + + + Gets the number of pages defined in the page list - - - - - + + Value for the Count property - - - - - + + + + Gets the TPage class instance stored at the specified ordinal position in the page list + + + - - - - - + + TPage class instance at the specified position - - - - - + + Ordinal position in the list of pages for the requested page object - + + + Ensures that the index value is valid before accessing the TPage object + +

+ Put is overridden in TUNBPages to set the name for the page object at the specified position. Put ensures that the value in Index is valid. Index must contain a value in the range 0 to the number of defined pages - 1. An exception is raised when Index contains an invalid value. +

+

+ Put sets the name in the TPage object at the specified position to the value in S. +

+ + + Calls RaiseGDBException with the exception message 'TUNBPages.Put Index out of bounds' when Index contains an invalid value. + + + + + Ordinal position for the page object updated in the method + + + Name stored in the requested page object + + + + Constructor for the class instance + + + + + Notebook that is the owner of the class instance + + + + Destructor for the class instance + + + + + + Creates a new page instance with the specified name + +

+ Add is an overridden Integer function used to create a new TPage instance with the name specified in S. The page object is created using the return value from GetNotebookOwner as the owner of the class instance. Add calls the AddObject method to store the page object in the list of pages for the notebook. +

+

+ The return value contains the ordinal position in the page list where the page object was stored. +

+ + + + + Ordinal position where the page object was stored + + + Name for the page added in the method + + + + Adds the specified page object to the list of pages + + + + + Ordinal position in the page list where the page object was stored + + + Identifier used as the name and/or caption for the page object + + + Page object stored in the method + + + + Deletes all page objects stored in the list of pages + + + + + + Deletes the page at the specified position in the list of pages + + + + + Ordinal position in the list of pages for page removed in the method + + + + + Gets the ordinal position for the specified page object in the list of pages + + + + + + + + + + + + + + Inserts a page with the specified name at the given position in the list of pages + + + + + + + + + + + - TNotebook is a container for a series of pages placed together + TNotebook is a container for a series of pages placed together + -

TNotebook is a control which can hold a series of pages placed together. Only one page is shown at a time and this control is completely custom drawn, which means that it is available and looks the same in any widgetset which supports TCustomControl. The pages are containers which can hold controls. This control never has tabs. If you are looking for a control with tabs and pages, please see TPageControl instead.

-

To use a Notebook, select its icon from the 'Additional' tab of the Component Palette and place it on the Form. Adjust its size, position, alignment and anchoring as required, by moving the object on the Form or by using the Object Inspector.

-

Pages are added to the NoteBook by selecting the control and right-clicking with the mouse to get a pop-up menu whose first item is 'Add Page'. Pages already in the NoteBook can be edited by selecting the appropriate ActivePage in the Object Inspector and modifying its properties or adding additional components to that Page.

+

+ TNotebook is a control which can hold a series of pages placed together. Only one page is shown at a time and this control is completely custom drawn, which means that it is available and looks the same in any widgetset which supports TCustomControl. The pages are containers which can hold controls. This control never has tabs. If you are looking for a control with tabs and pages, please see TPageControl instead. +

+

+ To use a Notebook, select its icon from the 'Additional' tab of the Component Palette and place it on the Form. Adjust its size, position, alignment and anchoring as required, by moving the object on the Form or by using the Object Inspector. +

+

+ Pages are added to the NoteBook by selecting the control and right-clicking with the mouse to get a pop-up menu whose first item is 'Add Page'. Pages already in the NoteBook can be edited by selecting the appropriate ActivePage in the Object Inspector and modifying its properties or adding additional components to that Page. +

- + - - - - - - + + + + + + Gets the value for the ActivePage property + + + + - - - + + Value for the property - - - - - - + + + Gets the value for the ActivePageComponent property + + + + - - - + + Value for the property - - - + + + Gets the value for the indexed Page property + + + + - - - - - - + + Page object at the specified position in the list of pages - - - + + Ordinal position for the requested page object in the list of pages - + + + Gets the value for the PageCount property + + + + + + + Value for the property + + + + Gets the value for the PageIndex property + + + + + + + Value for the property + + + + Sets the value for the PageIndex property + + + + + + + New value for the property + + + + Sets the value for the Pages property + + + + + + + New value for the property + + - - - + Constructor for the class instance + +

+ Create is the overridden constructor for the class instance. +

+

+ Create calls the inherited constructor using TheOwner as the owner of the class instance. Create allocates resources needed for members in the class instance, and sets the default values for the following properties: +

+
+
ControlStyle
+
Set to an empty set ([]).
+
PageIndex
+
Set to -1 to indicate that no page is selected or visible in the notebook.
+
Bounds
+
Set to the default size for the class (GetControlClassDefaultSize).
+
+ - - + Owner of the class instance - - - - - + + + Destructor for the class instance + +

+ Destroy is the overridden destructor for the class instance. Destroy ensures that resources allocated to the internal page list member are freed. Destroy calls the inherited destructor prior to exiting from the method. +

+ + - - - + + + Displays the specified control (page object) + +

+ ShowControl is an overridden procedure used to display the control specified in AControl. ShowControl checks the internal list of pages for the value specified in AControl. The ordinal position for the page object, when found, is assigned to the PageIndex property and causes the page object to become visible. +

+

+ ShowControl calls the inherited method prior to exit. +

+ + Please note: No actions are performed in the method when AControl is the same as the control stored in the ActivePageComponent property. + + + + + + + - - - - - + + Page object to display in the notebook control - - - - - + + + + Gets the ordinal position in the list of pages for the specified page object + + + - + + Ordinal position for the requested page object + + + Page object to locate in the list of pages + + - - - + Gets the name for the active page object in the notebook control + +

+ ActivePage is a read-only String property which provides the name for the active page object in the notebook control. The value in PageIndex is used to access the page object instance in the Page property. Its Name property is used as the property value. +

+

+ Use ActivePageComponent to get the TPage instance representing the active page object. +

+ + Should not be published because reading the property value can raise an exception. + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Set of Options for this Notebook. Include nboShowCloseButtons, nboMultiLine + + + + Gets the TPage instance representing the active page in the notebook control -

Set of Options for this Notebook. Include nboShowCloseButtons, nboMultiLine +

+ ActivePageComponent is a read-only TPage property which represents the active page in the notebook control.

-

To use the Options, select the tag in the Object Inspector, then select for inclusion any of the listed options, setting them True or False as appropriate.

-

For example, setting nboShowCloseButtons to True will cause a CloseButton (a small CheckBox with an 'x' in it) to appear on each Tab of the NoteBook, allowing the tabbed Page to be closed when the user clicks on the CloseButton.

+ + Should not be published because reading the property value can raise an exception. + - - - - - - + + + + Provides access to a page object in the notebook control by its ordinal position in the list of pages + + +

+ Page is an indexed read-only TPage property used to access a page object for the notebook control by its ordinal position in the list of pages. +

+ + + + + Ordinal position for the requested page object + + + + Indicates the number of page objects defined for the notebook control + +

+

PageCount

is a read-only Integer property that indicates the number of page objects defined for the notebook control. The value in PageCount is determined by the total number of entries stored in the list of Pages. +

+

+ Use methods and properties in Pages to maintain the page names used in the notebook control. +

+ + + + + + Ordinal position for the active page in the notebook control + +

+ PageIndex is an Integer property that indicates the ordinal position for the active page in the notebook control. +

+ + Please note: A value assigned to the property must must be in the range -1 to the number of defined Pages - 1. No actions are performed in the method when the new value for PageIndex is not in the required range. + +

+ Setting the value in the property causes the active page object to be hidden; it is hidden at run-time and design-time using the Visible and ControlStyle properties. The OnBeforeShow event handler in the newly selected page object is signalled (when assigned). The page object is displayed by updating its Visible, ControlStyle, and Align properties. +

+

+ The default value for the property is -1, and indicates that a page is not currently selected or available. +

+ + + + + + Contains the page names defined for the notebook control + +

+ Pages is a TStrings property which contains the page names defined for the notebook control. +

+

+ Setting a new value in Pages causes the new page names to be compared to the internal page objects in the notebook. New or altered pages are added or replaced in the notebook. An existing page object not present in the new page names is deleted; the Application singleton is notified that the page object is being released and allowed to process the message. +

+

+ Please note: The value in Pages is not assigned at design-time. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - TTimer: An elapsed timer useful in many applications + TTimer is an elapsed timer useful in many applications +

- TTimer: An elapsed timer useful in many applications

-

Inherits most of its properties from TCustomTimer + TTimer is a TCustomTimer descendant which implements an + elapsed timer useful in many applications. It inherits most of its properties from TCustomTimer.

- + + + + + + + - TIdleTimerAutoEvent - enumerated class containing events relevant to a timer + TIdleTimerAutoEvent is an enumerated type containing the events relevant to a timer +

- TIdleTimerAutoEvent - enumerated class containing events relevant to a timer

- 
itaOnIdle,
-    itaOnIdleEnd,
-    itaOnUserInput
-
+ TIdleTimerAutoEvent is an enumerated type containing the events relevant to a timer. TIdleTimerAutoEvent is the type used for the AutoStartEvent and AutoEndEvent properties in TCustomIdleTimer. Values in the enumeration are used when a timer executes its DoOnIdle, DoOnIdleEnd, and DoOnUserInput methods. +

+ + + + + + + + + + + Timer responds to idle start events + + + Time responds to idle end events + + + Time responds to user input events + + + + + TIdleTimerAutoEvents is set type used to store TIdleTimerAutoEvent values + + + Not used in the current LCL version. - - - - - - - - - - - - - - - - TIdleTimerAutoEvents - set of TIdleTimerAutoEvent - - - - - - - - TIdleTimer : A timer to measure idle time between processes + + + Implements the base class for TIdleTimer

- TIdleTimer: A timer to measure idle time between processes

-

Inherits most of its properties from TCustomTimer + TCustomIdleTimer is a TCustomTimer descendant which implements the base class for TIdleTimer. TCustomIdleTimer extends the ancestor class to use events which toggle the timer state. In addition, support is provided for adding and removing its event handlers in the global TApplication instance. +

+ + + + + + + + + + + + + + + + + + + + + + + Updates the event handlers used in the Application singleton + + +

+ UpdateHandlers is a procedure used to update the event handler assignments in the Application singleton based on the value in the AutoEnabled property. When AutoEnabled is True, the following methods are assigned as event handler: +

+
+
DoOnIdle
+
Assigned using Application.AddOnIdleHandler
+
DoOnIdleEnd
+
Assigned using Application.AddOnIdleEndHandler
+
DoOnUserInput
+
Assigned using Application.AddOnUserInputHandler
+
+ + Please note: No assignments are made to the Application singleton at design-time, or when the component is being loaded or destroyed. + +

+ When AutoEnabled is False, the event handler routines are disconnected from the Application singleton. +

+ + Please note: No actions are performed when handlers have not been previously assigned to Application, or Application has not been assigned (contains Nil). + + + + + + + Sets the value for the AutoEnabled property + +

+ Calls UpdateHandlers to add or remove event handlers assigned in the Application singleton. +

+ + + + + + + + New value for the property + + + + + Performs actions which execute the idle timer + + +

+ DoOnIdle is a procedure which performs the actions needed to execute the idle timer. The value in FireOnIdle is used to determine whether the timer can be executed for the idle state. When FireOnIdle is True, the DoOnTimer method is called to signal the OnTimer event handler (when assigned) and the value in the Done argument is set to False. +

+

+ The AutoEnabled property is checked to determine if the value in the Enabled property can be updated to reflect the state needed for the AutoEndEvent and AutoStartEvent properties. If AutoEndEvent contains itaOnIdle, the value in Enabled is set to False. If AutoStartEvent contains itaOnIdle, the value in Enabled is set to True. +

+ + Please note: The Enabled property is not modified when AutoEnabled contains False. + +

+ DoOnIdle is assigned as a handler for the Application singleton in the UpdateHandlers method. +

+ + + + + Object for the event notification + + + True if the idle timer has already executed its OnTimer event handler + + + + + DoOnIdleEnd performs actions when the idle state ends for the timer + + + + + + Object for the event notification + + + + + DoOnUserInput performs the code for responding to user input + + + + + + Object for the event notification + + + + + + + + Performs actions needed when the component has finished loading during LCL component streaming + + +

+ Loaded is an overridden procedure used to perform actions needed when the component has finished loading in the LCL component streaming mechanism. Loaded calls the inherited method, and calls UpdateHandlers to connect/disconnect event handlers in the Application singleton. +

+ + + + + + + + + Constructor for the class instance + +

+ Create is the overridden constructor for the class instance. Create calls the inherited constructor using TheOwner as the owner of the class instance. Create sets the default values for the following properties: +

+
+
AutoEnabled
+
Set to False
+
AutoStartEvent
+
Set to itaOnIdle
+
AutoEndEvent
+
Set to itaOnUserInput
+
+ + + + + + + Owner of the class instance + + + + Destructor for the class instance + +

+ Destroy sets the value in AutoEnabled to False, and calls the inherited destructor. +

+ + + + + + Controls whether the idle timer can be automatically enabled or disabled + +

+ AutoEnabled is a Boolean property which controls whether the idle timer can be automatically Enabled (or disabled) in event handler routines. The default value for the property is False, and indicates that event handlers in the timer are not assigned to the Application singleton in the UpdateHandlers method. +

+

+ The value in AutoEnabled is used in the DoOnIdle, DoOnIdleEnd, and DoOnUserInput methods. When AutoEnabled contains False, these routines do not perform actions which toggle the value in the Enabled property. +

+ + + + + + + AutoStartEvent - the event that triggers autostart (either idle time-out or user input) + + +

+ AutoStartEvent defines, when Enabled is automatically set to true. This is one of the following events: +

+
    +
  • on application becomes idle
    • +
  • on application stops being idle (e.g. user input or some timer fired)
    • +
  • user input, e.g. key press, mouse move
    • +
+

+ The default value for the property is itaOnIdle. +

+ + + + + + AutoEndEvent - the event that stops the timer by setting Enabled to False + + +

+ AutoEndEvent defines, when Enabled is automatically set to false. This is one of the following events: +

+
    +
  • on application becomes idle
    • +
  • on application stops being idle (e.g. user input or some timer fired)
    • +
  • user input, e.g. key press, mouse move
    • +
+

+ The default value for the property is itaOnUserInput.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - SetAutoEnabled - specifies whether AutoEnable is allowed - - - - - - - - - - - - DoOnIdle - performs the code for timer idling - - - - - - - - - - - - DoOnIdleEnd - performs the code for the end of idling - - - - - - - - - - - - DoOnUserInput - performs the code for responding to user input - - - - - - - - - - - - - - - - - - - - - - - Create: constructor for TIdleTimer: calls inherited Create then sets up operating mode (autostart and autoend) - - - - TCustomTimer.Create - - - - - - - - - - Destroy - destructor for TIdleTimer: turns off AutoEnabled then calls inherited Destroy + FireOnIdle - Boolean property determining whether the timer should fire when idle - - - - TCustomTimer.Destroy - + +

+ The default value for the property is False. +

+ - - - - - - - - - - - - - - - - - + + - TShapeType - enumerated type containing several standard geometric shapes + TIdleTimer : A timer to measure idle time between processes +

- TShapeType - enumerated type containing several standard geometric shapes:

- 
stRectangle
-  stSquare
-  stRoundRect
-  stRoundSquare
-  stEllipse
-  stCircle
-  stSquaredDiamond
-  stDiamond
-
+ TIdleTimer: A timer to measure idle time between processes. +

- - + + + + + + + + + + + + + TShapeType is an enumerated type with values representing standard geometric shapes + + +

+ TShapeType is an enumerated type with values that represent standard geometric shapes. TShapeType is the type used to implement the Shape property in TShape. +

+ + + + + - - - - - - - - + + + + + + + + + + + + + + + + + + + - TShape - An arbitrary graphic geometrical shape placed on the Form. It may be one of a series of standard shapes defined by - TShapeType + TShape draws an arbitrary geometric shape

- TShape: An arbitrary graphic geometrical shape placed on the Form. It may be one of a series of standard shapes defined by - TShapeType (stRectangle, stSquare, stRoundRect, stRoundSquare, stEllipse, stCircle, stSquaredDiamond, stDiamond).

-

It can be displayed using the Paint method and the Brush and Pen tools.

+ TShape is a TGraphicControl descendant used to draw an arbitrary geometric shape. It may be one of a series of standard shapes defined in the TShapeType enumeration. +

+

+ It can be displayed using the Paint method, or the Brush and Pen tools. +

+ + + - - - - - - - - - - - - - - - - - - - + + + + + - + Sets the value for the Brush property - - + + + - - + New value for the property - + - + Sets the value for the Pen property - - + + + - - + New value for the property - + - + Sets the value for the Shape property + + + + + + New value for the property + + + + + + Gets the default size for instances of the control + +

+ GetControlClassDefaultSize is an overridden TSize class function which provides the default size for instances of the control. The return value is updated in the method to use dimensions of 65 x 65 pixels. +

+

+ GetControlClassDefaultSize is called from the Create method, and used to set the initial value in the Bounds for the control. +

+ - - - + + TSize instance with the dimensions for instances of the control class - + - Create - constructor for TShape: calls inherited Create, sets default styles and bounds, creates pen and brush + Create - constructor for TShape: calls inherited Create, sets default styles and bounds, creates pen and brush + - TGraphicControl.Create - - + Destroy - destructor for TShape: frees pen and brush, then calls inherited Destroy - - TGraphicControl.Destroy + - + - - - - + Draws the shape for the control on its Canvas + +

+ Paint is an overridden procedure used to draw the shape for the control on its Canvas. Paint uses the Pen, Brush, and Shape defined in the control. Drawing methods in Canvas are called to render the desired Shape to a rectangle using the Width and Height defined in the component. +

+

+ Paint calls the inherited Paint method to signal an OnPaint event handler assigned in the class instance. +

+ + + + + + + - + - StyleChanged - method for handling change of style by Sender + StyleChanged - method for handling change of style by Sender + - - - - - - - - - - - - - - - - - - - - - + + + + + The Brush to be used for coloring this shape - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + The Pen to be used for drawing this shape - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + - Which Shape? (Rectangle, Square, RoundRect, RoundSquare, Ellipse, Circle, SquaredDiamond, Diamond) + Indicates the geometric shape drawn in the control -

Which Shape?

-

stRectangle,

-

stSquare,

-

stRoundRect,

-

stRoundSquare,

-

stEllipse,

-

stCircle,

-

stSquaredDiamond,

-

stDiamond

+

+ Shape is a TShapeType property that specifies the geometric shape drawn in the control. See for the values that can be assigned to the property. +

+ + + - - - - - - - - - - - - - + + + + - TResizeStyle - enumerated type for style of resizing using splitters - - rsLine - draw a line, don't update splitter position during moving -rsNone - draw nothing and don't update splitter position during moving -rsPattern - draw a dot pattern, don't update splitter position during moving -rsUpdate - draw nothing, update splitter position during moving - - - - - - - - - - - - - - - - - - - - - - TCanResizeEvent - generic event handling method for resizing using splitter - - - - - - - - - - - - - - - - - - - TCustomSplitter : the base type for - - TSplitter + Enumerated type with the drawing styles available when resizing using a splitter

- TCustomSplitter: the base type for - - TSplitter + TResizeStyle is an enumerated type with the drawing styles and actions available when resizing using a splitter. TResizeStyle is the type used to implement the ResizeStyle property in TCustomSplitter.

-

A Splitter is a vertical or horizontal bar that can be placed on a panel or form, to separate sub-panels functionally and allow re-sizing of the constituent sub-panels

-

This class defines many of the basic properties for the children classes, such as positioning, sizing and alignment

- 
{ TCustomSplitter is a control for interactively resizing another control.
-    It is a vertical or horizontal bar anchored to a side of a control.
-    You can either set the Align property to alLeft (alRight,alTop,alBottom),
-    then it will become a vertical bar, aligned to the left and when the user
-    moves it with the mouse, the control to the left with the same Align=alLeft
-    will be resized.
-    The second more flexible possibility is to set the properties Align=alNone,
-    AnchorSides and ResizeAnchor.
-    }
+ + + - - + + Draw a line, but don't update splitter position during movement + + + Draw nothing and don't update splitter position during movement + + + draw a dot pattern, but don't update splitter position during movement + + + Draw nothing, but update splitter position during movement + + + + ? - - + - - - + + + + + + + + + + TCanResizeEvent - generic event handling method for resizing using splitter + + +

+ TCanResizeEvent specifies an event handler signalled when a control is resized. Use to the arguments to event handler to access the new size for the control and to set a flag that indicates if the new value is acceptable. +

+

+ TCanResizeEvent is the type used to implement the OnCanResize event handler in TCustomSplitter and TCustomControlBar. +

+ + + + + + + + Object generating the event notification + + + New size for the resize operation + + + Indicates if the new value is accepted + + + + + TCustomSplitter is the base type for TSplitter + + +

+ TCustomSplitter is a TCustomControl descendant which implements a control used to resize, position and align a control to which it is anchored. TCustomSplitter displays a vertical or a horizontal bar anchored to the side of another control. Use the Align property to specify the orientation for the splitter control, and the adjacent control to which it is attached. When the splitter is moved with the mouse, the adjacent control with the same Align value will be resized. +

+

+ This class defines many of the basic properties for the children classes, such as positioning, sizing and alignment. +

+

+ Another usage scenario allows setting the Align property to alNone, and using AnchorSides and ResizeAnchor. +

+

+ TCustomSplitter is the base type for TSplitter. +

+ + + + + + + + + + + + + + + + + + + + - + Gets the value for the ResizeControl property - - + + + - + Value for the property + + + + Sets the value for the Beveled property + + + + + + + New value for the property + + + + Sets the value for the MinSize property + + + + + + + New value for the property + + + + Handles the CM_ENABLEDCHANGED message + +

+ Calls the inherited method, and performs the UpdateCursor method to apply the cursor shape needed for the value in ResizeAnchor. +

+ + + + + + + Message with parameters handled in the method + + + + + + Adjust anchor settings to reflect the value in the Align property + +

+ AdaptAnchors is a TAnchors function used to adjust the anchor settings for the control to reflect the value in the Align property. a contains the initial anchors used in the method, and is assigned as the default return value. +

+

+ The Align property is used to determine the correct TAnchorKind values used in the return value for the method. The following TAnchorKind values are included/excluded from the result based on the value in Align: +

+
+
alLeft
+
Includes akLeft. Excludes akRight.
+
alTop
+
Includes akTop. Excludes akBottom.
+
alRight
+
Includes akRight. Excludes akLeft.
+
alBottom
+
Includes akBottom. Excludes akTop.
+
+

+ AdaptAnchors is called when a new value is assigned to the Align or Anchors properties. +

+ + + + + TAnchors settings derived in the method + + + Initial TAnchors values used in the method + + + + + CheckNewSize ensures the new size is appropriate; returns True if successful + + +

+ CheckNewSize signals the OnCanResize event handler (when assigned) to examine and validate the value in NewSize. The values in NewSize and Result can be updated in the event handler as needed. True indicates that the value in NewSize is acceptable. +

+

+ CheckNewSize is used in the implementation of the MoveSplitter method. +

+ + + + + + + + + True when NewSize is an acceptable size for the splitter + + + New sized for the splitter + + + + + Signals the OnCanOffset event handler to determine the offset used when aligning the control, and the success or failure of the calculation + + + Used in the implementation of the MoveSplitter method. + + + ? + + - - + + + + + + FindAlignControl returns the main alignment control - - + - - - - - - - - - - - - + - FindAlignOtherControl - returns another alignment control (the splitter may have to align two controls) + FindAlignOtherControl returns another alignment control (the splitter may have to align two controls) + - - - + + + Initiates the splitter movement operation + +

+ Overridden in TCustomSplitter. Calls the inherited method, and ensures that the absolute mouse position is used when the left mouse button is depressed; The X and Y arguments are not valid during a resize operation. +

+

+ Calls GetCursorPos to capture the mouse position, and calls StartSplitterMove to initiate the splitter movement operation. +

+ + + + + Button examined in the method + + + Modifier for the mouse button + + + Horizontal coordinate for the mouse event + + + Vertical coordinate for the mouse event + + - + Starts mouse capture and tracking for the control + +

+ Calls the inherited method. No additional actions are performed in the method at design-time, or when mouse capture has already been enabled for the control. Ensures that the internal flag used to track mouse entry into the control is set, and the control is refreshed by calling Invalidate. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ Paint is an overridden procedure used to draw the splitter control. Paint calls the inherited Paint method, and adds additional logic to handle drawing the splitter control. +

+

+ The OnPaint event handler is signalled (when assigned) to draw the splitter control. +

+

+ When OnPaint is unassigned (contains Nil), an internal routine is used to paint the gripper bar using the TThemedRebar settings in ThemeServices. The control is drawn using the theme settings needed for the state in the Enabled, MouseInControl, and Beveled properties. +

+ + + + + + + + + + + Sets the value for the Align property - - + + + - - - + + Value for the property + + + + Sets the value for the Anchors property + +

+ SetAnchors is an overridden procedure used to implement the write access specifier for the Anchors property. SetAnchors calls AdaptAnchors to ensure that the new value for the property reflects the setting in the Align property. SetAnchors calls the inherited method prior to exit. +

+ + + + + + + New value for the property + + + + Sets the value for the ResizeAnchor property - - + + + - - - + + New value for the property - - - - - - - - - - - - - - - - - - - - - - - + + + Sets the value for the ResizeControl property - + + + - - - - - + + New value for the property - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + StartSplitterMove - method for starting movement of the splitter, given the mouse position MouseXY @@ -1241,1552 +1671,1730 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - FindAlignControl - returns the main alignment control - - - + Performs actions when splitter movement is stopped at the specified mouse position + + + - - - + + + + - - - - - - - - - - - - - - - - - - - - - - - - + + - CheckAlignment - ensure control is correctly aligned - - - + Updates the cursor to reflect the ResizeAnchor for the splitter + + + - - - - CheckNewSize - ensure new size is appropriate: returns True if successful - - - - - - - - - - - - - - - - - - - - + - Create - constructor for TCustomSplitter: calls inherited Create then sets initial alignment, size and style + Create - constructor for TCustomSplitter: calls inherited Create then sets initial alignment, size and style + - TCustomControl.Create - - - - - - - - - - - - Style for resizing - as a line, a pattern, full update, or none - - - - AutoSnap - automatically moves splitter to zero position when split size becomes smaller than MinSize value - Boolean property, true if snapping to grid positions - - - - Whether the edges of the splitter bar are beveled - - - - Minimum size for splitter - default 30 pixels - - - - Event handler for receiving permission to resize - - - - Event handler for occasion when splitter has moved - - - - - - - - - - - - + Owner for the class instance + - AnchorSplitter - anchor the splitter to Acontrol using the specified Kind of anchor - - - - ResizeControl - the control that is to be re-sized with the splitter - - - - GetOtherResizeControl - find out which other control is to be re-sized - - - - MoveSplitter - by an amount specified by Offset + AnchorSplitter anchors the splitter to AControl using the specified Kind of anchor + + + + + + + + + + ResizeControl is the control that is to be re-sized with the splitter + + + + + + GetOtherResizeControl finds the other adjacent control to be re-sized + + + + + + + + + + + MoveSplitter moves the splitter by an amount specified in Offset + + + + + + SetSplitterPosition - to specified NewPosition + + + + - GetSplitterPosition - returns the current position of the splitter + GetSplitterPosition returns the current position of the splitter + + + Current position for the splitter + + + + + +

+ The default value for the property is alLeft. +

+ + + + + + + AutoSnap automatically moves the splitter to the zero position when split size becomes smaller than the value in MinSize + + +

+ AutoSnap is a Boolean property. AutoSnap automatically moves the splitter to the zero position when split size becomes smaller than the value in MinSize. Contains True when snapping to grid positions. +

+ + + + + Indicates whether the edges of the splitter bar are beveled + + + + + + + +

+ The default value for the property is crHSplit. +

+ + + + + + Minimum size for splitter; default is 30 pixels + + + + + + + Event handler signalled to calculate the control offset, and to accept or reject the offset value + + + + + + + Event handler for receiving permission to resize + + + + + + Event handler for occasion when splitter has moved + + + + - ResizeAnchor - the kind of anchor to be used for resizing - akLeft for a vertical splitter, akTop for a horizontal splitter. + ResizeAnchor - the kind of anchor to be used for resizing + + + akLeft for a vertical splitter, akTop for a horizontal splitter. + - + + + Style for resizing - as a line, a pattern, full update, or none + + + + - TSplitter : A vertical or horizontal bar placed on a panel or form, to separate sub-panels functionally + TSplitter : A vertical or horizontal bar placed on a panel or form, to separate sub-panels functionally +

- TSplitter: A vertical or horizontal bar that can be placed on a panel or form, to separate sub-panels functionally and allow re-sizing of the constituent sub-panels

-

The splitter extends for the full height (if vertical) or full width (if horizontal) of the parent control (form or panel) and is anchored to the edges; its position along the length or height of the parent is determined by the programmer or user by moving the whole control with the mouse, and its size can be adjusted using the sizing bars and with the ResizeAnchor property

+ TSplitter is a vertical or horizontal bar that can be placed on a panel or form, to separate sub-panels functionally and allow re-sizing of the constituent sub-panels. +

+

+ The splitter extends for the full height (if vertical) or full width (if horizontal) of the parent control (form or panel) and is anchored to the edges; its position along the length or height of the parent is determined by the programmer or user by moving the whole control with the mouse, and its size can be adjusted using the sizing bars and with the ResizeAnchor property. +

HowToUseStdCtrls - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - TPaintBox: a painted rectangular box with defined size and color + TPaintBox: a painted rectangular box with defined size and color +

- TPaintBox: a painted rectangular box with defined size and color

+ TPaintBox is a painted rectangular box with defined size and color. +

HowToUseStdCtrls - - - - - + + + + + Draws the content for the control + +

+ Paint is an overridden procedure used to draw the control. +

+

+ At design-time, a dashed black line is drawn around the area for the control and across its opposing corners. No other actions are performed in the method at design-time. +

+

+ At run-time, the OnPaint event handler is used to render the content for the control using the Font and Color properties. The inherited Paint method is called to signal the event handler. +

+ + + + + + + + - - - - - - + + + Gets the default size used for new instances of the class + +

+ The default dimensions used in TPaintBox are 105 pixels wide x 105 pixels high. +

+ + - + + TSize instance with the default dimensions for a new TPaintBox control + + - Create - constructor for TPaintBox: calls inherited Create then sets initial bounds and style - - - - TGraphicControl.Create - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - TCustomImage - the base type for - - TImage + Constructor for the class instance - - TCustomImage - - - - - - - -: The base type for - - TImage -. This is a control of the class - - TGraphicControl -, designed to be lightweight and fast - - TGraphicControl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - PictureChanged - software emulation of the OnPictureChanged event - - - - - - - - - - - - DestRect - returns the location of the destination rectangle - - - - - - - - - - - - - - - - - - - - - - - - - - Create - constructor for TCustomImage: calls inherited Create then sets default style, bounds and local variables: creates space for the picture - - - - TGraphicControl.Create - - - - - - - - - - Destroy - destructor for TCustomImage: frees picture then calls inherited Destroy - - - - - TGraphicControl.Destroy - - - - - - - - - - - - - - - - - Should image be centered? - Boolean property - True if image is to be centered - - - - - - - - - - - Picture - - - - - - -- the actual image for display - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - True if picture is to be stretched - - - - True if you can see through the image - - - - True if image is proportional - - - - - TImage - a graphic image placed on the form; usually loaded from a picture file.

- TImage - - - - - - - -: a graphic image placed on the form; usually loaded from a picture file.

-

The actual image is found in Picture or Canvas + Create is the constructor for TPaintBox. It calls the inherited Create method, and sets the initial bounds and style for the control.

-

Inherits most of its properties from its ancestors, TCustomImage, TGraphicControl and TControl + + + + + + + Owner of the class instance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TCustomImage - the base type for TImage + + +

+ TCustomImageis the base type for TImage. This is a control descended from TGraphicControl, and is designed to be lightweight and fast. +

+

+ TCustomImage provides a Canvas that is used to render the bitmap graphic in its Picture property. Additional properties are provided to control how the image is rendered, and includes: AntialiasingMode, Stretch, Transparent, and Proportional. +

+ + + + + + + + + + + + + + + + + + + + + + + Gets the value for the Canvas property + + + + + + + Value for the property + + + + Sets the value for the AntialiasingMode property + + + + + + + New value for the property + + + + Sets the value for the Picture property + + + + + + + New value for the property + + + + Sets the value for the Center property + + + + + + + New value for the property + + + + Sets the value for the KeepOriginXWhenClipped property + + + + + + + New value for the property + + + + Sets the value for the KeepOriginYWhenClipped property + + + + + + + New value for the property + + + + Sets the value for the Proportional property + + + + + + + New value for the property + + + + Sets the value for the Stretch property + + + + + + + New value for the property + + + + Sets the value for the StretchInEnabled property + + + + + + + New value for the property + + + + Sets the value for the StretchOutEnabled property + + + + + + + New value for the property + + + + Sets the value for the Transparent property + + + + + + + New value for the property + + + + + + Performs actions needed when the Picture property has been changed + +

+ PictureChanged is a procedure used to perform actions needed when the Picture property has been changed. PictureChanged adjusts the size for an assigned bitmap in Picture, and sets its bitmap transparency to the value in the Transparent property. PictureChanged calls Invalidate to cause the image to be repainted. The OnPictureChanged event handler is signalled (when assigned) prior to exiting from the method. +

+

+ PictureChanged is assigned as the OnChange event handler for the Picture property in the constructor for the class instance. +

+ + + + + + + + + + Object instance for the change notification + + + + + + + + + + + + + + + + + + + + + + + + + + + + Draws the image to the control canvas + +

+ Paint is an overridden procedure used to draw the image to the control Canvas. At design-time, a dashed black line is drawn around the image as a frame to mark the dimensions for its content. +

+ + Please note: No additional actions are performed in the method when a TGraphic instance has not been assigned to the Graphic property in Picture. + +

+ Paint uses the Canvas from the ancestor class as the target for the drawing operation. The value in AntialiasingMode is assigned to the corresponding property in the Canvas. The rectangle returned from DestRect is used as the drawing area. +

+

+ Paint signals the OnPaintBackground event handler (when assigned) using the canvas and drawing rectangle to render the background for the image. The StretchDraw method in the Canvas is used to render the image content. +

+

+ Paint calls the inherited method to ensure that the OnPaint event handler is signalled (when assigned). +

+ + + + + + + + + + + + + + + + Constructor for the class instance + +

+ Create is the constructor for TCustomImage, and calls the inherited Create method. It then sets the default values for the style, bounds and other local variables. Creates allocates resources for the Picture property. +

+ + + + + + + Owner of the class instance + + + + Destructor for the class instance + +

+ Destroy is the destructor for TCustomImage. It free resources allocated to the Picture property, and then calls the inherited Destroy method. +

+ + + + + + + + Canvas used to draw the image + + + + + + + Gets the rectangle where the image is painted + + + DestRect is a TRect function used to get the rectangle where the image is drawn. + + + + + Rectangle where the image is drawn in the Paint method + + + + Causes the control to be repainted + +

+ Invalidate is an overridden procedure which causes the control to be repainted. Invalidate is called when the content or dimensions for the image have been changed. +

+

+ Invalidate extends the ancestor method to include logic that reduces the number of calls to the Paint method, and avoids flicker caused by the redundant calls. It uses an internal flag in the class to determine if the Paint method has already been called, but has not yet been completed. If the flag has not been set, the inherited Invalidate method is called to refresh the control using its visibility and control style settings. +

+ + Please note: No actions are performed in the method when Paint is already active. + + + + + + + + + + + + Indicates if anti-aliasing is used when rendering the image + +

+ AntialiasingMode is a TAntialiasingMode property which indicates if anti-aliasing is used when rendering the image. The value in AntialiasingMode is assigned to the TCanvas instance used in the Paint method. Changing the value in the property causes the PictureChanged method to be called to invalidate and repaint the image to its canvas. +

+

+ The default value for the property is amDontCare, and indicates that the default anti-aliasing mode for the platform, OS, or widget set is used. +

+ + + + + + + + + + + + + + Indicates if the image should be centered + +

+ Center is a Boolean property which indicates if the image is drawn aligned to the center of the client area for the control. Center is used in the DestRect method to find the horizontal and vertical coordinates for the Picture aligned to the ClientWidth and ClientHeight for the control. +

+

+ Changing the value for the property causes the PictureChanged method to be called to invalidate and repaint the image. +

+

+ The default value for the property is False. +

+ + + + + + + + + + + +

+ The default value for the property is False. +

+ + + + + + + +

+ The default value for the property is False. +

+ + + + + + + + Contains the image displayed in the control + +

+ Picture is a TPicture property which contains the dimensions, format, and data for the image displayed in the control. Resources are allocated for Picture in the constructor; this includes use of the PictureChanged method as the OnChange event handler for the property. +

+

+ Picture is used when the control needs to access its canvas for drawing operations. Drawing operations use the bitmap for the Picture when possible instead of the canvas for the form. It is also examined/updated when PictureChanged is called after values for properties like Proportional, Stretch, Centered, Transparent. and AntialiasingMode are changed. +

+ + + + + + + + + + + + + + + + + + + + + + + Indicates if the image is resized to the client area for the control + +

+ Stretch is a Boolean property which indicates if the image content is resized to the client area for the control. It is used in the DestRect method (along with Proportional) to calculate the rectangle needed to render the image content. +

+

+ Changing the value in Stretch causes the PictureChanged method to be called. +

+

+ The default value for the property is False. +

+ + + + + + + + + + + +

+ The default value for the property is True. +

+ + + ? + + + + + +

+ The default value for the property is True. +

+ + + ? + + + + Indicates if the image has a clear, non-opaque background + +

+ Transparent is a Boolean property which indicates if the image uses a clear, non-opaque background. The value for the property is used in the PictureChanged method to set the transparency for the bitmap in Picture. Changing the value for the property causes PictureChanged to be called to update the image data assigned to Picture and to repaint the control. +

+

+ The default value for the property is False. +

+

+ Use AntialiasingMode to enable or disable use of the rendering technique. Use the OnPaintBackground event handler to render a custom background for the image. +

+ + + + + + + + + + + True if image is proportional + +

+ Proportional is a Boolean property which indicates if the proportions (the ratio of width to height) for an image are maintained when it is resized. When set to True, a change to the image size maintains the ratio of width to height for the original image. Proportional is used (along with Stretch) in the DestRect method to determine the rectangle needed to render the image in the control. +

+

+ Changing the value for the property causes the PictureChanged method to be called. +

+

+ The default value for the property is False. +

+ + + + + + Event handler signalled when Picture is changed + +

+ OnPictureChanged is a TNotifyEvent property which contains the event handler signalled then the Picture property is changed. OnPictureChanged is signalled from the PictureChanged method, and allows actions to be performed after updates to image properties and the Invalidate method has been called. +

+ + + + + + + + + + + Event handler signalled to draw the background for the image + +

+ OnPaintBackground is a TImagePaintBackgroundEvent property which implements an event handler signalled to paint the background for an image. OnPaintBackground is signalled from the Paint method using the Canvas and DestRect for the image as arguments. The event occurs immediately prior to the image being drawn using its canvas handle. +

+ + + + + + + + + + + TImage is a graphic image placed on the form; usually loaded from a picture file. + + +

+ TImage : a graphic image placed on the form; usually loaded from a picture file. The actual image is found in Picture or Canvas. +

+

+ Inherits most of its properties from its ancestors, TCustomImage, TGraphicControl and TControl

HowToUseStdCtrls + + + - - - - - + + + + + + + + + + + +

+ The default value for the property is False. +

+ + - - - - - - - + + + + +

+ The default value for the property is False. +

+ + - - - - - - TControl.AutoSize - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + - TBevelStyle - enumerated type for bevel style: lowered or raised + TBevelStyle is an enumerated type with bevel style values: lowered or raised + - - - + - TBevelShape - enumerated type for shape of bevel + TBevelShape is an enumerated type for shapes used in a bevel +

- TBevelShape - enumerated type for shape of bevel

- 
bsBox
-  bsFrame
-  bsTopLine
-  bsBottomLine
-  bsLeftLine
-  bsRightLine
-
+ TBevelShape is an enumerated type rerpresting the shapes available for a bevel. +

+
    +
  • bsBox
    • +
  • bsFrame
    • +
  • bsTopLine
    • +
  • bsBottomLine
    • +
  • bsLeftLine
    • +
  • bsRightLine
    • +
- - - - - - - + A bevel placed around the edge of buttons and other components -

Its appearance is governed by and +

+ The appearance of the Bevel is governed by and .

- - - - - - - - - - - - - - - - - - - - - - - - + + + + - + Sets the value for the Style property - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Virtual Paint method called in response to paint requests received by the parent control. - - - - - - - - - TGraphicControl.Create + + + + + New value for the property + + + + Sets the value for the Shape property + + + + + + + New value for the property + + + + + + Gets the default size for new instances of the class + +

+ GetControlClassDefaultSize is an overridden TSize class function used to get the default size for new instances of the class. GetControlClassDefaultSize sets the dimensions in the return value to 50 pixels x 50 pixels. +

+ + + + + + + Default size for a new instance of the class + + + + Handles paint requests received from the parent control + +

+ Paint is an overridden procedure used to perform paint requests received by the parent control. +

+

+ Paint checks the value in Style to determine the Pen colors used to draw the bevel. The Shape property determines the drawing primitives used to render the bevel to its Canvas. +

+ + No actions are performed in the method when Shape contains the value bsSpacer. + +

+ Paint calls the inherited method to trigger the OnPaint event handler (when assigned). +

+ + + + + + + + + + + + + Constructor for the class instance + +

+ Create is the overridden constructor for TBevel. Create calls the inherited Create method, and sets the initial values used in the ControlStyle, Style, Shape, and Bounds properties. +

+
+
ControlStyle
+
Removes csSetCaption and csOpaque from existing values in ControlStyle.
+
Style
+
Set to the value bsLowered.
+
Shape
+
Set to the value bsBox.
+
Bounds
+
Calls SetInitialBounds to store the values from GetControlClassDefaultSize in Bounds.
+
+ + + - - Create - constructor for TBevel: calls inherited Create then sets initial style, shape and bounds - - + - - + Destructor for the class instance + Calls the inherited destructor. - - - - - - - - + + + -

Either reads a flag containing alignment instructions (FAlign) or writes alignment instructions (SetAlign)

-

May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right

+

+ Assign copies the contents of Source to Self, if the classes of the destination and source classes are compatible. +

+

+ The TPersistent implementation of Assign does nothing but call the AssignTo method for the source. This means that if the destination class does not know how to assign the contents of the source class, the source class instance is asked to assign itself to the destination class. This means that it is necessary to implement only one of the two methods so that two classes can be assigned to one another. +

+ +

In general, a statement of the form:

+ Destination:=Source; +

+ (where Destination and Source are classes) does not achieve the same as a statement of the form. +

+ Destination.Assign(Source); +

+ After the former statement, both Source and Destination will point to the same object. The latter statement will copy the contents of the Source class to the Destination class. +

+ - + + + + +

+ Either reads a flag containing alignment instructions (FAlign) or writes alignment instructions (SetAlign). +

+

+ May have no alignment, may have custom or client alignment, or can be aligned to top, bottom, left or right. +

+ + + + -

Determines how the control is to be anchored to its parent control

-

Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in IsAnchorsStored +

+ Determines how the control is anchored to its parent control. Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written, this is indicated in IsAnchorsStored.

- + + -

Determines the border spacing for this control

-

Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing.

-

The properties are defined in the parent class TControlBorderSpacing +

Determines the border spacing for this control.

+

+ Reads flag to find stored spacing values required for the border of the control, or writes the flag to set the spacing. +

+

+ The properties are defined in the parent class TControlBorderSpacing.

- + + -

Determine Constraints (max and min height and width) for this control; reads the size constraints or stores new ones.

+

+ Determine Constraints (max and min height and width) for this control; reads the size constraints or stores new ones. +

- - - - - - - - - - - - - - Name is the name of the component. This name should be a valid -identifier, i.e. must start with a letter, and can contain only letters, -digits and the underscore character. When attempting to set the name of a -component, the name will be checked for validity. Furthermore, when a -component is owned by another component, the name must be either empty -or must be unique among the child component names. - - - Attempting to set the name to an invalid value will result in an exception -being raised. - - - + + + - Shape - whether a box, a frame or a line along one of the edges + Shape - whether a box, a frame or a line along one of the edges + + - - - - - - + + + - Style - whether raised or lowered + Style indicates whether the bevel is displayed using a raised or a lowered style + + - + + Makes the control visible or hidden - 
The Visible property represents the ability to see a visual control. 
-          If Visible is True the control is shown, otherwise it is hidden.
-          Calling Show sets, among others, Visible to True.
-          Setting Visible to False is equivalent to calling Hide method.
- The Visible property does not depend on control's parent visibility. Use IsVisible method to consider this and get real visibility. +

+ The Visible property represents the ability to see a visual control. If Visible is True the control is shown, otherwise it is hidden. Calling Show sets Visible to True. Setting Visible to False is equivalent to calling Hide method. +

+ + The Visible property does not depend on control's parent visibility. Use the IsVisible method to consider this and get the real visibility for the control. + - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + - TColumnLayout - enumerated type for layout where data are arranged in columns - - - - - - - - - - - - - TCustomRadioGroup: the base type for - TRadioGroup + TColumnLayout is an enumerated type which determines the layout direction used to arranged data in columns -

A group of related but mutually exclusive radio buttons, - selectable by the user.

-

This class defines Items, where the captions of the individual radio boxes are stored, - Rows and Columns for arranging the radio boxes, - and ColumnLayout to determine whether the data are arranged - down the columns first, or across the rows first.

+

+ TColumnLayout is an enumerated type which determines the layout direction used to arranged data in columns. TColumnLayout is the type used to implement the ColumnLayout property in TCustomRadioGroup and TCustomCheckGroup. +

+ + + + - - - - - + + Items are arranged horizontally, and advances vertically - - - - - + + Items are arranged vertically, and advances horizontally - - - - - + + + + TCustomRadioGroup: is the base type for TRadioGroup + + +

+ A group of related but mutually exclusive radio buttons, selectable by the user. +

+

+ This class defines Items, where the captions of the individual radio boxes are stored, Rows and Columns for arranging the radio boxes. The ColumnLayout property is used to determine whether the data are arranged down the columns first, or across the rows first. +

+ + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - - - - + Performs actions needed when a radio button in the group is clicked + +

+ Clicked is a procedure used to perform actions needed when a radio button in the group is clicked. Clicked calls the CheckItemIndexChanged method to update the state for the radio buttons in the group, and to signal the OnClicked and OnSelection event handlers (when assigned). +

+

+ Clicked is assigned to the OnClick event handler for each TRadioButton in the group. Use the Items property to specify the radio buttons required for the grouped control. +

+ + + + + + + + + + - - + Object instance for the event notification - - + + - + + + + + + + + + + + + + + + + + Performs actions needed to handle key down messages for radio buttons in the group + + +

+ ItemKeyDown handles the following unshifted virtual key codes: +

+
+
VK_LEFT
+
Moves the selection to the prior radio button, with wrapping.
+
VK_RIGHT
+
Moves the selection to the next radio button, with wrapping.
+
VK_UP
+
Moves the selection to the radio button in the prior row, with wrapping.
+
VK_DOWN
+
Moves the selection to the radio button in the next row, with wrapping.
+
+

+ If Shift contains a key modifier, or Key has not been handled, the KeyDown method from the ancestor class is called to handle the values in Key and Shift. +

+ + + + + + + + + + + + + + + + + Handles key up messages for radio buttons in the group + +

+ Calls the KeyUp method in the ancestor class to handle the values in Key and Shift. +

+ + + + + + + + + + + + + + + + Handles key press characters for radio buttons in the group + +

+ Calls the KeyPress method from the ancestor class to handle the character value in Key. +

+ + + + + + + + + + + + Handles UTF-8 key press characters for radio buttons in the group + +

+ Calls the OnUTF8KeyPress method in the ancestor class to handle the UTF-8-encoded character in UTF8Key. +

+ + + + + + + + + + + + + + + ItemResize is an empty implementation in the current LCL version. + + + + + + + + + + Sets the value for the AutoFill property + + + + + + + New value for the property + + - + Sets the value for the ColumnLayout property + + + + + + + New value for the property + + + + + Updates the number of radio buttons displayed on each line based on the layout policy for child controls + + + + ? + + + + Adds or removes radio buttons to match the names defined in Items - - - - + + + + Ensures that checked radio buttons have their TabStop property set to True + + + - + + + + + + Calls the UpdateItems method to add or remove radio buttons for the grouped control + + + + + + + + Updates the radio buttons and the number of radio buttons per line for the control + + + + + + + + + + + - UpdateRadioButtonStates including implementing any pending changes - - + UpdateRadioButtonStates including implementing any pending changes + + +

+ Updates the value in ItemIndex, and the tabs stop settings for all checked radio buttons in the control. ItemIndex is set to -1 when none of the radio buttons in the control have their Checked property set to True. +

+ - + - - + +

+ ReadState is used when the component is read using the LCL component streaming mechanism. ReadState ensures that ItemIndex contains a value that is valid for the defined Items in the grouped control. +

+ - - - - + + + Sets the value for the Items property - - + + + - - - + + New value for the property - + - - SetColumns - specifies the number of columns for displaying the items + Sets the value for the Columns property - - + + + - - + New value for the property - + - - SetItemIndex - specifies an index for an item + Sets the value for the ItemIndex property - - + + + - - + New value for the property - + - - GetItemIndex - returns an index for an item + Gets the value for the ItemIndex property - - + + + - - + Value for the property - - - + + + + CheckItemIndexChanged - find out if the index for an item has changes + - - + + + Constructor for the class instance + +

+ Create is the constructor for TCustomRadioGroup.It calls the inherited Create method, then sets the list of radio buttons, and initializes layout and sizing properties. +

+ + + + + + + Owner of the class instance + + + + Destructor for the class instance + +

+ Destroy is the destructor for TCustomRadioGroup. It frees the Items and radio buttons allocated in the class, and calls the inherited Destroy method. +

+ + + + + + + + Indicates if modification of the RadioGroup is permitted + +

+ CanModify is a Boolean function which indicates if modification of the RadioGroup is permitted. CanModify always returns True in TCustomRadioGroup. +

+ + + + + True when the control can be modified + + + + + FlipChildren is an empty implementation in TCustomRadioGroup. + + + + + + + + + Indicates the number of rows in which Items (radio buttons) are held + + +

+ Rows is an Integer function which returns the number of rows needed to represents the radio buttons defined in the grouped control. The return value is the result of dividing the total number of Items by the number of Columns. The return value is zero (0) when no Items have been defined in the control. +

+ + + + + + + + Number of rows + + + + + Indicates if radio buttons are resized to fill the available space in the control + + +

+ AutoFill is a Boolean property which indicates whether child controls (radio buttons) are resized to fill the available space in the control. When AutoFill is set to True, child controls are resized by setting the EnlargeHorizontal and EnlargeVertical properties in ChildSizing to the value crsHomogenousChildResize. When AutoFill is set to False, the properties in ChildSizing are set to the value crsAnchorAligning. +

+ + Please note: DisableAlign is called on entry to the method, and EnableAlign is called prior to exiting from the method. + +

+ AutoFill is set to True in the Create constructor. +

+ + + + - The Index value in the list of Items (a stringlist with the names of the selections for radio buttons) + + The Index value in the list of Items (a stringlist with the names of the selections for radio buttons) + - + - Items - a string list containing the captions for the radio boxes + Contains the captions for the radio button displayed in the control + + +

+ Items is a TStrings property which contains the captions for the radio buttons displayed in the grouped control. Changing the value in Items causes the UpdateItems and UpdateControlsPerLine methods to be called to add or remove radio buttons (when needed) and to adjust Rows for the number of Columns in the control. +

+ + - + - - Columns - the number of columns in which the - - Items (radio buttons) are to be arranges + Number of columns used to display radio buttons in the control + +

+ Columns is an Integer property that indicates the number of columns used to display the radio buttons in the control. Columns must contain a positive non-zero value; use of an invalid value causes an Exception to be raised. +

+

+ Changing the value in Columns causes the UpdateControlsPerLine to be called. +

+

+ The default value for the property is 1. +

+ + + Raises an exception when the property value is less than 1. Raised with the message 'TCustomRadioGroup: Columns must be >= 1'. + + - + - ColumnLayout - - - HorizontalThenVertical or vice versa + ColumnLayout - HorizontalThenVertical or vice versa + + + - + - Event called when the selected item changes -

TCustomRadioGroup.OnClick is different from the usual event TControl.OnClick. - Instead of occurring on a mouse click on the control, this event is occurs when - the currently selected item changes. It will not occur if a click does not make the - selection change, will not occur upon clicking a already selected item and will occur - if one changes the selection via the keyboard. It also occurs when the item - is changed programmatically. This is done for Delphi compatibility.

-

Note that Lazarus also offers another event for the same task with a better name: - see TCustomRadioGroup.OnSelectionChanged for more details.

+ Event called when the selected item is changed + +

+ OnClick is different from the usual event TControl.OnClick. Instead of occurring on a mouse click on the control, this event is occurs when the currently selected item changes. It will not occur if a click does not make the selection change, will not occur upon clicking a already selected item and will occur if one changes the selection via the keyboard. It also occurs when the item is changed programmatically. This is done for Delphi compatibility. +

+

+ Note that Lazarus also offers another event for the same task with a better name: see OnSelectionChanged for more details. +

+ Event called when the selected item changes -

This event was introduced in Lazarus 0.9.31 and it is called when the selected item is changed. - It is triggered when this is done by the user via, for example the mouse or keyboard, - and is also triggered when the selected item is changed programmatically.

+ +

+ This event was introduced in Lazarus 0.9.31, and is called when the selected item is changed. It is triggered when this is done by the user via, for example the mouse or keyboard, and is also triggered when the selected item is changed programmatically. +

+ Introduced in Lazarus 0.9.31 - - - - Create - constructor for TCustomRadioGroup: calls inherited Create, then sets list of buttons, and initializes layout and sizing properties - - - - TCustomGroupBox.Create - - - - - - - - - - Destroy - destructor for TCustomRadioGroup: frees items and buttons, then calls inherited Destroy - - - - - TWinControl.Destroy - - - - - - CanModify - if True, modification of the RadioGroup is permitted - - - - - - - - - - - - - - - - - - - Rows - the number of rows in which Items (radio boxes) are held - - - - Number of rows - - + - TRadioGroup : A group of related but mutually exclusive radio buttons, requiring the user to select one of a set of alternatives + TRadioGroup is a group of related but mutually exclusive radio buttons, requiring the user to select one of a set of alternatives +

- TRadioGroup: A group of related but mutually exclusive radio buttons, requiring the user to select one of a set of alternatives. As one button becomes selected, the remaining buttons in the group become automatically deselected.

-

To Use this control, place it in the required position on the form, then in the Object Inspector select Items and click on the ellipsis (...) to open the string editor. Type in the captions to accompany each check box, then close the string editor and you will see a series of Radio Boxes with their captions displayed beside them. (Note - unlike TCheckGroup, there is no special RadioGroup editor)

-

Inherits properties from TCustomRadioGroup and TCustomGroupBox + TRadioGroup: A group of related but mutually exclusive radio buttons, requiring the user to select one of a set of alternatives. As one button becomes selected, the remaining buttons in the group become automatically deselected.

- TRadioGroup behaves differently from a group of - - TRadioButton controls placed arbitrarily around a form.

-

In the case of TRadioButton, the mutual exclusivity is a feature that applies to any RadioButton anywhere in the Form, and the RadioButtons can be rearranged in any order or placed anywhere within the containing Form, while in TRadioGroup the exclusivity applies only to buttons within the Group, which are ordered strictly according to their ItemIndex within the Items stringlist.

+ To Use this control, place it in the required position on the form, then in the Object Inspector select Items and click on the ellipsis (...) to open the string editor. Type in the captions to accompany each check box, then close the string editor and you will see a series of Radio Boxes with their captions displayed beside them. (Note - unlike TCheckGroup, there is no special RadioGroup editor). +

- TRadioButton is an entity in itself, with a number of additional properties, whereas the buttons within - - TRadioGroup are not separate entities, but rather are simply entries in a list of strings, each of which is associated with the on-screen image of a - - RadioButton.

-

The example shows the difference between the use of TRadioButton and TRadioGroup + Inherits properties from TCustomRadioGroup and TCustomGroupBox. +

+

+ TRadioGroup behaves differently from a group of TRadioButton controls placed arbitrarily around a form. +

+

+ In the case of TRadioButton, the mutual exclusivity is a feature that applies to any RadioButton anywhere in the Form, and the RadioButtons can be rearranged in any order or placed anywhere within the containing Form, while in TRadioGroup the exclusivity applies only to buttons within the Group, which are ordered strictly according to their ItemIndex within the Items stringlist. +

+

+ TRadioButton is an entity in itself, with a number of additional properties, whereas the buttons within TRadioGroup are not separate entities, but rather are simply entries in a list of strings, each of which is associated with the on-screen image of a RadioButton. +

+

+ The example shows the difference between the use of TRadioButton and TRadioGroup.

@@ -2795,598 +3403,610 @@ being raised. - - - - - - - - - - - - - - - - - - - - - - Caption - the text string appearing above the whole RadioGroup box - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + - Items - a string list containing the captions of the radio boxes - -

- Items - a string list containing the captions of the radio boxes

-

Use the String List editor, opened by selecting Items and the ellipsis (...) in the Object Inspector, to insert the captions for the radio boxes, and determine their order and layout using the Rows, Columns and ColumnLayout properties -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - TCheckGroupClicked - generic event handler method for a click in a check group - - - - - - - - - - - - - - - TCustomCheckGroup: The base type for - - TCheckGroup + Items - a string list containing the captions of the radio boxes

- TCustomCheckGroup: The base type for - - TCheckGroup + Items - a string list containing the captions of the radio boxes. +

+

+ Use the String List editor, opened by selecting Items and the ellipsis (...) in the Object Inspector, to insert the captions for the radio boxes, and determine their order and layout using the Rows, Columns and ColumnLayout properties. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TCheckGroupClicked specifies a generic event handler method for a click in a check group + + + + + + Object generating the event notification + + + Ordinal position for the checkbox Item clicked in the control + + + + + TCustomCheckGroupis the base type for TCheckGroup + + +

+ TCustomCheckGroup is the base type for TCheckGroup. This class defines Items, where the captions for individual check boxes are stored, Rows and Columns for arranging the check boxes, and ColumnLayout to determine whether the data are arranged down the columns first, or across the rows first.

-

This class defines Items, where the captions for individual check boxes are stored, Rows and Columns for arranging the check boxes, and ColumnLayout to determine whether the data are arranged down the columns first, or across the rows first.

 TCustomGroupBox - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + - + Gets the value for the indexed Checked property - - + + + - - + Value for the property - - + Ordinal position for the check box examined in the method - + - + Gets the value for the indexed CheckEnabled property - - + + + - - + Value for the property - - + Ordinal position for the check box examined in the method - + - - - - + + Performs actions needed when a check box in the grouped control is clicked + + +

+ Clicked is a procedure which performs actions needed when a check box in the grouped control is clicked. Sender contains the TCheckBox instance generating the click notification. Clicked checks the internal list of check boxes to find the ordinal position for the control in Sender, and calls DoClick to trigger the OnItemClick event handler. +

+ + Please note: No actions are performed in the method if Sender is not found in the list of check boxes for the grouped control. + +

+ Clicked is used as the OnClick event handler in the TCheckBox instances created in UpdateItems. +

+ + + + + + + + - - + Check box generating the click notification - + - + + Signals the OnItemClick event handler when a check box in the control is clicked + - - - + Ordinal position for the check box clicked in the grouped control - - - + + + + Implements the OnKeyDown event handler assigned to checkboxes in the control + - - - - + + Object generating the event notification + + + Key examined in the method + + + Key modifier examined in the method + + + + + Implements the OnKeyUp event handler assigned to checkboxes in the control + - - - - + + Object generating the event notification - + + Key examined in the method + + + Key modifier examined in the method + + + + + Implements the OnKeyPress event handler assigned to checkboxes in the control + + + + + + Object generating the event notification + + + Key examined in the method + + + + + Implements the OnUTF8KeyPress event handler assigned to checkboxes in the control + + + + + + Object generating the event notification + + + UTF code point examined in the method + + + + + Raises an exception when the specified Index is not valid for the number of Items in the control + + + + + + Ordinal position examined in the method + + + + Sets the value for the AutoFill property + + + + + + + New value for the property + + - + Sets the value for the indexed Checked property - - + + + - - + Ordinal position for the checkbox updated in the method - - + New value for the checkbox - + - + Sets the value for the indexed CheckEnabled property - - + + + - - + Ordinal position for the checkbox updated in the method - - + New value for the enable state in the checkbox - + - + Sets the value for the ColumnLayout property - - + + + - - + New value for the property - + - + Adds or removes checkboxes for the Items defined for the control + + + + + + + + + Updates the ChildSizing property to use the number of Columns defined in the control + - - + + + + + + Updates the control when the Items property is changed + + +

+ Calls UpdateItems to refresh the checkboxes displayed for the grouped edit control. +

+ + + + + + Updates both the Items and the number of controls per line + +

+ Calls OwnerFormDesignerModified to notify the owner form when the control has been modified at design-time. +

+ + + + + + + + SetItems - specify the strings that form the Items of the group - - - + - - SetColumns - specifies the number of columns in which the Items are arranged + Sets the value for the Columns property - - + + + - - + New value for the property - + DefineProperties - overrides the method inherited from TComponent, defines the top, left properties - TComponent.DefineProperties - - + - Reads data from a stream + Reads LCL component streaming data from a stream - - - + TStream instance with values read in the method - + - Writes Data to a stream + Writes LCL component streaming data to a stream - - - + TStream instance where values are written in the method - + - - - - - - - - - - - - - - - Create - constructor for TCustomCheckGroup: calls inherited Create, then sets styles, creates lists, initializes sizing and layout properties - - + Performs actions needed when the component has finished loading from the LCL component streaming mechanism + + +

+ Overridden in TCustomCheckGroup to call the UpdateItems method when the component has finished loading from the LCL streaming mechanism. +

+ - TCustomGroupBox.Create + + - - - + + + + + Constructor for the class instance + +

+ Create is the overridden constructor for TCustomCheckGroup. It calls the inherited Create method. It also sets styles, creates lists, and initializes sizing and layout properties in the control. +

+ + + + - + + Owner of the class instance + + - - Destroy - destructor for TCustomCheckGroup: frees items and buttons, then calls inherited Destroy - - - + Destructor for the class instance + +

+ Destroy is the overridden destructor for TCustomCheckGroup. It frees items and check boxes in the control, and calls the inherited Destroy method. +

+ TWinControl.Destroy - - - - Rows - the number of rows in which the Items (check boxes) are arranged - - - - The number of rows holding items - - - - - Items - a string list for the captions of the check boxes - - - - Whether an individual entry in the list is Checked - - - - - - - - - - - - CheckEnabled - whether a given (indexed) entry in the list is allowed to be checked - - - - - - - - - - - Columns - the number of columns in which the - - Items (check boxes) are to be arranges - - - - - ColumnLayout - - - HorizontalThenVertical or vice versa - - - - - OnItemClick - event handler for mouse click on one of the Items in the Check Group - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - AutoFill - whether Check Boxes should be automatically filled in (checked) - - - - - - TCheckGroup : A group of Check Boxes physically and logically grouped together on a form + + +

- TCheckGroup: A group of Check Boxes physically and logically grouped together on a form

-

To Use this control, place it in the required position on the form, then -either right-click on the control to see the pop-up CheckGroup editor, or in the Object Inspector select Items and click on the ellipsis (...) to open the string editor. In either case, type in the captions to accompany each check box, then close the string or CheckGroup editor and you will see a series of boxes with their captions displayed beside them.

-

Inherits properties from TCustomCheckGroup and TCustomGroupBox + FlipChildren is an empty implementation in TCustomCheckGroup; no flipping is performed for the control. +

+ + + + + + + + + + Indicates the number of rows need to display Items (check boxes ) define in the control + + +

+ Rows is an Integer function which returns the number of rows needed to represents the check boxes defined in Items. The return value is the result of dividing the total number of Items by the number of Columns. The return value is zero (0) when no Items have been defined in the control. +

+ + + + + + + + The number of rows used for the Items + + + + + Indicates if check boxes are resized to fill the available space in the control + + +

+ AutoFill is a Boolean property which indicates whether child controls (check boxes) are resized to fill the available space in the control. When AutoFill is set to True, child controls are resized by setting the EnlargeHorizontal and EnlargeVertical properties in ChildSizing to the value crsHomogenousChildResize. When AutoFill is set to False, the properties in ChildSizing are set to the value crsAnchorAligning. +

+ + Please note: DisableAlign is called on entry to the method, and EnableAlign is called prior to exiting from the method. + +

+ AutoFill is set to True in the Create constructor. +

+ + + + + + + Items - a string list for the captions of the check boxes + + +

+ Items is a TStrings property which stores the captions for the check boxes on the grouped edit control. When the class instance is created, TCheckGroupStringList is used as the storage for the property values. +

+ + + + + + + + Whether an individual entry in the list is Checked + +

+ Checked is an indexed Boolean property used to read or write the state for a check box at the ordinal position specified in Index. +

+ + + + + Ordinal position in Items for the requested check box + + + + + CheckEnabled - whether a given (indexed) entry in the list is allowed to be checked + + +

+ CheckEnabled is an indexed Boolean property used to maintain the Enabled property for the check box at the position specified in Index. Index contains the ordinal position in the list of check boxes for the control, and must be in the range 0..Items.Count-1. An exception is raised when Index is not within the required range. +

+

+ Use the Checked property to determine if a check box has its Checked property set to True. +

+

+ Use Items to maintain the Captions for the check boxes displayed in the grouped edit control. +

+ + + + + + + + Ordinal position for the check box examined in the method + + + + + Columns is the number of columns in which the Items (check boxes) are arranged + + +

+ Columns is an Integer property which specifies the number of columns used to display the check boxes for the grouped edit control. Changing the value in the property causes the UpdateControlsPerLine method to be called. The new value for the property must be a positive non-zero value or an exception is raised. +

+

+ The value in Columns is used as the number of controls displayed per line in the ChildSizing property. +

+

+ The default value for the property is 1. +

+ + + + + + + + + + ColumnLayout + HorizontalThenVertical or vice versa + + +

+ ColumnLayout is a TColumnLayout property which specifies the layout strategy used when rendering the Items in the grouped edit control. The default value for the property is clHorizontalThenVertical, and causes check boxes to be drawn horizontally for the required number of Columns before advancing. +

+

+ Assigning a new value for the property causes ChildSizing to be updated to use the corresponding value in its Layout property. +

+ + + + + + + + + + + + OnItemClick - event handler signalled when the mouse is clicked on one of the Items in the control + + +

+ OnItemClick is a TCheckGroupClicked property used as the event handler signalled when a check box is clicked for the grouped edit control. Applications must implement and assign an object procedure using the signature in TCheckGroupClicked to respond to the input event. +

+ + + + + + + + + TCheckGroup is a group of Check Boxes physically and logically grouped together on a form + + +

+ TCheckGroup is a group of Check Boxes physically and logically grouped together on a form. +

+

+ To use this control, place it in the required position on the form, then either right-click on the control to see the pop-up CheckGroup editor, or in the Object Inspector select Items and click on the ellipsis (...) to open the string editor. In either case, type in the captions to accompany each check box, then close the string or CheckGroup editor and you will see a series of boxes with their captions displayed beside them. +

+

+ Inherits properties from TCustomCheckGroup and TCustomGroupBox.

@@ -3394,561 +4014,413 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the TRadioGroup - - - - - - - - - - - - - - - - - - - + + + + + + + + - Caption: the string which appears at the top of the Check Group Box - -

- Caption: the string which appears as a caption at the top of the Check Group Box to describe the function of the Check Group as a whole

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Items - a string list containing the captions of the check boxes - -

- Items - a string list containing the captions of the check boxes

-

Use the String List editor or the CheckGroup editor (opened by right-clicking on the control in the Form) to insert the captions for the check boxes, and determine their order and layout

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - TBoundLabel: A label bound to another object, for example in - - TLabeledEdit + String which appears at the top of the grouped edit control - TBoundLabel: A label bound to another object, for example in - - TLabeledEdit +

+ Caption is the string which appears as a caption at the top of the grouped edit control to describe the function of the Check Group as a whole. +

+ + + + + + + + + + + + + + + + + + + Items - a string list containing the captions of the check boxes + + +

+ Items is a string list containing the captions for the check boxes displayed in the grouped edit control. +

+

+ Use the String List editor or the CheckGroup editor (opened by right-clicking on the control in the Form) to insert the captions for the check boxes, and determine their order and layout. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Implements a label bound to another control + +

+ TBoundLabel is a TCustomLabel descendant which implements a label bound to another control. TBoundLabel is the type used to implement the EditLabel property in TCustomLabeledEdit and TLabeledEdit. +

+

+ Use Caption to assign the text displayed in the label. Use Layout to specify the text alignment used for the Caption value. +

+

+ The FocusControl property specifies the control given focus when a Dialog accelerator key or other input event in the class is handled. Use one of the AnchorSide* properties to specify the edge anchored to the FocusControl. +

+

+ Other than a constructor, the class does not have any new methods or event handlers. +

- TLabeledEdit + + + - + - - Create - constructor for TBoundLabel: calls inherited Create, makes itself a SubComponent to the Owner, and sets its caption to the owner name - - + Constructor for the class instance + + Create is the constructor for TBoundLabel. It calls the inherited Create method, and makes itself a SubComponent of the Owner. The Caption in the control is changd to the Name in the Owner. + - TCustomLabel.Create + - - + Owner for the class instance - + - FocusControl - whether this control has focus - + FocusControl is the control to receive focus when the label is activated + + +

+ FocusControl also receives key messages in the DialogChar method. +

+ - - - Caption : the caption which will appear on the Bound Label, to identify its function - + + + + + - - - - + + + + + - - - - + + + + + - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - TLabelPosition - enumerated type for position of a label relative to an edit box: above, below, left, right + TLabelPosition is an enumerated type with values that represent the position of a label relative to an associated control: i. e. above, below, left, or right + - - - - - + Custom Labelled Edit

- TCustomLabeledEdit - - - - - - -: The base type for - - LabeledEdit.

-

Note particularly the EditLabel property (see TBoundLabel), which contains the label attached to the Edit control.

+ TCustomLabeledEdit : The base type for LabeledEdit. +

+

+ Note particularly the EditLabel property (see TBoundLabel), which contains the label attached to the Edit control. +

TCustomEdit TCustomLabel - - - - - - - - - - - - - - - - - - - + + + + + - + Sets the value for the LabelPosition property - - + + + - - + New value for the property - + - + Sets the value for the LabelSpacing property - - + + + - - + New value for the property - + + + - - - - + Sets the value for the Parent property + +

+ SetParent is overridden in TCustomLabeledEdit to ensure that the EditLabel for the control is properly aligned after the value in Parent is changed. Calls DoPositionLabel to set the label visibility and position the label using the value in LabelPosition and LabelSpacing. +

+ + + + + + + + - - + New parent for the control - + - - - + +

+ SetName is overridden in TCustomLabeledEdit to assign the new value for the property to the Caption in EditLabel at design-time. SetName calls the inherited method prior to exit. +

+ + + + + - - + New value for the property - - - - - - + + + + Performs actions needed when the component has finished loading in the LCL streaming mechanism + + +

+ Loaded is overridden in TCustomLabeledEdit to position the EditLabel by calling the DoPositionLabel method. Loaded calls the inherited method. +

+ + + + + - - - - - - - - - - - - - - - - - + - DoPositionLabel - perform the code for positioning the label - - - + DoPositionLabel - perform the code for positioning the label + + +

+ DoPositionLabel is a procedure used to place the EditLabel relative to the companion control. No actions are performed in the method when EditLabel is unassigned (contains Nil). +

+

+ DoPositionLabel ensures that DisableAlign is called in the Parent control (when assigned). EnableAlign is called for the Parent control prior to exiting from the method. +

+

+ DoPositionLabel updates EditLabel to use the values assigned to the Parent and Visibility properties. The values in LabelPosition and LabelSpacing are used to determine the anchoring to the companion control applied to EditLabel. +

+ + + + + + + + + + - + - - + +

+ Notification is overridden in TCustomLabeledEdit to ensure that a reference to the EditLabel property is released when Operation contains the value opRemove. Notification calls the inherited method. +

+ - - + Component for the event notification - - + Operation for the event notification - + + + Handles the CM_BIDIMODECHANGED control message for the control + +

+ Ensures that an assigned EditLabel uses the value stored in the BiDiMode property. Calls DoPositionLabel to update the control layout and position, and calls Invalidate to force the control to be redrawn. +

+

+ Calls the inherited CMBiDiModeChanged method. +

+ + + + + + + + + + Message handled in the method + + - - + - - + - CreateInternalLabel - method for internally creating label - - - + CreateInternalLabel - method for internally creating label + + +

+ CreateInternalLabel is a method used to allocate resources for the EditLabel property in the class instance. TCustomLabeledEdit creates the TBoundLabel class instance used in EditLabel, and updates its ControlStyle property to prevent selection at design-time (csNoDesignSelectable). The current class instance is used as the FocusControl in EditLabel. +

+

+ No actions are performed in the method if EditLabel has already been assigned in the class instance. +

+

+ CreateInternalLabel is used in the implementation of the Create constructor. +

+ + + + + + + - + - Create - constructor for TCustomLabeledEdit: calls inherited Create then sets initial position and label spacing + Create - constructor for TCustomLabeledEdit: calls inherited Create then sets initial position and label spacing + @@ -3956,1010 +4428,1755 @@ either right-click on the control to see the pop-up CheckGroup editor, or in the TBoundLabel.Create - - + Owner of the class instance - + EditLabel - the label attached to the edit box - + - LabelPosition - - - - - - -- whether above, below, to the left or to the right of the Edit box + LabelPosition - whether above, below, to the left or to the right of the Edit box + - + - LabelSpacing - - - - - - - - the distance between the Label and the Edit box + LabelSpacing - the distance between the Label and the Edit box + - + - Labelled Edit: An Edit Box with a permanently attached Label + Labelled Edit is an Edit Box with a permanently attached Label

- TLabeledEdit - - - - - - -: An Edit Box with a permanently attached Label

-

Saves time and effort over placing separate Label and Edit Box on Form. The properties are described in the parent component, TCustomLabeledEdit from which most of the properties are inherited

+ TLabeledEditis an Edit Box with a permanently attached Label. +

+

+ Saves time and effort over placing separate Label and Edit Box on Form. The properties are described in the parent component, TCustomLabeledEdit from which most of the properties are inherited. +

TCustomEdit TBoundLabel - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Text + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - -: the text-string being entered or edited in the Labelled Edit box - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +

+ TPanelBevel is an alias to the TBevelCut type. TPanelBevel is the type used to implement the BevelInner and BevelOuter properties in TCustomPanel. +

+ + + + + + - + - + - The base class for a general container which can hold other objects. It has a customizable border and a central text. + + The base class for a general container which can hold other objects. It has a customizable border and a central text. +

- TCustomPanel: The base type for TPanel + TCustomPanelis the base type for TPanel.

-

A Panel is a defined rectangular area of the form into which other components can be placed to group them functionally and geographically.

- TCustomPanel defines the positioning and beveling properties of any descendent classes, and provides methods for painting and writing text to the panel.

+ A Panel is a defined rectangular area on a form into which other components can be placed to group them functionally and geographically. TCustomPanel defines the positioning and beveling properties of any descendent classes, and provides methods for painting and writing text to the panel. +

- - - - - + + + + + + + + + + + Draws a bevel using the color and width defined for the panel + +

+ PaintBevel is a procedure used to draw the bevel for the panel using the values in the BevelColor and BevelWidth properties. ARect is the rectangle with the coordinates where the bevel is drawn. ABevel contains the style used to draw the bevel. +

+ + Please note: No actions are performed in the method when ABevel contains the value bvNone. + +

+ PaintBevel uses the Canvas for the control as the target for the drawing operation. The Frame3D method in the Canvas is used to draw the bevel with the required color, width, and style for the panel. +

+

+ PaintBevel is used in the implementation of the Paint method to draw using both the BevelInner and BevelOuter styles. +

+ + + + + + + + + + - - - - - + + - - - - - + + - - - - - - - - - - - - - - - - - - - + - + Sets the value for the Alignment property - - + + + - - + New value for the property - + + + Sets the value for the BevelColor property + + + + + + + New value for the property + + - + Sets the value for the BevelInner property - - + + + - - + New value for the property - + - + Sets the value for the BevelOuter property - - + + + - - + New value for the property - + - + Sets the value for the BevelWidth property - - + + + - - + New value for the property - - - + + + Sets the value for the WordWrap property - - + + + - - - + + New value for the property - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - UpdateBordersAndBevels - make sure any changes to borders and bevels are accurately shown - - + Adjusts the specified rectangle to account for border and bevels used in the control + + +

+ AdjustClientRect is an overridden procedure used to adjust the drawing rectangle in ARect to account for borders and bevels used on the panel. AdjustClientRect calls the inherited method, and calculates the numer of pixels required for the settings in BorderWidth, BeveInner, and BevelOuter. AdjustClientRect calls InflateRect to adjust ARect by the calcluated border and bevel widths. +

+

+ AdjustClientRect is called when the control is autosize or aligned. +

+ + + + + + + + + + Drawing rectangle adjusted in the method + + + + Gets the size used for new instance of the class type + +

+ GetControlClassDefaultSize is overridden to provide the default size for new instances of the class type. The return value is a TSize type which contains the dimensions for the new control. The CX member contains the Width for the panel, and defaults to 170 pixels. The CY member contains the Height for the panel, and defaults to 50 pixels. +

+ - - - - - - - - - + TSize value with the default dimesions for new class instances - + - - - + - - - + - - - - - - - - - UpdateParentColorChange - update any pending changes in parent color - - - - - - - - Create - constructor for TCustomPanel: calls inherited Create then sets initial style, bevel, color, alignment and bounds - - + Performs actions needed when the component has finished loading in the LCL streaming mechanism + +

+ Loaded is an overridden procedure used to perform actions needed when the component has finished loading in the LCL component streaming mechanism. Loaded calls the inherited method, and calls UpdateParentColorChange to adjust the ControlStyle when ParentColor is in use. +

+ - TCustomControl.Create + + + - - - - - - - - - - - - - - Alignment - whether text is left or right justified, or centered - - - - - BevelInner - determines the nature of the Inner Bevel of the panel (whether raised, lowered etc) - - - - - BevelOuter - determines the nature of the Outer Bevel of the panel (whether raised, lowered etc) - - - - - BevelWidth - the Width of the panel's bevel in pixels - - - - - - - - - - - - - - - - - - - FullRepaint - if True, the panel needs to be fully repainted after each change - - - - - - - - - - - - - - - - - - The main class for a general container which can hold other objects. It has a customizable border and a central text. + + + Stores the specified value as the Caption for the control -

A Panel is a defined rectangular area of the form into which other components can be placed to group them functionally and geographically.

+

+ RealSetText is an overridden procedure used to store the specified value as the Caption for the control. RealSetText calls the inherited method to store the text, and then calls the Invalidate method to repaint the control. +

- + + New text value used as the caption for the control + + + + Paints the panel including the bevels and caption defined for the control + +

+ Paint is an overridden procedure which paints the panel including the bevels and caption defined for the control. Paint calls GetClientRect to get the rectangle used to draw the control. PaintBevel is called to draw both the inner and outer bevels for the control (when used). +

+

+ When Caption contains a String value (other than an empty string), the Canvas for the control is used to render the text. Values in the BiDiMode, WordWrap, and Layout properties are applied to the text as needed. +

+

+ Paint calls the inherited Paint method prior to exit. +

+ + + + + + + + Sets the background used for the parent control + +

+ SetParentBackground is an overridden procedure used to the set the background used for the parent control. SetParentBackground ensures that the ControlStyle property is updated to include or omit the value csOpaque. When AParentBackground contains True, the value is excluded from ControlStyle. When AParentBackground contains False, the value is included in ControlStyle. +

+

+ SetParentBackground calls the inherited method prior to exit. +

+ + + + + + + When True, the panel is drawn with transparency + + + + + Updates the control to reflect changes to the ParentColor property + + +

+ UpdateParentColorChange updates the control to reflect changes to the ParentColor property. +

+

+ When ParentColor is True, the parent color is used, so the value csOpaque is excluded from the ControlStyle property. Otherwise, Parent color is not used, and the value csOpaque is included in the ControlStyle property. +

+

+ UpdateParentColorChange is called from the Loaded method when the component has finished loading using the LCL component streaming mechanism. It is also called from the CMParentColorChanged method when the change message is handled for the control. +

+ + + + + + + Indicates if the Caption can be word wrapped when painted + +

+ WordWrap is a Boolean property which indicates if the text in the Caption property can be word wrapped into multiple lines when painting the control. The default value for the property is False, and indicates that word wrapping is not used for the caption. Changing the value in WordWrap causes the Invalidate method to be called to repaint the control. +

+

+ WordWrap is used in the Paint method to initialize properties in the TTextStyle argument used to render the text rectangle for the caption to its Canvas. +

+ + + + + + + + + + Constructor for the class instance + +

+ Create is the constructor for TCustomPanel. It calls the inherited Create method, and sets the initial style, bevel, color, alignment and bounds for the control. +

+ + + + + + + + Owner of the class instance + + + + + + + Alignment - whether text is left or right justified, or centered + + +

+ Alignment is a TAlignment property that indicates how the text (or Caption) is aligned on the panel. The default value for the property is taCenter, and causes text to be aligned to the center of the panel. Changing the value in Alignment causes the Invalidate method to be called to repaint the control. +

+ + + + + + + + + + Color used to draw bevels for the panel + +

+ BevelColor is a TColor property that specifies the color used to draw bevels for the panel. BevelColor is used in the PaintBevel method; it is passed as an argument to Canvas drawing routines when BevelColor contains a value other than clDefault. +

+

+ The default value for the property is clDefault. Changing the value in BevelColor causes the Invalidate to be called to repaint the control. +

+ + + + + + + + + + BevelInner - determines the nature of the Inner Bevel of the panel (whether raised, lowered etc) + + + + + + BevelOuter - determines the nature of the Outer Bevel of the panel (whether raised, lowered etc) + + + + + + BevelWidth - the Width of the panel's bevel in pixels + + + + + + + + FullRepaint - if True, the panel needs to be fully repainted after each change + + +

+ Exists only for Delphi compatibility; it has no effect in LCL. +

+ + + + + + + Indicates if the background from the parent control is used to draw the background for the control + + +

+ When ParentBackground is True, the control uses the background from the parent color (including any theme drawing features from ThemeServices). +

+

+ ParentBackground is used in conjunction with the ControlStyle property. Changing the value in ParentBackground causes the ControlStyle property to be updated to reflect the property setting. When the property is set to True, the value csOpaque is excluded from ControlStyle to allow the default background to be drawn. When the property is set to False, the value csOpaque is included in the ControlStyle property. +

+

+ The default value for the property is True. +

+ + + + + + + + + Indicates if the control is drawn using the color in the parent control + +

+ When ParentColor is True, the control is drawn using the Color from the parent control. When ParentColor is False, the Color property is used to draw the control. +

+

+ The default value for the property is True. +

+

+ Changing the value for the property causes the UpdateParentColorChange method to be executed. +

+ + + + + + + + + + + + + Implements a general purpose container which can hold other components + + +

+ TPanel is a TCustomPanel descendant which defines a rectangular area on a form into which components can be placed to group them functionally and geographically. TPanel is a general container for other components, and has a customizable border and caption. +

+ + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + + + + + + + + + + + + + + + + + + Represents the flow styles used in TCustomFlowPanel + +

+ TFlowStyle is an enumerated type which contains values that represent the flow styles available in TCustomFlowPanel. It is the type used to implement the FlowStyle property in TCustomFlowPanel. +

+ + + + + + + Controls flow from left to right, then top to bottom + + + Controls flow from right to left, then top to bottom + + + Controls flow from left to right, then bottom to top + + + Controls flow from right to left, then bottom to top + + + Controls flow from top to bottom, then left to right + + + Controls flow from bottom to top, then left to right + + + Controls flow from top to bottom, then right to left + + + Controls flow from bottom to top, then right to left + + + + + +

+ TWrapAfter is an enumerated type with values that specify the wrapping strategy for controls in TCustomFlowPanel. +

+ + + + + Automatically wrap when the control exceeds the bounds + + + Always wrap after this control + + + + Try not to wrap after this control, if the control is already at the beginning + + + + Never wrap after this control + + + + Implements a collection item for the TFlowPanelControlList collection + +

+ TFlowPanelControl is a TCollectionItem descendant which implements a collection item maintained in TFlowPanelControlList. TFlowPanelControl provides properties and methods need to represent a flowed control in the collection, and provides support for the IObjInspInterface used in the Lazarus Object Inspector. +

+ + + + + + + + + + + Sets the value for the Control property + + + + + + + New value for the property + + + + Sets the value for the WrapAfter property + + + + + + + New value for the property + + + + Gets the value for the DisplayName property + + + + + Value for the property + + + + Sets the value for the Index property + + + + + + + + + implement persistence in the control + +

+ AssignTo is an overridden method used to implement persistence in the control. AssignTo provides support for storing property values from the current class instance into the Dest argument when it is derived from TFlowPanelControl. Otherwise, the inherited AssignTo method is called. +

+ + + + + Persistent object where property values are stored + + + + Gets the TFlowPanelControlList instance that owns the collection item + + + + + + + TFlowPanelControlList instance that owns the collection item + + + + + Gets the TCustomFlowPanel instance that owns the collection and its items + + + + + + TCustomFlowPanel instance that owns the collection and its items + + + + + Used by the Lazarus object inspector. + + + + + + + + + Used by the Lazarus object inspector. + + + + + + + + The associated control to the flow panel control item. + + Don't set the Control property manually. It is used internally by the designer. + + + + + Determines the wrap policy after this control. + + Valid only when TFlowPanel.AutoWrap is set to True. + + + + + + Ordinal position for flowed control in the TFlowPanelControlList collection + + +

+ Index is a published property in TFlowPanelControl. Changing the value in Index causes the owner panel to call its ReAlign method when it is not being loaded, updated, or destroyed. +

+ + + + + + + + + + + Implements a collection for TCustomFlowPanel collection items + +

+ TFlowPanelControlList is a TOwnedCollection descendant. TFlowPanelControlList implements the IObjInspInterface interface which allows the collection to be used in the Lazarus Object Inspector. +

+ + + + + + + + Gets the value for the indexed Items property + + + + + Value for the property + + + Ordinal position in the collection for the requested item + + + + Sets the value for the indexed Items property + + + + + + + Ordinal position in the collection for the specified item + + + New value for the property + + + + Gets the owner of the collection as a TCustomFlowPanel instance + + + + + The flow panel which owns the collection and its items + + + + Adds a TFlowPanelControl instance to the owned collection + + + + + TFlowPanelControl instance created in the method + + + + + + + + + + + + The default value for the argument is -1 + + + + + + + + + + + + + Constructor for the class instance + + + + + Owner of the class instance + + + + + Gets the ordinal position of the specified control in the list of controls + + + + + + + + + + + + + Provides indexed access to controls stored in the container + +

+ Items is an indexed TFlowPanelControl property which provides access to the flow panel controls in the container. Items is the default property for the collection. +

+

+ Use the Add or the AddControl method to add a flow panel control to the collection. +

+

+ Use RemoveControl to remove a flow panel control from the collection. +

+ + + + + + + + + + Ordinal position for the requested control + + + + + + + + + + + + + + + + + + + + + + + The base class for TFlowPanel + - - - + + + + + + + + Sets the value for the AutoWrap property - + + + - - - + + New value for the property + + + + Sets the value for the ControlList property - + + + - - - + + New value for the property + + + + Sets the value for the FlowStyle property - + + + - - - + + New value for the property + + + + Sets the value for the FlowLayout property - + + + - - - - - + + New value for the property - - - - - + + + Handles the CM_CONTROLCHANGE message + +

+ Calls DisableAlign prior to adding (inserting) the control in ControlList. Calls ReAlign when the control is added, and calls EnableAlign prior to exit. +

+ + Please note: The CM_CONTROLCHANGE message is ignored when the component is being loaded using LCL steaming. No actions are performed in the method when csLoading is in the ComponentState property. + + + - - - - - + + Message with parameters examined in the method - - - - - + + + Performs layout and alignment for flowed controls on the panel + +

+ AlignControls is an overridden procedure used to perform layout and alignment for flowed controls on the panel. +

+ + Please note: AlignControls does NOT call the inherited method. + + + - - - - - + + - - - - - + + - - - - - + + + + + CalculatePreferredSize is an overridden procedure used to calculate the preferred height and width for the flow panel. CalculatePreferredSize calls the inherited method. + + - - - - + + - - - - + + - - - - - + + - - - - - + + + Constructor for the class instance + +

+ Create is the overridden constructor for the class instance, and calls the inherited constructor. Create ensures that resources are allocated for the ControlList property, and sets the default value for AutoWrap to True. +

+ + - - - - - + + Owner of the class instance - - - - - + + + Destructor for the class instance + +

+ Destroy is the overridden destructor for the class instance. Destroy calls the inherited destructor, and frees resources allocated to the ControlList property. +

+ + - - - - - + + + Gets the ordinal position in ControlList for the specified control + +

+ GetControlIndex is a convenience method used to get the ordinal position in ControlList for the specified flowed control. +

+

+ Use SetControlList to store an Index value for the specified flowed control. +

+ + + + + - - - - - - + + + + + + + + Sets the Index position in ControlList for the specified control + + + + + Control to locate in the list of controls + + + Value assigned to the Index property for the specified control + + + + Determine if controls in TCustomFlowPanel are wrapped. + + + + Use ControlList to set extra options of flow panel controls. + + + + Use FlowStyle to determine the flow direction of the flow panel layout. + + + + + Use FlowLayout to set the layout (alignment) for the non-flow coordinate. The default value is tlTop + + +

+ In case of horizontal/vertical flow style: tlTop: top/left alignment in row/column tlCenter: center tlBottom: bottom/right. +

+ + + + + Implements a container with flowed layout for its controls + +

+ Use TFloatPanel if you need a container with a float layout. The Anchors and Align properties of child controls are ignored. The floating direction is determined with FlowStyle property. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TBalloonFlags enumerated type for flags used in Tray Icon balloons + + +

+ TBalloonFlags is an enumerated type with values representing flags used in Tray Icon balloon hints. It is the type used to implement the BalloonFlags property in TCustomTrayIcon. +

+ + + + No icon is displayed on a balloon hint + + + Displays an Information icon on a balloon hint + + + Displays a Warning icon on a balloon hint + + + Displays an Error icon on a balloon hint + + - TCustomTrayIcon - the base class for - - TTrayIcon, a multiplatform System Tray component. - - - - TTrayIcon is a multiplatform System Tray component. It adds an icon to the tray and signifies an application that is inactive but ready to be activated. Under Windows the System tray is usually located on the bottom-right corner of the screen, but it may be elsewhere. On other operating systems this position varies. - - + Implements the base class for a a multi-platform System Tray component + - Create creates a new instance of a TCustomTrayIcon class. - If AOwner is not Nil, the new component attempts to insert itself in the list of owned components of the owner. - +

+ TCustomTrayIcon is the base class for TTrayIcon, a multi-platform System Tray component. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the value for the AnimateInterval property + + + + + + + Value for the property + + + + Gets the value for the Canvas property + + + + + + + Value for the property + + + + Prevents the tray icon from being displayed during component streaming + +

+ InternalShow is called when the Show method is executed during LCL component streaming. InternalShow sets a flag to enable delayed display when csLoading is in the ComponentState property. No additional actions are performed in the method during LCL component streaming. +

+

+ The return value contains the result from the Show method in WidgetSetClass. Visible is updated to reflect the state indicated in the widget set class. The value in Animate is used to enable or disable the animation timer for the class instance. +

+ + + + + + + + + + True when the tray icon is enabled and visible + + + + Sets the value for the Animate property + + + + + + + New value for the property + + + + Sets the value for the AnimateInterval property + + + + + + + New value for the property + + + + Sets the value for the Hint property + + + + + + + New value for the property + + + + Sets the value for the Icon property + + + + + + + New value for the property + + + + Sets the value for the Icons property + + + + + + + New value for the property + + + + Sets the value for the PopupMenu property + + + + + + + New value for the property + + + + Sets the value for the Visible property + + + + + + + New value for the property + + + + Performs actions needed when the popup notifier is closed + +

+ HandleNotifierClose ensures that the internal balloon hint timer for the tray icon is disabled when the notifier is closed or destroyed. HandleNotifierClose is assigned to the OnClose event handler in the internal TPopupNotifier class instance used in the tray icon. +

+ + + + + + + Object instance for the event notification + + + Action to perform; not used in the method + + + + Event handler used when the timer in the tray icon has expired + +

+ HandleNotifierTimeout is a procedure which implements an event handler used to disabled the timer and to close the popup notifier for the tray icon. HandleNotifierTimeout is used as the OnTimer event handler in the TTimer class instance used in the component. +

+ + + + + + + Object instance for the event notification + + + + Event handler used when the interval for the animation timer has elapsed + +

+ HandleOnAnimateTimer is a procedure used to implement an event handler signalled when the interval for the animation timer has elapsed. HandleOnAnimateTimer retrieves and displays a bitmap stored in the Icons property when the interval for the timer has elapsed. An internal counter is incremented in the handler to indicate the next image used in the animation sequence. The counter is reset to zero (0) when the last bitmap in Icons is used. HandleOnAnimateTimer calls the InternalUpdate method to refresh the widget set class for the tray icon. +

+

+ HandleOnAnimateTimer is assigned to the OnTImer event handler for the internal TTimer instance used as the animation timer. +

+

+ Use Animate to control whether animations are displayed for the tray icon. +

+

+ Use AnimateInterval to specify the number of elapsed milliseconds allowed before the event handler in the animation timer is signalled. +

+ + + + + + + + + + Object instance for the event notification + + + - Create - constructor for TCustomTrayIcon: performs inherited Create then creates icon, timer and initializes balloon timeout + Implements an event handler signalled when the Icon is changed for the component + + +

+ IconChanged is a procedure which implements an event handler signalled when the Icon is changed for the component. IconChanged ensures that the WidgetSetClass is notified of the change to the tray icon. +

+ + Please note: No actions are performed in the event handler if a Handle has already been assigned (contains a non-zero value) for the component. + +

+ IconChanged is assigned as the OnChange event handler for the Icon property in the constructor for the class instance. +

+ + + + + + + + Object instance for the event notification + + + + + + Performs action when a component is added or removed at run-time + +

+ Notification is an overridden procedure used to perform actions when a component is added or removed at run-time. Notification calls the inherited method, and ensures that the PopUpMenu for the tray icon is set to Nil when the component is removed. +

+ + + + + Component for the notification + + + Operation for the notification + + + + + Performs actions needed when the component has finished loading from the LCL streaming mechanism + + +

+ Loaded is an overridden procedure used to perform actions needed when the component has finished loading from the LCL streaming mechanism. Loaded calls the inherited method, and calls the InternalShow method to display the tray icon. +

+ + + + + + + + Operating system Handle for the Tray Icon + +

+ Handle is a public HWND member that represents the operating system handle for the control. The value in Handle is used (when assigned) in the IconChanged event handler. +

+ + + + + + + Create - constructor for TCustomTrayIcon: performs inherited Create then creates icon, timer and initializes balloon timeout + + +

+ Create creates a new instance of a TCustomTrayIcon class. If AOwner is not Nil, the new component attempts to insert itself in the list of owned components of the owner. +

+ TComponent.Create + - - Destroy sends a opRemove notification to all components in the free-notification list. After that, all owned components are destroyed by calling DestroyComponents (and hence removed from the list of owned components). When this is done, the component removes itself from its owner's child component list. -After that, the parent's destroy method is called. - Destroy - destructor for TCustomTrayIcon: frees icon and timer then calls inherited Destroy + +

+ Destroy sends a opRemove notification to all components in the free-notification list. After that, all owned components are destroyed by calling DestroyComponents (and hence removed from the list of owned components). When this is done, the component removes itself from its owner's child component list. After that, the parent's destroy method is called. +

+ TComponent.Destroy + - Hide - Removes the icon from the System Tray + Hide removes the icon from the System Tray + +

+ Hide is a Boolean function used to hide the tray icon and to remove it from the tray area in the task bar. +

+ + Please note: No actions are performed in the method when Visible is set to False, or at design-time, or when the component is loaded from the LCL streaming mechanism. + +

+ Hide sets the value in the Visible property to False, and calls the namesake method in the WidgetSetClass. The internal animation timer for the tray icon is also disabled in the method. +

+

+ The return value is True when the tray icon is successfully hidden. For other conditions, the return value is False. +

+ + + - Show - Shows the icon on the System Tray + Show displays the icon in the System Tray + +

+ Show is a Boolean function used to display the tray icon in the system tray. The return value is True if the control is successfully displayed in the method, or the control is already visible. No additional actions are performed in the method when Visible is already set to True. +

+

+ The return value is always False at design-time. At run-time, the InternalShow method is called to display the control with delayed loading and to set the sate for the internal animation timer. +

+ + + + + + InternalUpdate - updates any pending changes + + +

+ The behavior of this method depends on the widgetset.It was added to provide a way to update items which either cannot be updated automatically when changed, or would be too inefficient to be updated on each change. +

+

+ One example of this is the tray icon menu under LCL-Carbon. It is not automatically updated when changes are made to it's associated LCL TPopUpMenu, but changes are updated when InternalUpdate is called. This happens because the tray icon menus are Cocoa menus which don't match the Carbon menus from LCL-Carbon. +

+

+ Similar things happen in other widgetsets, so InternalUpdate can be expected to update the menu and/or icon of the tray icon, if this is necessary. If such an update is not required, for example because it is automatically updated on each change, then InternalUpdate will simply do nothing, so it is always a safe function to call, regardless of the widgetset. +

+ + + + - ShowBalloonHint displays a small balloon-like window near the tray icon. It can be used to send notifications about the status of an action, or notify of a received message or any other event which doesn't require an immediate response. The Balloon window disappears after BallonHintTimeout milliseconds or when the user clicks it or it's close button. + Displays a balloon-like window near the tray icon + + +

+ ShowBalloonHint displays a small balloon-like window near the tray icon. It can be used to send notifications about the status of an action, or notify of a received message or any other event which doesn't require an immediate response. The Balloon window disappears after the BallonHintTimeout interval has elapsed, or when the user clicks on the close button for the balloon hint. +

+ + + - Find the position of the Tray Icon and thus a position suitable to display the hinting BalloonHint. Under Windows an approximate location is detected. + + Gets the position for the tray icon on the display + + +

+ GetPosition is a TPoint function used to get the position of the tray icon on the display. GetPosition calls the namesake method in the WidgetSetClass to get the location for the tray icon. The coordinates in the return value are used to determine the location for a BalloonHint window for the tray icon. +

+

+ For the Windows platform, an approximate location in the tray area in the Windows taskbar is used. +

+ + + + + Indicates if animations are displayed on the tray icon + +

+ Animate is a Boolean property that indicates if animations are displayed on the tray icon. +

+

+ The default value for the property is False. Sets Animate to True to enable the animation timer using the interval in AnimateInterval, and start the animation sequence stored in the Icons property. +

+ + + + + + Defines the time interval between updates to the image for the tray icon + +

+ AnimateInterval is a Cardinal property that defines the elapsed time interval between updates to the image displayed on the tray icon. The default value for the property is 1000 (milliseconds), and causes the animation timer to refresh the image on the tray icon every second. +

+

+ Update the Icons property to contain the bitmaps displayed in the animation sequence, +

+

+ Set Animate to True to enable the animation timer for the tray icon. +

+ + + + - the set of kinds of balloon flag that can be displayed (may be None, Info, Warning or Error) + + Defines the balloon flag displayed for the tray icon balloon hint + + +

+ BalloonFlags is a TBalloonFlags property which defines the balloon flag displayed for the tray icon balloon hint. BalloonFlags are used when the widget set class displays the balloon hint window for the tray icon. The default value for the property is bfNone. See for more information about the values in the enumeration and their meanings. +

+ + + + + The text to be shown in the hinting balloon + The period after which the hinting balloon disappears + The title to be shown on the hinting balloon + The canvas of the Tray Icon + - PopUpMenu - a popup menu which is displayed when right mouse button is clicked over icon - separate from hint balloon + + PopUpMenu is a popup menu which is displayed when right mouse button is clicked over the icon, separate from the balloon hint window + + - The Icon or picture that is to be displayed + The Icon or picture that displayed on the tray icon + - A simple hint that is shown when the mouse hovers over the icon. + A simple hint shown when the mouse hovers over the icon + Determines if Icon should be painted to the System Tray. This can be set to false if one wishes to instead paint to the Canvas of the Tray Icon. + It is set to true when the icon is shown and remains true until Hide is called. Setting Visible has the same effect as calling Hide or Show. + Event Handler for Mouse Click on Tray Icon + Event handler for mouse double-click + Event handler if mouse button is pressed down + Event handler if mouse button is up + Event handler for mouse movement + - Use this to implement custom drawing to the icon. Draw using the canvas property of the icon. Note: Does not work on win32. + + Event handler used to implement custom drawing for the tray icon + + +

+ OnPaint is an event handler used to implement custom drawing for the tray icon. Draw using the canvas property for the tray icon. +

+ + Please note: OnPaint does not work on the Win32 platform. + + + + + + Implements a multi-platform System Tray component + + +

+ TTrayIcon is a TCustomTrayIcon descendant which implements a multi-platform System Tray component. It adds an icon to the tray which signifies an application that is inactive but ready to be activated. +

+

+ On the Windows platform, the System tray is usually located on the bottom-right corner of the screen, but it ban be located on other edges for the physical screen. For other operating systems, this position varies according to the window or display manager in use. +

+

+ TTrayIcon sets the visibility for properties defined in the ancestor class. +

+ + + + + + @@ -4974,90 +6191,1475 @@ After that, the parent's destroy method is called. - + + +

- Assign copies the contents of - - Source to - - - Self, if the classes of the destination and source classes are -compatible. -

-

The TPersistent implementation of Assign does nothing -but calling the AssignTo method of -source. This means that if the destination class does not know how to assign -the contents of the source class, the source class instance is asked to assign -itself to the destination class. This means that it is necessary to -implement only one of the two methods so that two classes can be assigned to -one another. -

- -

In general, a statement of the form -

- Destination:=Source; - -

(where Destination and Source are classes) does not -achieve the same as a statement of the form -

- Destination.Assign(Source); - -

After the former statement, both Source and -Destination will point to the same object. The latter statement -will copy the contents of the Source class to the -Destination class. -

- + TBandDrawingStyle is an enumeration type with values representing the drawing styles available for toolbar bands. +

+ - - - - - - + + + + + + + + + Represents the paint options enabled when drawing a TControlBar + +

+ TBandPaintOption is an enumerated type with values that represent the paint options enabled when drawing a TControlBar instance. Values from TBandPaintOption are stored in the TBandPaintOptions type, and passed as an argument to a TBandPaintEvent event handler. +

+ + + + + + + + + + + + + + + + + + Stores values from the TBandPaintOption enumeration + + + + + + Specifies an event handler signalled when a control band is dragged + + + + + + + + + + + + + + + + Specifies an event handler used to get layout and positioning information for control bands + + + + + + + + + + + + + + + + + + + + + + Specifies an event handler signalled when a control band is moved + + + + + Object instance for the event notification + + + Control for the event notification + + + Display rectangle for the event notification + + + + + Specifies an event handler used to perform actions needed when a band in TCustomControlBar is painted + + +

+ TBandPaintEvent specifies an object procedure used to perform actions needed when a band in TCustomControlBar control is painted. TBandPaintEvent is the type used to implement the OnBandPaint event handler in TCustomControlBar. +

+

+ Arguments passed to the procedure identify the TCustomControlBar drawn in the band, and the Canvas and drawing rectangle used in the drawing operation. Options define the drawing features enabled for the band. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ TRowSize a range type which defines the range of values available for the RowSize property in TCustomControlBar. Essentially, any positive non-zero Integer value. +

+ + + + + + Represents band move states in TCtrlBand + + + + + + + + + + + + + + + + Represents cursor shapes displayed when the mouse hovers over different an area in a control band + + + + + + + + + + + + + + + + + + TCtrlBand is a class used to represent a band displayed in a TCustomControlBar instance. + + + + + + + + + + + + + + + + + + + + Gets the value for the BandRect property + + + + + + + Value for the property + + + + Gets the value for the Bottom property + + + + + + + Value for the property + + + + Gets the value for the Right property + + + + + + + Value for the property + + + + Sets the value for the BandRect property + + + + + + + New value for the property + + + + Sets the value for the Right property + + + + + + + New value for the property + + + + Contains the bounds for the band control + +

+ BandRect is a TRect property which contains the bounds for the band control. BandRect is used in methods which set the layout and placement for the the band control, like InitializeBand and MoveBand. +

+

+ Values in BandRect are read from the Left, Right, Width, and Height properties in the control. When setting the value for the property, the Left, Right, Width, and Height properties are updated using the values provided in the rectangle. +

+ + + + + + Position of the bottom of the band control + + Bottom is a read-only Integer property which contains the vertical position that is the bottom of the band control. The value in Bottom is derived using the Top and Height properties, which are updated when a value is assigned to the BandRect property. + + + + + + + +

+ Control is a TControl property which contains the TToolBar or TToolButton displayed in the band control. The value in Control is assigned in either the Loaded or the InsertControl methods in TCustomControlBar. +

+ + + + + + + +

+ ControlHeight is an Integer property which represents the height for the TWinControl in the Control property. The value in ControlHeight is assigned when a TCustomControlBar is aligned to the band control. +

+ + + + + + + Stored position for the Control used in comparisons during resizing + + + The value is updated in the AlignControlToBand method in TCustomControlBar, and provides convenient access to the property value in Control. + + + + + + + Stored position for the Control used in comparisons during resizing + + +

+ The value is updated in the AlignControlToBand method in TCustomControlBar, and provides convenient access to the property value in Control. +

+ + + + + + + Stored position for the Control used in comparisons during resizing + + +

+ The value is updated in the AlignControlToBand method in TCustomControlBar, and provides convenient access to the property value in Control. +

+ + + + + + + Stores the last visibility for the Control + + +

+ Updated and used in the CheckBandsSizeAndVisibility method in TCustomControlBar. +

+ + + + + + + Stored position for the Control used in comparisons during resizing + + +

+ The value is updated in the AlignControlToBand method in TCustomControlBar, and provides convenient access to the property value in Control. +

+ + + + + + Stores the initial position for the band during a move operation + +

+ Updated in the InitializeMove method in TCustomControlBar. +

+ + + + + + Stores the initial position for the band during a move operation + +

+ Updated in the InitializeMove method in TCustomControlBar. +

+ + + + + + Contains the position for the band + +

+ Updated when a value is assigned to the BandRect property, and in the AlignControlToBand method in TCustomControlBar. +

+ + + + + + Contains the position for the band + +

+ Updated when a value is assigned to the BandRect property, and in the AlignControlToBand method in TCustomControlBar. +

+ + + + + + Contains the position for the band + +

+ Updated when a value is assigned to the BandRect property, and in the AlignControlToBand method in TCustomControlBar. +

+ + + + + + Indicates if the band and its Control are visible + + + + + + + Contains the dimensions for the band + +

+ Updated when a value is assigned to the BandRect property, and in the AlignControlToBand method in TCustomControlBar. +

+ + + + + + + +

+ TCtrlBands is a container for TCtrlBand instances. TCtrlBands provides a GetIndex method used to access TCtrlBand items stored in the container by their ordinal positions. +

+ + + + + + Gets the ordinal position for the specified control in the container + + + + + + Ordinal position for the requested control, or -1 when not found in the container + + + + The control to locate in the TCtrlBand items in the container + + + + + Implements a panel used to maintain and manage toolbars and toolbuttons on a form + + +

+ TCustomControlBar is a TCustomPanel descendant used to maintain and manage toolbars and toolbuttons added to the container. +

+

+ Internally, it uses a TCtrlBands member to represent the TToolBar, TToolButton, or TCoolBar classes added to the container. Use InsertControl and RemoveControl to maintain items in the container at run-time, or use the design-time support provided in the Lazarus Form Designer. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + Sets the value for the DrawingStyle property + + + + + + + New value for the property + + + + Sets the value for the GradientDirection property + + + + + + + New value for the property + + + + Sets the value for the GradientEndColor property + + + + + + + New value for the property + + + + Sets the value for the GradientStartColor property + + + + + + + New value for the property + + + + Sets the value for the Picture property + + + + + + + New value for the property + + + + Sets the value for the RowSize property + + + + + + + New value for the property + + + + Space reserved for the horizontal border in a control bar + + + + Space reserved for the vertical border in a control bar + + + + Space reserved as the width of the grabber in a control bar + + + + + Space needed for the width of the grabber including the control bar and its border + + + + + + + + + + + + + + + + + Aligns the control bar to the specified control band + + + + + + + + + + + + Aligns visible control bands in the container + + Temporarily disables AutoSizing during the alignment process. Restores AutoSizing prior to exiting from the method. + + + + + + Calculates the vertical space needed for the control bar + + + + + Number of pixels need for the height of the control bar + + + Toolbar or Toolbutton control examined in the method + + + + + Calculates the vertical space needed for the control bar when RowSnap is enabled + + + + + + + + + + + + + + Calculates the cumulative width for all borders and bevels used on the control bar + + + + + + + + + + + Gets the largest value in the Bottom property for visible bands on the control bar + + + + + + + + + + + + + + + + + + + + + + + + + Changes the cursor to the specified shape + +

+ ACursor contains the cursor shape requested in the method. The value in ACursor is translated into one the following cursor constants, and assigned to the Cursor property: +

+
+
cdDefault
+
Uses the default Cursor for the control.
+
cdGrabber
+
Uses the crDrag cursor constant as the cursor shape.
+
cdRestricted
+
Uses the crNo cursor constant as the cursor shape.
+
+ + + + + Cursor shape requested in the method + + + + + Updates the size and visibility for TCtrlBand instances defined in the control bar + + +

+ Calls InitializeBand (when needed) for a TCtrlBand with a visibility different than the value in the control bar. Calls SortVisibleBands when a TCtrlBand is hidden. Calls NormalizeRows to display TCtrlBand instances in the order defined by their Bottom property. Recalculates the positions and dimensions for visible TCtrlBand instances, including the space reserved for the Grabber bar and borders. +

+ + + + + + Handles the CM_BIDIMODECHANGED message + + + + + + + + + Handles the CM_BORDERCHANGED message + + + + + + + + + + Ensures the default cursor and width values are assigned when the window handle is created + + + + + + + + Signals the OnBandMove event handler for the specified control and drawing rectangle + + + + + + + + + + + + + Signals the OnBandPaint event handler using the arguments to the method + + + + + + + + + + + + + + + + + + + Signals an assigned OnBandDrag event handler and starts a drag operation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Signals the OnBandInfo event handler to store control information in the arguments to the method + + + + + + + + + + + + + + + + + + + Class constructor used to initial class constants + + + + + + + + + + + + + + + + + + + + + + + + + + + Performs actions needed when component loading has been completed + + + + + + + + + + + + + + + + + + + + + Handles a mouse down message in the control + +

+ Overridden to provide support for dragging the control band under the mouse cursor. +

+ + + + + + + + + + + + + + + + + + Handles a mouse move message while dragging a control band + + + + + + + + + + + + + + + Handles a mouse up message that ends a drag operation for a control band + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Orders visible bands in the control, and removes empty rows + + + + + + + Draws the control with its image, decorations, and visible bands + + + + + + + + + + + + + + + + + + + + + + Sets the Cursor to the specified TCursor shape + + + + + TCursor shape + + + + + + + + + + + + + + + + + + + + + + + + + + + + Handles the LM_SIZE message + + + + + + + + + + + Constructor for the class instance + +

+ Create is the overridden constructor for the class instance. Create allocates resources needed to store the bands for the control bar, and calls the inherited constructor. Creates sets the default values for properties, including: +

+
    +
  • ControlStyle
    • +
  • AutoDrag
    • +
  • AutoDock
    • +
  • BevelOuter
    • +
  • BevelInner
    • +
  • DockSite
    • +
  • GradientDirection
    • +
  • GradientStartColor
    • +
  • GradientEndColor
    • +
  • RowSize
    • +
  • RowSnap
    • +
+

+ Resources are allocated for the Picture property, and its OnChange event handler is set to the PictureChanged method. +

+

+ Creates set the initial bounds for the class instance using a width of 100 pixels, and a height of 50 pixels. +

+ + + + + Owner of the class instance + + + + Destructor for the class instance + +

+ Destroy is the overridden destructor for the class instance. Destroy frees resources allocated to the Picture property, as well as the internal TCtrlBands container. Destroy calls the inherited destructor prior to exit. +

+ + + + + + + Increments the internal counter used to track the number of active update requests + + + + + + + + Decrements the internal counter used to track update requests, and calls Invalidate when the counter is zero (0) + + + + + + + + + FlipChildren is an empty implementation in TCustomControlBar. + + + + + + + + + Gets the visible control for a band under the specified coordinates + + + + + The toolbar or toolbutton in the band at the specified position, or Nil when a visible control is not found + + + + Horizontal position for the test + + + Vertical position for the test + + + + + +

+ InsertControl is an overridden procedure used to create, initialize, and store a TCtrlBand for the specified control. InsertControl calls the method inherited from TWinControl, and creates and stores a new TCtrlBand instance for the control in AControl. +

+ + + + + + + Toolbar or Toolbutton added to the new band in the control bar + + + Ordinal position in the bands where the control is inserted + + + + + + + + + + + + + + + + + + + + + + Removes the band for the specified control + + + + + Toolbar or Toolbutton removed from the bands in the control bar + + + + Aligns control to the bands in the control bar + + + + + + + + + + + + + + + + + + + Indicates if bands are automatically sized and positioned for the control bar + + +

+ When AutoSize is False, the CheckBandsSizeAndVisibility method is called to Resize the bands in the control bar. When set to False, the inherited method is used. In addition, AutoSize determines if InvalidatePreferredSize is used when setting the value for the RowSize property. +

+ + + + + + + + + + + + + +

+ DrawingStyle is a TBandDrawingStyle property which indicates the fill style applied to the control bar. The default value for the property is dsNormal. Set DrawingStyle to dsGradient to draw the control bar using a gradient defined by the values in GradientDirection, GradientStartColor, and GradientEndColor. +

+ + + + + + + +

+ GradientDirection is a TGradientDirection property which controls the direction for a gradient drawn on the control bar. The default value for the property is gdVertical. Changing the value for the property causes the Invalidate method to be performed when BeginUpdate has not yet been called. +

+

+ GradientDirection is used when the DrawingStyle property contains the value dsGradient. Set the values in GradientStartColor and GradientEndColor to define the colors used to draw the gradient. +

+ + + + + + Specifies the initial color used in a gradient drawn on the control bar + + + + + + Specifies the ending color used in a gradient drawn on the control bar + + + + + + + +

+ Picture is a TPicture property which contains an optional image drawn on the client rectangle for the control bar. The image is tiled to fill the client area (if needed) immediately prior to drawing the visible bands for the control bar. +

+

+ Picture is used in the Paint method. +

+

+ PictureChanged is assigned as the OnChange event handler for the Picture property in the constructor for the class. +

+ + + + + + + +

+ RowSize is a TRowSize property which specifies the height for a row or band displayed on the control bar. The default value for the property is 26. +

+

+ Changing the value in the property causes the bands for the control bar to be resized and realigned. The Invalidate method will be called to repaint the control if BeginUpdate is not already active. +

+ + + + + + + + RowSnap is a Boolean property. + The default value for the property is True. + + + ? + + + + Event handler signalled when a control band is dropped in the control bar + + + + + + + + + + + + Event handler signalled when a control band is moved on the control bar + + + + + + + + + + + + + + + + + + + + + + + + + Implements a panel used to maintain and manage toolbars and toolbuttons + + +

+ TControlBar implements a panel used to maintain and manage toolbars and toolbuttons on a form. TControlBar is a TCustomControlBar descendant, and sets the visibility for properties from the ancestor class. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides a wrapper for the Frame3D method in TCanvas + +

+ Frame3D is a procedure which provides a wrapper for the Frame3D method in TCanvas. ACanvas is the TCanvas instance used to perform the Frame3D method with the settings in the specified arguments. +

+ + + + + + + Canvas used to perform the 3D drawing routine + + + Coordinates for the drawing operation + + + Pen color used to draw left and top lines in the frame + + + Pen color used to draw right and bottom lines in the frame + + + Width required for the 3D frame + + + + + Registers components for use in the Lazarus IDE + + +

+ Registers components for use in the Lazarus IDE. +

+

+ Adds the following components to the Standard tab: +

+
    +
  • TRadioGroup
    • +
  • TCheckGroup
    • +
  • TPanel
    • +
+

+ Adds the following components to the Additional tab: +

+
    +
  • TImage
    • +
  • TShape
    • +
  • TBevel
    • +
  • TPaintBox
    • +
  • TNotebook
    • +
  • TLabeledEdit
    • +
  • TSplitter
    • +
  • TTrayIcon
    • +
  • TControlBar
    • +
  • TFlowPanel
    • +
+

+ Adds the following components to the System tab: +

+
    +
  • TTimer
    • +
  • TIdleTimer
    • +
+

+ Registers the TPage component as a component with no icon in the component palette. +

+ + + + - Multi-PageControls - controls that offer a selection of alternative pages for display + Multi-PageControls - controls that offer a selection of alternative pages for display +

- Multi-PageControls - controls that offer a selection of alternative pages for display

-

A number of controls, found in Units ExtCtrls and ComCtrls, offer the ability to create multi-page forms with a series of Tabs along one edge that allow the user to select one of the Pages for display and interaction.

-

These include: TPageControl, TNoteBook, TTabControl and THeaderControl (the Header Control components have a very different structure and function). Icons for all of these exist on the Additional or Common Controls tabs of the Component Palette in the Lazarus IDE.

-

While the various components may look superficially similar, they differ in properties, inheritance, method of adding additional pages, behavior at run-time, methods for referencing pages and so on.

-

We have to be very clear when using the various properties, to distinguish between the word 'Tab' as referring to a Tab indicating an identifier for a page, and 'Tab' as referring to the TAB key on the standard keyboard. In common with most Lazarus components, it is possible to enable each control to be included in the TabOrder of TabStops for a Form, so that the component can be reached by repeated pressing of the TAB key, and we must not confuse this use of 'Tab' with the use to denote a Page.

-

The properties CanTab, TabStop and TabOrder refer to the use of the TAB key to navigate to the relevant control.

-

Properties such as Tabs, TabIndex, IndexOfTabAt(), TabIndexAtClientPos(), TabPosition, TabHeight, TabWidth, TabVisible, OnCloseTabClicked refer to the use for Page selection.

+ Multi-PageControls - controls that offer a selection of alternative pages for display. +

- TTabControl and - - - - - TPageControl are both descended from - - - - - TCustomNoteBook (which is in turn descended from - - - - - TWinControl) and have many inherited properties in common. - - - - - TPageControl has, in general, more advanced features and is probably intended to replace - - - - - TNoteBook.

-

The following table summarizes the main differences between the two components.

- + A number of controls, found in Units ExtCtrls and ComCtrls, offer the ability to create multi-page forms with a series of Tabs along one edge that allow the user to select one of the Pages for display and interaction. +

+

+ These include: TPageControl, TNoteBook, TTabControl and THeaderControl (the Header Control components have a very different structure and function). Icons for all of these exist on the Additional or Common Controls tabs of the Component Palette in the Lazarus IDE. +

+

+ While the various components may look superficially similar, they differ in properties, inheritance, method of adding additional pages, behavior at run-time, methods for referencing pages and so on. +

+

+ We have to be very clear when using the various properties, to distinguish between the word 'Tab' as referring to a Tab indicating an identifier for a page, and 'Tab' as referring to the TAB key on the standard keyboard. In common with most Lazarus components, it is possible to enable each control to be included in the TabOrder of TabStops for a Form, so that the component can be reached by repeated pressing of the TAB key, and we must not confuse this use of 'Tab' with the use to denote a Page. +

+

+ The properties CanTab, TabStop and TabOrder refer to the use of the TAB key to navigate to the relevant control. +

+

+ Properties such as Tabs, TabIndex, IndexOfTabAt(), TabIndexAtClientPos(), TabPosition, TabHeight, TabWidth, TabVisible, OnCloseTabClicked refer to the use for Page selection. +

+

+ TTabControl and TPageControl are both descended from TCustomNoteBook (which is in turn descended from TWinControl) and have many inherited properties in common. TPageControl has, in general, more advanced features and is probably intended to replace TNoteBook. +

+

+ The following table summarizes the main differences between the two components. +

+
@@ -5089,10 +7688,7 @@ will copy the contents of the Source class to the PageIndex @@ -5101,974 +7697,73 @@ will copy the contents of the Source class to the ShowTabs - + -
Property or method @@ -5072,10 +7674,7 @@ will copy the contents of the Source class to the String, TPage - TTabSheet, a more advanced version of - - - TPage + TTabSheet, a more advanced version of TPage
- ActivePageIndex, - - - TabIndex + ActivePageIndex, TabIndex
- TabVisible in - - - TTabSheet + TabVisible in TTabSheet
Hints No Hinting methods - ShowHint, - - - ParentShowHint + ShowHint, ParentShowHint
Font No Font properties - Font, - - - ParentFont + Font, ParentFont
Sensing position of Tab None - TabPosition, - - - OnGetSiteInfo + TabPosition, OnGetSiteInfo
OptionsPublished property Options, include nboShowCloseButtons, nboMultiLine + + Published property Options, include nboShowCloseButtons, nboMultiLine + + No published Options property, but inherits Options (public property) from TCustomNoteBook, so they could be set explicitly in code No published Options property, but inherits Options (public property) from TCustomNoteBook, so they could be set explicitly in code
-

The individual Pages in both of the above controls (descended from TCustomNoteBook) are separate and can have their own specific collections of widgets which appear only when the relevant Page is selected by its Tab.

-

In contrast, the TTabControl component (descended from TCustomTabControl) has only one display area (Protected property DisplayRect), but the image displayed in it is determined by which tab has been selected. Each Tab has an index value which is used to select the appropriate image from an indexed ImageList and display it in the Display Rectangle.

-

The properties of the Tabs in TTabControl are very configurable compared with those in the controls derived from TCustomNoteBook, allowing for instance the creation of multi-line captions, the placement of images on Tabs, the possibility of the Owner routine determining the drawing of the tab, the configuration of Tab size, the selection of multiple tabs. The trade-off is that the display area is restricted in what it can display, and is essentially confined to display of images.

-

To use any of the above controls, select them from the relevant tab on the IDE Component Palette and drop them on the form in the required position. Fill in as many relevant properties as you can in the Object Inspector.

-

To add Tabs or Pages to the controls, select the control with a left mouse click or by selecting from the Component menu in the Object Inspector, then right-click on the component to get a pop-up menu, whose first item will be 'Add Page' or 'Add Tab'.

-

The Tabs in TTabControl can be edited by selecting 'Tabs' in the Object Inspector, clicking on the ellipsis (...) and using the string editor that pops up.

-

The pages inTNoteBook or TPageControl can be edited by selecting the ActivePage in the Object Inspector and then editing the properties of the individual page.

- THeaderControl offers a widget that could be placed along the edge of a Panel or Form, allowing a highly customized mechanism for selection. However, there are no intrinsically associated display areas, and it is the developer's responsibility to supply an index associated with the selection from the - - - - - THeaderControl and determining what action is to occur or what is to be displayed in any attached Panel or Form.

-

When the control is first selected from the Component Palette and placed on a Form, it consists of an unadorned rectangle. However, selecting the control and right-clicking (or selecting the 'Sections' property in the Object Inspector) gives access to a Sections editor (a StringList editor) and Sections can be added to the control. The sections are separated by vertical lines, and each section can have a string inserted as a label, associated with an Index value. The Sections can be rearranged, re-ordered, or be individually painted.

-

In a typical application a THeaderControl and a TPanel or TForm would be docked together, and code would be written to find which Section of the Header had been selected, then use its index to control the display in the other docked control.

+ The individual Pages in both of the above controls (descended from TCustomNoteBook) are separate and can have their own specific collections of widgets which appear only when the relevant Page is selected by its Tab. +

+

+ In contrast, the TTabControl component (descended from TCustomTabControl) has only one display area (Protected property DisplayRect), but the image displayed in it is determined by which tab has been selected. Each Tab has an index value which is used to select the appropriate image from an indexed ImageList and display it in the Display Rectangle. +

+

+ The properties of the Tabs in TTabControl are very configurable compared with those in the controls derived from TCustomNoteBook, allowing for instance the creation of multi-line captions, the placement of images on Tabs, the possibility of the Owner routine determining the drawing of the tab, the configuration of Tab size, the selection of multiple tabs. The trade-off is that the display area is restricted in what it can display, and is essentially confined to display of images. +

+

+ To use any of the above controls, select them from the relevant tab on the IDE Component Palette and drop them on the form in the required position. Fill in as many relevant properties as you can in the Object Inspector. +

+

+ To add Tabs or Pages to the controls, select the control with a left mouse click or by selecting from the Component menu in the Object Inspector, then right-click on the component to get a pop-up menu, whose first item will be 'Add Page' or 'Add Tab'. +

+

+ The Tabs in TTabControl can be edited by selecting 'Tabs' in the Object Inspector, clicking on the ellipsis (...) and using the string editor that pops up. +

+

+ The pages inTNoteBook or TPageControl can be edited by selecting the ActivePage in the Object Inspector and then editing the properties of the individual page. +

+

+ THeaderControl offers a widget that could be placed along the edge of a Panel or Form, allowing a highly customized mechanism for selection. However, there are no intrinsically associated display areas, and it is the developer's responsibility to supply an index associated with the selection from the THeaderControl and determining what action is to occur or what is to be displayed in any attached Panel or Form. +

+

+ When the control is first selected from the Component Palette and placed on a Form, it consists of an unadorned rectangle. However, selecting the control and right-clicking (or selecting the 'Sections' property in the Object Inspector) gives access to a Sections editor (a StringList editor) and Sections can be added to the control. The sections are separated by vertical lines, and each section can have a string inserted as a label, associated with an Index value. The Sections can be rearranged, re-ordered, or be individually painted. +

+

+ In a typical application a THeaderControl and a TPanel or TForm would be docked together, and code would be written to find which Section of the Header had been selected, then use its index to control the display in the other docked control. +

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - SetItems - specifies the strings that form the Items of the group - - - - - - - - - - - - CheckItemIndexChanged - find out if the index for an item has changes - - - - - - - - AutoFill - whether responses to Items should automatically be filled in - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Operating system Handle for the Tray Icon - - - - - - - - - - - - - - - - - - - InternalUpdate - updates any pending changes - - The behavior of this method depends on the widgetset and it was added to provide an way to update items which either cannot be updated automatically upon change or would be too inefficient to be updated on each change. One example of this is the tray icon menu under LCL-Carbon. It is not automatically updated when changes are done to it's associated LCL TPopUpMenu, but changes are updated when InternalUpdate is called. This happens because the tray icon menus are Cocoa menus which don't match the Carbon menus from LCL-Carbon. Similar things happen in various other widgetsets, so InternalUpdate can be expected to update the menu and/or icon of the tray icon, if this is necessary. If such an update is not required, for example because it is automatically updated on each change, then InternalUpdate will simply do nothing, so it is always a safe function to call, regardless of the widgetset. - - - - - - - - - - - - - OnPictureChanged - event handler for a change in the picture - - - - - - - - - - - TBalloonFlags enumerated type for flags on Tray Icon balloons - - - - - - - - - - - - - - - - - - - - TCustomIdleTimer - base class for TIdleTimer - - - - - SetAutoEnabled puts the supplied boolean value into the AutoEnabled property and updates handlers - - - - DoOnIdle - action to be taken if the timer is idle - - - - DoOnIdleEnd -action to be taken at the end of an idle period - - - - DoOnUserInput - action to be taken when user input is detected - - - - TComponent.Loaded - - - Loaded - calls inherited method and updates Handlers - - - - Create - constructor for TCustomIdleTimer: calls inherited Create and initializes some local event variables - - - - Destroy - destructor for TCustomIdleTimer: calls inherited Destroy after setting the AutoEnabled property False - - - - AutoEnabled - if True, Timer is automatically enabled - - - - AutoStartEvent - the event that triggers autostart (either idle time-out or user input) - AutoStartEvent defines, when Enabled is automatically set to true. This -is one of the following events: -
  • on application becomes idle
  • on application stops being idle (e.g. user input or some timer fired)
  • user input, e.g. key press, mouse move
    • -
- - - - AutoEndEvent - the event that stops the timer by setting Enabled to false - AutoEndEvent defines, when Enabled is automatically set to false. This -is one of the following events: -
  • on application becomes idle
  • on application stops being idle (e.g. user input or some timer fired)
  • user input, e.g. key press, mouse move
    • -
- - - - - FireOnIdle - boolean property determining whether the timer should fire when idle - - - - - - - - Container with flow layout of controls placed in it. - -

Use TFloatPanel if you need a container with float layout. - The Anchors and Align properties of child controls are ignored. -

The floating direction is determined with - FlowStyle property.

- - - Determine if controls in TCustomFlowPanel are wrapped. - Use ControlList to set extra options of flow panel controls. - Use FlowStyle to determine the flow direction of the flow panel layout. - The associated control to the flow panel control item.Don't set the Control property manually. It is used internally by the designer. - Determines the wrap policy after this control.Valid only if TFlowPanel.AutoWrap = True. - The base class for TFlowPanel - - - Use FlowLayout to set the layout (alignment) for the non-flow coordinate. Default: tlTopIn case of horizontal/vertical flow style: -tlTop: top/left alignment in row/column -tlCenter: center -tlBottom: bottom/right - +