GuiDirectoryFileListCtrl

Inheritance diagram for GuiDirectoryFileListCtrl ↕

A control that displays a list of files from within a single directory in the game file system.

Public Attributes

string

fileFilter

Tab-delimited list of file name patterns. Only matched files will be displayed.

string

filePath

Path in game directory from which to list files.

Public Functions

string

getSelectedFile()

Get the currently selected filename.

string

getSelectedFiles()

Get the list of selected files.

void

reload()

Update the file list.

void

setFilter(string filter)

Set the file filter.

bool

setPath(string path, string filter)

Set the search path and file filter.

Detailed Description

A control that displays a list of files from within a single directory in the game file system.

new GuiDirectoryFileListCtrl()
{
   filePath = "art/shapes";
   fileFilter = "*.dts" TAB "*.dae";
   //Properties not specific to this control have been omitted from this example.
};

Public Attributes

string fileFilter

Tab-delimited list of file name patterns. Only matched files will be displayed.

string filePath

Path in game directory from which to list files.

Public Functions

getSelectedFile()

Get the currently selected filename.

return:

The filename of the currently selected file

getSelectedFiles()

Get the list of selected files.

return:

A space separated list of selected files

reload()

Update the file list.

setFilter(string filter)

Set the file filter.

Parameters:

filter

Tab-delimited list of file name patterns. Only matched files will be displayed.

setPath(string path, string filter)

Set the search path and file filter.

Parameters:

path	Path in game directory from which to list files.
filter	Tab-delimited list of file name patterns. Only matched files will be displayed.