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

TDirectoryEdit

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

TDirectoryEdit - an EditBox to hold a directory name, with an attached SpeedButton that summons a Directory Open dialog.

Declaration

Source position: editbtn.pas line 471

type TDirectoryEdit = class(TCustomEditButton)

protected

  function GetDefaultGlyphName; override;

  

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

  function CreateDialog; virtual;

  

Creates and configures the dialog for the control.

  function GetDialogResult(); virtual;

  

Gets the result from the specified dialog.

  procedure ButtonClick; override;

  

Implements the button handler for the Button in the control.

public

  property AutoSelected: Boolean;

  

Set to True when the text selection was made automatically.

  constructor Create(); override;

  

Constructor for the class instance.

  procedure RunDialog; virtual;

  

Executes the dialog for the control and stores the return value.

published

  property Directory: string; [rw]

  

The Directory selected by the dialog.

  property RootDir: string; [rw]

  

The root directory for file system navigation in the control.

  property OnAcceptDirectory: TAcceptFileNameEvent; [rw]

  

OnAcceptDirectory - event handler for accepting the name of a directory.

  property DialogTitle: string; [rw]

  

DialogTitle - the title that appears on the Select Directory dialog.

  property DialogOptions: TOpenOptions; [rw]

  

Contains the options enabled for the Open dialog displayed by the control.

  property ShowHidden: Boolean; [rw]

  

ShowHidden - if True, display names of hidden directories.

  property ButtonCaption: TCaption;

  

Text displayed on the button for the control.

  property ButtonCursor: TCursor;

  

Cursor shape displayed when the mouse hovers over the button for the control.

  property ButtonHint: TTranslateString;

  

Hint displayed when the mouse hovers over the button for the control.

  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;

  

Contains the minimum and maximum Width and Height 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 on its Parent control.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoSize: Boolean;

  

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

  property AutoSelect: Boolean;

  

Indicates if the text in the control is automatically selected when focus is received.

  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 the border style displayed around the control.

  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;

  

Indicates whether the BiDiMode settings in the Parent control are used.

  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 Hint display for the control.

  property TabOrder: TTabOrder;

  

Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key.

  property Spacing: Integer;

  

Spacing used between the BaseEditor and the Buddy controls.

  property TabStop: Boolean;

  

Allows the user to navigate to / from the control by pressing the Tab or Shift+Tab keys.

  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 drag 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;

  

Event handler signalled when a key up event has occurred for the control.

  property OnMouseDown: TMouseEvent;

  

Event handler signalled when a mouse down event is handled for the control.

  property OnMouseEnter: TNotifyEvent;

  

Event handler signalled when the mouse pointer has entered the control.

  property OnMouseLeave: TNotifyEvent;

  

Event handler signalled when the mouse pointer has left the control.

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler signalled when a mouse up event is handled for the control.

  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

TDirectoryEdit

  

TDirectoryEdit - an EditBox to hold a directory name, with an attached SpeedButton that summons a Directory Open 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

  

Implements a windowed control 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

See also

TSelectDirectoryDialog

  

Select Directory Dialog.