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

TCalcEdit

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

Implements an numeric edit control with a button to display a calculator dialog.

Declaration

Source position: editbtn.pas line 795

type TCalcEdit = class(TCustomEditButton)

protected

  FCalcDialog: TForm;

  

FCalcDialog - local variable holding the Calculator Dialog for use with this class.

  function GetDefaultGlyphName; override;

  

GetDefaultGlyphName finds the name of the default glyph used for the Button.

  procedure ButtonClick; override;

  

Performs actions needed when the button for the control is clicked.

public

  constructor Create(); override;

  

Constructor for the class instance.

  procedure RunDialog; virtual;

  

RunDialog - perform the function of the dialog.

  property AutoSelected: Boolean;

  

Indicates if the current text selection was performed automatically.

published

  property CalculatorLayout: TCalculatorLayout; [rw]

  

CalculatorLayout - normal or simple.

  property AsFloat: Double; [rw]

  

AsFloat - holds the result of the calculation as a floating-point (double precision) number.

  property AsInteger: Integer; [rw]

  

AsInteger - holds the result of the calculation as an Integer.

  property OnAcceptValue: TAcceptValueEvent; [rw]

  

OnAcceptValue - event handler for accepting the result of the calculation.

  property DialogTitle: string; [rws]

  

DialogTitle - the caption to be used for the dialog.

  property ButtonCaption: TCaption;

  

Contains the caption used for the Button on the grouped edit control.

  property ButtonCursor: TCursor;

  

Cursor shape displayed when the mouse hovers over the Button in the control.

  property ButtonHint: TTranslateString;

  

ButtonHint is the hint that pops up when the mouse hovers over the button.

  property ButtonOnlyWhenFocused: Boolean;

  

ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control.

  property ButtonWidth: Integer;

  

ButtonWidth is the width for the TSpeedButton used in the grouped edit control.

  property Constraints: TSizeConstraints;

  

The minimum and maximum Width and Height for the control.

  property DialogPosition: TPosition; [rw]

  

Position where the calculator dialog is displayed.

  property DialogTop: Integer; [rw]

  

Vertical coordinate for the dialog displayed for the control.

  property DialogLeft: Integer; [rw]

  

Horizontal coordinate for the dialog displayed for the control.

  property DirectInput: Boolean;

  

Indicates if text can be entered directly into the BaseEditor control.

  property Glyph: TBitmap;

  

Glyph - the small graphic image on the SpeedButton, which ought to indicate its function.

  property NumGlyphs: Integer;

  

NumGlyphs - the number of available glyphs.

  property Images: TCustomImageList;

  

Contains the Images that can be displayed on the Button for the grouped edit control.

  property ImageIndex: TImageIndex;

  

Ordinal position in Images for the bitmap displayed on the Button control.

  property ImageWidth: Integer;

  

Specifies the width of the image displayed on the Button control.

  property Flat: Boolean;

  

Flat - if True, SpeedButton appears flat rather than three-dimensional.

  property FocusOnButtonClick: Boolean;

  

Indicates if the focus is changed to the Edit control after the Button is clicked.

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property BidiMode: TBiDiMode;

  

Customization (of text controls) in bidirectional reading environments.

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BorderStyle: TBorderStyle;

  

Indicates if borders are displayed around the control.

  property AutoSize: Boolean;

  

Allows automatic adjustment of the size for the control, according to its content.

  property AutoSelect: Boolean;

  

Enables auto-selection of text when focused.

  property Color: TColor;

  

The background color of the control.

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property Font: TFont;

  

The font to be used for text display in this control.

  property Layout: TLeftRight;

  

Controls the alignment of the edit control and its associate.

  property MaxLength: Integer;

  

The maximum length of the value entered in Text, or 0 (zero) for unlimited length.

  property ParentBidiMode: Boolean;

  

Allows to use the BiDiMode settings in the Parent control. Default is true.

  property ParentColor: Boolean;

  

Use the Color from the Parent control, when enabled.

  property ParentFont: Boolean;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property ParentShowHint: Boolean;

  

If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.

  property PopupMenu: TPopupMenu;

  

A context-sensitive menu that pops up when the right mouse button is clicked over this control.

  property ReadOnly: Boolean;

  

Indicates if the user is prevented from changing the value for the Text in the control.

  property ShowHint: Boolean;

  

Enables the Hint display.

  property Spacing: Integer;

  

Specifies the number of pixels reserved between the Edit and Button controls when Button is visible.

  property TabOrder: TTabOrder;

  

Determines the sequence of control navigation when the user presses the Tab key.

  property TabStop: Boolean;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property Visible: Boolean;

  

Allows the control, and all of its children, to be displayed or hidden.

  property OnButtonClick: TNotifyEvent;

  

OnButtonClick - event handler for a mouse click on the SpeedButton.

  property OnChange: TNotifyEvent;

  

Event handler signalled when the text for the control is changed.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnContextPopup: TContextPopupEvent;

  

Invoked when a context-sensitive pop-up menu is requested.

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDragDrop: TDragDropEvent;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEditingDone: TNotifyEvent;

  

Event handler signalled when editing is done.

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

Handler for control loosing the focus; This is a good place for checking the finished user input.

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  

Event handler for mouse entering the area of the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler for mouse leaving the area of the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  

Event handler for mouse wheel turned.

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  

Event handler for downward movement of mouse wheel.

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  

Event handler for upward movement of the mouse wheel.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property Text: TCaption;

  

The character string associated with the control.

  property TextHint: TTranslateString;

  

Contains the hint text displayed for the grouped edit control.

end;

Inheritance

TCalcEdit

  

Implements an numeric edit control with a button to display a calculator dialog.

|

TCustomEditButton

  

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

|

TCustomAbstractGroupedEdit

  

Implements a grouped edit control.

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components which have an associated widget.

|

TComponent

?

TObject

Description

TCalcEdit is a TCustomEditButton descendant which implements a numeric edit control with a button to display a calculator dialog. It contains properties to configure the button and the calculator dialog. Other properties are provided to access the numeric value as an Integer or a floating point (Double) data type. Use the RunDIalog method to display the calculator dialog and get its return value.

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