TCustomAbstractGroupedEdit class

In unit GroupedEdit

Implements a grouped edit control.

Declaration

pascal

TCustomAbstractGroupedEdit = class(TCustomControl)

Inheritance

Descends from it: TAbstractGroupedEdit TCustomEditButton

Description

TCustomAbstractGroupedEdit is a TCustomControl descendant which implements a grouped edit control. TCustomAbstractGroupedEdit is composed of a TGEEdit control that provides an editor for the control value, and a related TControl descendant.

TCustomAbstractGroupedEdit basically acts as a container for the grouped controls, and ensures that Alignment and Anchoring are performed. TCustomAbstractGroupedEdit forwards relevant methods and properties to the BaseEditor or Buddy members, and receives event notifications from both.

Derived classes should implement their own BaseEditor and Buddy properties so that they will have the correct class types.

Properties

`AutoSelect`	protected	Indicates if the text in the control is automatically selected when focus is received.
`AutoSelected`	protected	Indicates if the current text selection was performed automatically.
`Buddy`	protected	Represents the associated TControl instance in the grouped edit control.
`BuddyCaption`	protected	Caption used for the Buddy control.
`BuddyCursor`	protected	Cursor shape used for the Buddy control.
`BuddyHint`	protected	Hint displayed for the Buddy control.
`BuddyWidth`	protected	Width for the Buddy control.
`DirectInput`	protected	Indicates if text can be entered directly into the BaseEditor control.
`BaseEditor`	protected	Represents the control used as the editor for the value in the grouped edit control.
`EditMask`	protected	Contains the masking characters used in the editor for the control.
`EditText`	protected	Contains the value entered in the control including masking characters.
`FocusOnBuddyClick`	protected	Determines if the control receives focus when the Buddy control is clicked.
`IsMasked`	protected	Indicates if an edit mask is in use in the BaseEditor in the grouped edit control.
`Layout`	protected	Controls the alignment of the edit control and its associate.
`Spacing`	protected	Spacing used between the BaseEditor and the Buddy controls.
`Autosize`	public	Allows automatic adjustment of the size for the control, according to its content.
`AutoSizeHeightIsEditHeight`	public	Indicates if the height for BaseEditor is used as the height for the control when auto-sizing.
`Alignment`	public	Indicates the text alignment used for the control value.
`CanUndo`	public	Indicates if the Undo method can used to revert changes to the control value.
`CaretPos`	public	Position of the editing caret in the control.
`CharCase`	public	Controls the case conversion used for a value entered in the control.
`Color`	public	Background color for the BaseEditor on the control.
`ParentColor`	public	Indicates if the color in the Parent control is used.
`EchoMode`	public	Indicates if characters entered in the control value are hidden, displayed, or obscured.
`HideSelection`	public	Hides the current text selection when the control loses focus.
`MaxLength`	public	Maximum number of characters allowed in the editor for the control.
`Modified`	public	Indicates if the value for the control has been changed by the user.
`NumbersOnly`	public	Indicates if the edit control accepts numeric values only.
`PasswordChar`	public	Contains the character displayed to obfuscate the text on the control when a value is entered or displayed.
`PopupMenu`	public	PopupMenu for the control.
`ReadOnly`	public	Indicates whether the value for the control can be changed.
`SelLength`	public	Number of characters in the current selection for the control.
`SelStart`	public	Starting position for the current selection in the control.
`SelText`	public	Returns the selected text in the control.
`TabStop`	public	Indicates if the control can be reached using Tab navigation.
`Text`	public	String with the text or caption for the control.
`TextHint`	public	Default hint text shown when the Text property is empty for the grouped edit control.

Methods

