ClanLib  2.3.7
List of all members
CL_BrowseFolderDialog Class Reference

BrowseFolderDialog component. More...

#include <folderbrowsedialog.h>

Public Member Functions

Construction
 CL_BrowseFolderDialog (CL_GUIComponent *owner)
 Constructs an browse folder dialog. More...
 
virtual ~CL_BrowseFolderDialog ()
 
Attributes
CL_String get_selected_path () const
 Get the full path of the directory selected. More...
 
Operations
void set_initial_directory (const CL_String &path)
 Sets the initial directory that is displayed. More...
 
void set_title (const CL_String &title)
 Sets the text that appears in the title bar. More...
 
bool show ()
 Shows the file dialog. More...
 

Detailed Description

BrowseFolderDialog component.

Constructor & Destructor Documentation

CL_BrowseFolderDialog::CL_BrowseFolderDialog ( CL_GUIComponent owner)

Constructs an browse folder dialog.

Parameters
owner= Owning GUIComponent
virtual CL_BrowseFolderDialog::~CL_BrowseFolderDialog ( )
virtual

Member Function Documentation

CL_String CL_BrowseFolderDialog::get_selected_path ( ) const

Get the full path of the directory selected.

Returns
CL_String
void CL_BrowseFolderDialog::set_initial_directory ( const CL_String path)

Sets the initial directory that is displayed.

Parameters
path= path
void CL_BrowseFolderDialog::set_title ( const CL_String title)

Sets the text that appears in the title bar.

Parameters
title= title
bool CL_BrowseFolderDialog::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: