Class TFileFilterList
Unit
CastleFileFilters
Declaration
type TFileFilterList = class(specialize TFPGObjectList<TFileFilter>)
Description
Hierarchy
- TFPGObjectList
- TFileFilterList
Overview
Methods
Properties
 |
property DefaultFilter: Integer
read FDefaultFilter write FDefaultFilter default 0; |
Description
Methods
 |
constructor Create(AFreeObjects: boolean); |
|
 |
procedure AddFilter(const Name: string; const Patterns: array of string); |
Add one file filter, selectable by user.
Parameters
- Name
- Is a name displayed for for user.
- Patterns
- Each string in Patterns is a pattern using * and ? matching characters.
|
 |
procedure AddFiltersFromString(const FiltersStr: string); |
An easy way to add multiple filters encoded in a single string. Filters are separated by '|' (bar character). Each filter has a name, separated from patterns list also by '|'. If filter name starts with '*', it's set as a default filter. Patterns are separated by ';' (semicolon character).
As you can see, this prevents some special characters from appearing in names and patterns. For maximum flexibility, don't use this function, use AddFilter.
For example All files (*)|*|All images (*.png;*.jpg)|*.png;*.jpg|PNG images (*.png)|*.png
Not finished pairs of name + pattern at the end of the string are ignored. In particular, empty string is unfinished (actually, it contains an empty Name, and is unfinished because there is no |, so no matching Pattern) so empty string causes no filters to be added.
|
Properties
 |
property DefaultFilter: Integer
read FDefaultFilter write FDefaultFilter default 0; |
Index of default filter, selected by default for user when using this filters list.
|
Generated by PasDoc 0.14.0.
|