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

TFileListBox

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

Implements a file selection list box control.

Declaration

Source position: filectrl.pp line 85

type TFileListBox = class(TCustomFileListBox)

published

  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 Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimum and maximum Width and Height for the control.

  property Directory: string;

  

The Directory or Folder in which the file is located.

  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 ExtendedSelect: Boolean;

  

True when a contiguous range of items can be selected by a Shift+Click. Default is True.

  property FileType: TFileType;

  

FileType - the type or attributes of the selected file.

  property Font: TFont;

  

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

  property IntegralHeight: Boolean;

  

Not implemented: shrink the Height of the widget, so that it only shows fully visible rows.

  property ItemHeight: Integer;

  

The default height for an item displayed in the list.

  property Mask: string;

  

Contains the mask for files selected for the control.

  property MultiSelect: Boolean;

  

Allows selection of more than one item from the list.

  property OnChange: TNotifyEvent;

  

Event handler signalled when the selected file in the list box control is changed.

  property OnChangeBounds: TNotifyEvent;

  

Event handler for a change of the Bounds of the control.

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  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 OnDrawItem: TDrawItemEvent;

  

Handler for painting of a list item in owner-draw mode.

  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 OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  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 OnResize: TNotifyEvent;

  

Notification handler for a resize of the control.

  property OnSelectionChange: TSelectionChangeEvent;

  

Handler invoked when an item is selected in the control.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  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 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 ParentFont: Boolean;

  

If true, the Font of 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 ShowHint: Boolean;

  

Enables the Hint display.

  property Sorted: Boolean;

  

Indicates if values in Items are sort in ascending alphanumeric order.

  property Style: TListBoxStyle;

  

Appearance of the list box (normal, owner-draw fixed, or owner-draw variable).

  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 TopIndex: Integer;

  

Index of the first visible (or top-most) item.

  property Visible: Boolean;

  

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

end;

Inheritance

TFileListBox

  

Implements a file selection list box control.

|

TCustomFileListBox

  

Implements the base class for a file selection list box.

|

TCustomListBox

  

The base class for TListBox.

|

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

TFileListBox is a TCustomFileListBox descendant which implements a file selection list box control. It is used to select a file or directory on the local file system. TFileListBox sets the visibility for properties introduced in an ancestor class, and does not contains any new properties, methods, or events.

Use the Drive and Directory properties to specify the location on the local file system displayed in the list box. Please note that Drive is not used on UNIX-like file systems.

Use FileType to specify the files and/or directories which can be displayed in the control.

Use Mask to specify a file mask (with optional wildcards) used to select the files displayed in the control. Please note that wild cards may be implemented differently for some file systems. For example: '*' is the "all files" mask on UNIX-like file systems instead of '*.*'.

Use the Sorted property to control the order of files and directories displayed in the control.

Use the FileName property to get the current file selection in the control.

Assign an object procedure to the OnChange event handler to perform actions needed when a new item has been selected in the control.

See also

TCustomFileListBox

  

Implements the base class for a file selection list box.

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