Sign in Join
FPDoc Onlineexperiment

TCustomFilterComboBox.ConvertFilterToStrings procedure

Member of TCustomFilterComboBoxpublicIn unit FileCtrl

Parses the file filter(s) in AFilter and stores them in AStrings.

Declaration

pascal
class procedure ConvertFilterToStrings(AFilter: string; 
 AStrings: TStrings; 
 AClearStrings: Boolean; 
 AAddDescription: Boolean; 
 AAddFilter: Boolean)

Description

ConvertFilterToStrings is a class procedure used to parse the LCL filter string in AFilter, and store the individual filters in AStrings.

AFilter contains a value like: 'Text files (*.txt *.pas)|*.txt;*.pas|Binaries (*.exe)|*.exe'.

Values in AClearStrings, AAddDescription, and AAddFilter control the values stored in the AStrings.

AClearStrings indicates whether existing values in AStrings are cleared before adding values found in the method.

AAddDescription indicates if the descriptive text for file filter(s) are added to the string list.

AAddFilter indicates if the file mask portion of the filter is added to the string list.

When AAddDescription = True and AAddFilter = False, the following values would be stored in AStrings:

Text files (*.txt *.pas)
Binaries (*.exe)

Adapted from the converter initially created for QtWSDialogs.pas.

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.