CL_SaveFileDialog Class Reference
[clanGUI Components]

SaveFileDialog component. More...

#include <savefiledialog.h>

List of all members.

Public Member Functions
Construction
	CL_SaveFileDialog (CL_GUIComponent *owner)
	Constructs a save file dialog.
virtual	~CL_SaveFileDialog ()
Attributes
CL_String	get_filename () const
	Get the full path of the file selected.
Operations
void	set_filename (const CL_String &filename)
	Sets a string containing the full path of the file selected.
void	add_filter (const CL_String &filter_description, const CL_String &filter_extension, bool is_default=false)
	Add a filter that determines what types of files are displayed.
void	clear_filters ()
	Clears all filters.
void	set_filter_index (int filter_index)
	Sets a default filter, on a 0-based index.
void	set_initial_directory (const CL_String &path)
	Sets the initial directory that is displayed.
void	set_title (const CL_String &title)
	Sets the text that appears in the title bar.
bool	show ()
	Shows the file dialog.

---

Detailed Description

SaveFileDialog component.

---

Constructor & Destructor Documentation

CL_SaveFileDialog::CL_SaveFileDialog (  CL_GUIComponent *  owner  )

Constructs a save file dialog. Parameters: owner  = Owning GUIComponent

virtual CL_SaveFileDialog::~CL_SaveFileDialog (   )  [virtual]

---

Member Function Documentation

void CL_SaveFileDialog::add_filter (  const CL_String &  filter_description, const CL_String &  filter_extension, bool  is_default = false )

Add a filter that determines what types of files are displayed. Parameters: filter_description  = filter_description filter_extension  = filter_extension is_default  = is_default

void CL_SaveFileDialog::clear_filters (   )

Clears all filters.

CL_String CL_SaveFileDialog::get_filename (   )  const

Get the full path of the file selected. Returns: CL_String

void CL_SaveFileDialog::set_filename (  const CL_String &  filename  )

Sets a string containing the full path of the file selected. Parameters: filename  = filename

void CL_SaveFileDialog::set_filter_index (  int  filter_index  )

Sets a default filter, on a 0-based index. Parameters: filter_index  = filter_index

void CL_SaveFileDialog::set_initial_directory (  const CL_String &  path  )

Sets the initial directory that is displayed. Parameters: path  = path

void CL_SaveFileDialog::set_title (  const CL_String &  title  )

Sets the text that appears in the title bar. Parameters: title  = title

bool CL_SaveFileDialog::show (   )

Shows the file dialog. Returns: true if the user clicks the OK button of the dialog that is displayed, false otherwise.

---

The documentation for this class was generated from the following file:

• savefiledialog.h

---