FormFileBrowser

A file browser item. The file browser can be used to navigate an operating system's directory structure to look for and select a file.

Example

form = cf.Form.New("Process model")

    --- Create 'FormFileBrowser' and adjust its initial settings 
    
fileBrowser = cf.FormFileBrowser.New("Model:")
fileBrowser:SetFilter("*.fek")
fileBrowser.MultiSelect = false

form:Add(fileBrowser)

    -- Run the form and retrieve the user input
    
form:Run()
selectedPath = fileBrowser.Value

Inheritance

The FormFileBrowser object is derived from the FormLabelledItem object.

Usage locations

The FormFileBrowser object can be accessed from the following locations:

Property List

Enabled
Controls the item enabled state. Setting the enabled state of an item to false will also disable items or their contents. (Read/Write boolean)
FixedHeight
The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the height of the item. Setting the fixed height to zero or a negative value will restore the default/auto setting and the height will be dynamically determined. The fixed height takes precedence over the minimum height and thus the minimum height is ignored when a fixed height is set. (Read/Write number)
FixedWidth
The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the width of the item. Setting the fixed width to zero or a negative value will restore the default/auto setting and the width will be dynamically determined. The fixed width takes precedence over the minimum width and thus the minimum width is ignored when a fixed width is set. (Read/Write number)
ItemHeight
The height of the item in pixels. (Read only number)
ItemWidth
The width of the item in pixels. (Read only number)
MinimumHeight
The minimum height of the item in pixels. When the height is dynamically determined, it will not be less than the minimum height setting. The minimum height value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or a negative value will restore the default/auto setting where no minimum height is enforced. (Read/Write number)
MinimumWidth
The minimum width of the item in pixels. When the width is dynamically determined, it will not be less than the minimum width setting. The minimum width value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or a negative value will restore the default/auto setting where no minimum width is enforced. (Read/Write number)
MultiSelect
Set multiple selection for file browsing. (Read/Write boolean)
Type
The object type string. (Read only string)
Value
The path of the file(s) separated by ;. (Read/Write List of string)
Visible
Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents. (Read/Write boolean)

Method List

ClearCallBack ()
Clear the function that will be called when the check box state changes.
LabelItem ()
Returns the built-in label object associated with the form item. This allows access to the label like a normal form label. (Returns a FormLabel object.)
Run ()
Displays the file open dialog and places the resulting file selection into the Value property.
SetCallBack (callback function)
Set the function that will be called when the item's action has triggered.
SetFilter (filter string)
Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 *.ex2);;Second type (*.*).

Constructor Function List

New (label string)
Create a new file browser item. (Returns a FormFileBrowser object.)
New ()
Create a new file browser item. (Returns a FormFileBrowser object.)

Property Details

Enabled
Controls the item enabled state. Setting the enabled state of an item to false will also disable items or their contents.
Type
boolean
Access
Read/Write
FixedHeight
The fixed height of the item in pixels. When the fixed height is set to a positive value, it is the height of the item. Setting the fixed height to zero or a negative value will restore the default/auto setting and the height will be dynamically determined. The fixed height takes precedence over the minimum height and thus the minimum height is ignored when a fixed height is set.
Type
number
Access
Read/Write
FixedWidth
The fixed width of the item in pixels. When the fixed width is set to a positive value, it is the width of the item. Setting the fixed width to zero or a negative value will restore the default/auto setting and the width will be dynamically determined. The fixed width takes precedence over the minimum width and thus the minimum width is ignored when a fixed width is set.
Type
number
Access
Read/Write
ItemHeight
The height of the item in pixels.
Type
number
Access
Read only
ItemWidth
The width of the item in pixels.
Type
number
Access
Read only
MinimumHeight
The minimum height of the item in pixels. When the height is dynamically determined, it will not be less than the minimum height setting. The minimum height value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum height to zero or a negative value will restore the default/auto setting where no minimum height is enforced.
Type
number
Access
Read/Write
MinimumWidth
The minimum width of the item in pixels. When the width is dynamically determined, it will not be less than the minimum width setting. The minimum width value will only be used when the FixedWidth is not set (restored to the default/auto setting). Setting the minimum width to zero or a negative value will restore the default/auto setting where no minimum width is enforced.
Type
number
Access
Read/Write
MultiSelect
Set multiple selection for file browsing.
Type
boolean
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Value
The path of the file(s) separated by ;.
Access
Read/Write
Visible
Controls the item visibility. Setting the visibility of an item to false will also hide items or their contents.
Type
boolean
Access
Read/Write

Method Details

ClearCallBack ()
Clear the function that will be called when the check box state changes.
LabelItem ()
Returns the built-in label object associated with the form item. This allows access to the label like a normal form label.
Return
FormLabel
The form label item.
Run ()
Displays the file open dialog and places the resulting file selection into the Value property.
SetCallBack (callback function)
Set the function that will be called when the item's action has triggered.
Input Parameters
callback(function)
The function call back.
SetFilter (filter string)
Sets a filter for the file types. It must be in the standard Qt form, i.e. File type name (*.ex1 *.ex2);;Second type (*.*).
Input Parameters
filter(string)
The file filter.

Static Function Details

New (label string)
Create a new file browser item.
Input Parameters
label(string)
The item label.
Return
FormFileBrowser
The file browser item created.
New ()
Create a new file browser item.
Return
FormFileBrowser
The file browser item created.