GuiDirectoryFileListCtrl Class Reference
[General Controls]

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

Inheritance diagram for GuiDirectoryFileListCtrl:

[legend]

List of all members.

Public Member 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.
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.

---

Detailed Description

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

Example:

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

---

Member Function Documentation

string GuiDirectoryFileListCtrl::getSelectedFile

(

)

Get the currently selected filename.

Returns:

The filename of the currently selected file

string GuiDirectoryFileListCtrl::getSelectedFiles

(

)

Get the list of selected files.

Returns:

A space separated list of selected files

void GuiDirectoryFileListCtrl::reload

(

)

Update the file list.

void GuiDirectoryFileListCtrl::setFilter

(

string

filter

)

Set the file filter.

Parameters:

filter

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

bool GuiDirectoryFileListCtrl::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.

---

Member Data Documentation

string GuiDirectoryFileListCtrl::fileFilter

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

string GuiDirectoryFileListCtrl::filePath

Path in game directory from which to list files.