[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] | Reference for unit 'EditBtn' (#lcl)

# TCustomEditButton

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button

## Declaration

Source position: editbtn.pas line 40

`type TCustomEditButton = class(TCustomMaskEdit)`
`protected`
`function GetReadOnly; override;` |  | GetReadOnly - returns the boolean ReadOnly status
`function GetDefaultGlyph; virtual;` |  | GetDefaultGlyph - find the default glyph for the SpeedButton
`function GetDefaultGlyphName; virtual;` |  | GetDefaultGlyphName - find the name for the default glyph for the SpeedButton
`procedure SetParent(); override;` |  | Find who the parents are and store the information
`procedure SetReadOnly(); override;` |  | SetReadOnly - specifies whether ReadOnly applies
`procedure DoPositionButton; virtual;` |  | DoPositionButton - perform the code to place the button in position
`procedure DoButtonClick(); virtual;` |  | DoButtonClick - software emulation of the OnButtonClick event
`procedure Loaded; override;` |  |
`procedure Notification(); override;` |  |
`procedure CMVisibleChanged(); message;` |  | CMVisibleChanged - control message when Visible property is changed
`procedure CMEnabledChanged(); message;` |  | CMEnabledChanged - control message for a change in the Enabled property
`property ButtonWidth: Integer; [rw]` |  | ButtonWidth - the width of the SpeedButton attached to the Edit Box
`property DirectInput: Boolean; [rw]` |  | DirectInput - if True, direct data input to the Edit Box is permitted
`property Glyph: TBitmap; [rw]` |  | Glyph - the small graphic image on the SpeedButton, which ought to indicate its function
`property NumGlyphs: Integer; [rw]` |  | NumGlyphs - the number of available glyphs
`property OnButtonClick: TNotifyEvent; [rw]` |  | OnButtonClick - event handler for a mouse click on the SpeedButton
`property Button: TSpeedButton; [r]` |  | Button - the SpeedButton that is attached to the Edit Box
`property ButtonHint: TTranslateString; [rw]` |  | ButtonHint - the hint that pops up when the mouse hovers over the button
`public`
`constructor Create(); override;` |  | Create - constructor for TCustomEditButton: calls inherited Create then sets some defaults and initialises some variables
`destructor Destroy; override;` |  | Destroy - destructor for TWinControl and derived classes. Removes handles and docked controls, frees resources, then calls inherited Destroy
`property Flat: Boolean; [rw]` |  | Flat - if True, SpeedButton appears flat rather than three-dimensional
`property ButtonOnlyWhenFocused: Boolean; [rw]` |  | ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control
`end;`

## Inheritance

`TCustomEditButton` |  | TCustomEditButton - base class for TEditButton, an Edit Box with attached Speed Button
`TCustomMaskEdit` |  | TCustomMaskEdit - base class for TMaskEdit, an Edit box with characters masked out to avoid unauthorised reading
`TCustomEdit`
?
`TObject`

The latest version of this document can be found at lazarus-ccr.sourceforge.net.