TTimeEdit class

In unit EditBtn

Implements a control used to edit time values.

Declaration

pascal

TTimeEdit = class(TCustomEditButton)

Inheritance

Description

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 dialog allows selection of Hour and Minute values from a drop-down list. Enable DirectInput to enter a time value that includes additional time parts (like Seconds and Milliseconds).

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

Use TimeFormat and TimeSeparator to override the default format settings used to generate the display Text for the time edit control.

Modified in LCL version 4.0 to include additional properties and methods.

Properties

`Time`	public	Represents the time value in the control.
`Button`	public	TSpeedButton instance used on the edit control.
`DroppedDown`	public	Indicates if the popup dialog for the control is visible.
`DefaultNow`	published	Indicates the current time is used for an empty time value.
`ReadOnly`	published	Indicates whether the value for the control can be changed.
`ButtonCaption`	published	Contains the caption used for the Button on the edit control.
`ButtonCursor`	published	Cursor shape displayed when the mouse hovers over the Button in the control.
`ButtonHint`	published	Text displayed in the pop-up hint window when the mouse hovers over the button.
`ButtonOnlyWhenFocused`	published	ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control.
`ButtonWidth`	published	Width for the TSpeedButton on the edit control.
`Action`	published	The Action associated with the control.
`Align`	published	Specifies the placement of the control on its Parent control.
`Alignment`	published	Indicates the text alignment used for the control value.
`Anchors`	published	The set of anchor definitions for this control.
`AutoSize`	published	Allows automatic adjustment of the size for the control, according to its content.
`AutoSelect`	published	Indicates if the text in the control is automatically selected when focus is received.
`BidiMode`	published	Indicates whether text controls use in bi-directional reading.
`BorderSpacing`	published	Determines the inner and outer border spacing for this control.
`BorderStyle`	published	Indicates the border style displayed around the control.
`CharCase`	published	Controls the case conversion used for a value entered in the control.
`Color`	published	The background color for the control.
`Constraints`	published	Contains the minimum and maximum Width and Height for the control.
`DirectInput`	published	Indicates if text can be entered directly into the BaseEditor control.
`Glyph`	published	Glyph - the small graphic image on the SpeedButton, which ought to indicate its function.
`NumGlyphs`	published	NumGlyphs - the number of available glyphs.
`Images`	published	Contains the Images that can be displayed on the Button for the grouped edit control.
`ImageIndex`	published	Ordinal position in Images for the bitmap displayed on the Button control.
`ImageWidth`	published	Specifies the width of the image displayed on the Button control.
`DragMode`	published	Determines how a drag operation is started for the control.
`EchoMode`	published	Indicates if characters entered in the control value are hidden, displayed, or obscured.
`Enabled`	published	Determines whether the control responds to mouse or keyboard input.
`Flat`	published	When True, the SpeedButton has a flat appearance rather than a three-dimensional one.
`FocusOnButtonClick`	published	Indicates if the focus is changed to the Edit control after the Button is clicked.
`Font`	published	The font to be used for text display in this control.
`MaxLength`	published	Maximum number of characters allowed in the editor for the control.
`ParentBidiMode`	published	Indicates whether the BiDiMode settings in the Parent control are used.
`ParentColor`	published	Use the Color from the Parent control, when enabled.
`ParentFont`	published	Indicates if the Font from the Parent control is used in the control.
`ParentShowHint`	published	If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True.
`PopupMenu`	published	PopupMenu for the control.
`ShowHint`	published	Enables Hint display for the control.
`SimpleLayout`	published	Indicates if the dialog uses a layout with 30 minute intervals between values.
`Spacing`	published	Specifies the number of pixels reserved between the Edit and Button controls when Button is visible.
`TabStop`	published	Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.
`TabOrder`	published	Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.
`TimeAMString`	published	Specifies the value displayed for a 12-hour time value prior to midday (Noon).
`TimeFormat`	published	Specifies the time format used to generate the display Text for the time edit control.
`TimeSeparator`	published	Specifies the separator character used to delimit time parts in the format settings applied to the control.
`TimePMString`	published	Specifies the value displayed for a 12-hour time value after midday (Noon).
`Visible`	published	Allows the control, and all of its children, to be displayed or hidden.
`Text`	published	Contains the formatted text used to represent the Time value for the control.
`TextHint`	published	Default hint text shown when the Text property is empty for the grouped edit control.

Methods

`GetDefaultGlyphName`	protected	Gets the name of the default glyph resource used for the Button on the control.
`Is12HourMode`	protected	Indicates whether the effective TimeFormat for the control reflects 12-hour clock values with AM and PM designations.
`UsedFormatSettings`	protected	Gets the effective format settings used to format the value for the time edit control.
`UsedTimeAMString`	protected	Gets the suffix used for an ante meridiem (before midday) time value in the control.
`UsedTimeFormat`	protected	Gets the effective short time format used for the Time value in the control.
`UsedTimePMString`	protected	Gets the suffix used for a post meridiem (after midday) time value in the control.
`UsedTimeSeparator`	protected	Gets the effective time separator character used in the short time format settings.
`ButtonClick`	protected	Performs actions needed when the Button for the control is clicked.
`EditDblClick`	protected	Implements the OnDblClick event handler for the Edit in the control.
`EditEditingDone`	protected	Implements the OnEditingDone event handler for the Edit in the control.
`Create`	public	Constructor for the class instance.
`ValidTimeFormat`	public	Indicates whether the specified value is a valid time format for the TTimeEdit control.

Events

`OnAcceptTime`	published	Event handler signalled to validate and accept/reject the time value for the control.
`OnCustomTime`	published	Event handler signalled to get an arbitrary time value for the control.
`OnButtonClick`	published	OnButtonClick - event handler for a mouse click on the SpeedButton.
`OnChange`	published	Event handler signalled when the value for the control is changed.
`OnChangeBounds`	published	Event handler signalled when the Bounds for the control have been changed.
`OnClick`	published	Notification handler for mouse clicks.
`OnDblClick`	published	Event handler signalled when a mouse double click occurs in the control.
`OnContextPopup`	published	Invoked when a context-sensitive pop-up menu is requested.
`OnEditingDone`	published	Event handler signalled when editing is completed for the control.
`OnEnter`	published	Event handler signalled when the control receives focus.
`OnExit`	published	Event handler signalled when the control loses focus.
`OnKeyDown`	published	Event handler signalled for key down keyboard events.
`OnKeyPress`	published	Event handler signalled for character data entered by the user.
`OnKeyUp`	published	Event handler signalled when a key up event has occurred for the control.
`OnMouseDown`	published	Event handler signalled when a mouse down event is handled for the control.
`OnMouseEnter`	published	Event handler signalled when the mouse pointer has entered the control.
`OnMouseLeave`	published	Event handler signalled when the mouse pointer has left the control.
`OnMouseMove`	published	Event handler signalled when the mouse pointer is moved in the control.
`OnMouseUp`	published	Event handler signalled when a mouse up event is handled for the control.
`OnMouseWheel`	published	Event handler for mouse wheel turned.
`OnMouseWheelDown`	published	Event handler signalled for a downward movement of the mouse wheel.
`OnMouseWheelUp`	published	Event handler signalled for an upward movement of the mouse wheel.
`OnResize`	published	Notification handler for a resize of the control.
`OnUTF8KeyPress`	published	Handler for a character entered by the user.