`WSRegisterClass`	protected	Registers the widget set class used to create new instances of the grouped edit.
`CalculatePreferredSize`	protected	Calculates the preferred size for the control with optional space reserved by theme services.
`CreateBuddy`	protected	Creates the TControl instance assigned to the Buddy property.
`CreateEditor`	protected	Creates the TGEEdit instance used in the BaseEditor property.
`FocusAndMaybeSelectAll`	protected	Gives focus to the control, and optionally selects text in its editor.
`GetEditorClassType`	protected	Gets the class reference used to create the BaseEditor for the control.
`GetBuddyClassType`	protected	Gets the class reference used to create the Buddy for the control.
`GetControlClassDefaultSize`	protected	Gets the default size for new instances of the control.
`SetDirectInput`	protected	Sets the value for the DirectInput property.
`RealGetText`	protected	Gets the value for the text in the control.
`RealSetText`	protected	Sets the value for the text in the control.
`GetEditPopupMenu`	protected	Gets the popup menu for the BaseEditor in the control.
`GetBuddyCaption`	protected	Gets the Caption used in the Buddy property.
`GetBuddyCursor`	protected	Gets the value for the BuddyCursor property.
`GetBuddyHint`	protected	Gets the value for the BuddyHint property.
`GetBuddyWidth`	protected	Gets the value for the BuddyWidth property.
`GetBuddyVisible`	protected	Gets the Visible property for the Buddy control.
`SetBuddyCaption`	protected	Sets the Caption used in the Buddy property.
`SetBuddyCursor`	protected	Sets the cursor shape used in the Buddy property.
`SetBuddyHint`	protected	Sets the Hint displayed for the Buddy property.
`SetBuddyWidth`	protected	Sets the Width used for the Buddy property.
`SetBuddyVisible`	protected	Sets the value for the Visible property in the Buddy control.
`BuddyClick`	protected	Performs actions needed when the Buddy control is clicked.
`DoEnter`	protected	Performs actions needed when the control is entered.
`EditChange`	protected	Signals the OnEditChange event handler, when assigned.
`EditClick`	protected	Signals the internal OnEditClick event handler, when assigned.
`EditContextPopup`	protected	Signals the OnContextPopup event handler (when assigned).
`EditDblClick`	protected	Signals the OnDblClick event handler (when assigned).
`EditDragDrop`	protected	Signals the OnDragDrop event handler (when assigned).
`EditDragOver`	protected	Signals the OnDragOver event handler (when assigned).
`EditEditingDone`	protected	Signals the OnEditEditingDone event handler (when assigned).
`EditEndDrag`	protected	Signals the OnEditEndDrag event handler (when assigned).
`EditEnter`	protected	Signals the OnEnter event handler (when assigned).
`EditExit`	protected	Signals the OnExit event handler (when assigned).
`EditKeyDown`	protected	Signals the OnKeyDown event handler (when assigned).
`EditKeyPress`	protected	Signals the OnKeyPress event handler (when assigned).
`EditKeyUp`	protected	Signals the OnKeyUp event handler (when assigned).
`EditMouseDown`	protected	Signals the OnMouseDown event handler (when assigned).
`EditMouseUp`	protected	Signals the OnMouseUp event handler (when assigned).
`EditMouseEnter`	protected	Signals the OnMouseEnter event handler (when assigned).
`EditMouseLeave`	protected	Signals the OnMouseLeave event handler (when assigned).
`EditMouseMove`	protected	Signals the OnMouseMove event handler (when assigned).
`EditMouseWheel`	protected	Signals the OnMouseWheel event handler (when assigned).
`EditMouseWheelUp`	protected	Signals the OnMouseWheelUp event handler (when assigned).
`EditMouseWheelDown`	protected	Signals the OnMouseWheelDown event handler (when assigned).
`EditUtf8KeyPress`	protected	Signals the OnUtf8KeyPress event handler (when assigned).
`EditStartDrag`	protected	Signals the OnStartDrag event handler (when assigned).
`UpdateSpacing`	protected	Updates border spacing in BaseEditor for the Layout and visibility of the Buddy control.
`CheckCursor`	protected	Forwards a CheckCursor method call to the BaseEditor for the control.
`CMParentColorChanged`	protected	Handles the control message received when the ParentColor property is changed.
`EditCanModify`	protected	Indicates if BaseEditor can be modified.
`GetSel`	protected	Gets the offsets for the current text selection in the control.
`GetSpacing`	protected	Gets the value for the Spacing property.
`SetSel`	protected	Sets the current text selection in the control.
`Loaded`	protected	Performs actions when the control has finished loading in the LCL streaming mechanism.
`Reset`	protected	Forwards a Reset method call to the BaseEditor in the control.
`SetAutoSize`	protected	Sets the value for the AutoSize property.
`SetColor`	protected	Sets the value for the Color property.
`SetCursor`	protected	Sets the value for the Cursor property.
`ShouldAutoAdjust`	protected	Indicates if the height or width is affected during auto-adjust.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`SetFocus`	public	Sets the focus to the editor in the control.
`Focused`	public	Performs actions needed when the control receives focus.
`Clear`	public	Removes the text content in the control.
`ClearSelection`	public	Clears the content for the current selection in the control.
`CopyToClipboard`	public	Copies the content in the control to the clipboard.
`CutToClipboard`	public	Copies content in the control to the clipboard, and removes it from the control.
`PasteFromClipboard`	public	Pastes content into the control from the clipboard.
`SelectAll`	public	Selects all of the content in the control.
`Undo`	public	Reverses the last edit performed on the control value.
`ValidateEdit`	public	Performs actions needed to validate the value for the control.

Events

`OnBuddyClick`	protected	Event handler signalled when the Buddy control is clicked.
`OnChange`	public	Event handler signalled when the value for the control is changed.
`OnClick`	public	Notification handler for mouse clicks.
`OnContextPopup`	public	Invoked when a context-sensitive pop-up menu is requested.
`OnDblClick`	public	Event handler signalled when a mouse double click occurs in the control.
`OnDragDrop`	public	Event handler signalled when an object is dropped onto the control.
`OnDragOver`	public	Event handler signalled when a control is dragged over the control instance.
`OnEditingDone`	public	Event handler signalled when editing is completed for the control.
`OnEndDrag`	public	Event handler signalled for the end of a drag-drop operation.
`OnEnter`	public	Event handler signalled when the control receives focus.
`OnExit`	public	Event handler signalled when the control loses focus.
`OnMouseDown`	public	Event handler signalled when a mouse down event is handled for the control.
`OnKeyPress`	public	Event handler signalled for character data entered by the user.
`OnKeyDown`	public	Event handler signalled for key down keyboard events.
`OnKeyUp`	public	Event handler signalled when a key up event has occurred for the control.
`OnMouseEnter`	public	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	public	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	public	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseWheel`	public	Event handler for mouse wheel turned.
`OnMouseWheelUp`	public	Event handler signalled for an upward movement of the mouse wheel.
`OnMouseWheelDown`	public	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseUp`	public	Event handler signalled when a mouse up event is handled for the control.
`OnStartDrag`	public	Event handler signalled for the start of a dragging operation.
`OnUtf8KeyPress`	public	Event handler signalled for UTF-8 key press events.