Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > main-release > by-pkgid > 4a7a03b9c12105ca7dcc2eab88d3704a > files > 72

clanlib0.6-docs-0.6.5-36mdv2010.1.x86_64.rpm


<html>
<head><title>ClanLib Reference: CL_FileDialog</title></head>
<body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0>
<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr>
<tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table>
<table align=center border=0 cellspacing=10> <tr>
<td><a href="entire_class_index.html">Entire Class Index</a></td>
<td><a href="class_index.html">Main Class Index</a></td>
<td><a href="cross_index.html">Cross Index</a></td>
<td><a href="global_index.html">Global Index</a></td>
</table><h1 align=center>Class CL_FileDialog</h1><p>
<b>  File dialog component</b><br>
Contained in: <a href="global_index.html">global</a><br>
Derived from:
<a href="CL_Window.html">CL_Window</a>
<br>
Derived by:
<i>none</i>
<br>Group: GUI (Controls)
<p>
#include &lt;ClanLib/gui.h&gt;
<p>
<hr noshade>
<table border=0>
<tr><td colspan=3><h3>public function member index:</h3></td>
<tr valign=top><td align=left><h3>Construction:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_FileDialog.html#968"><tt><font color=blue><b>CL_FileDialog</b></font></tt></a></td><td><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_FileDialog.html#969"><tt><font color=blue><b>CL_FileDialog</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>title</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>file</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filter</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_FileDialog.html#970"><tt><font color=blue><b>~CL_FileDialog</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt>static</tt> <tt>const</tt> <tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#971"><tt><font color=blue><b>open</b></font></tt></a></td><td><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>static</tt> <tt>const</tt> <tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#972"><tt><font color=blue><b>open</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>file</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filter</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>static</tt> <tt>const</tt> <tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#973"><tt><font color=blue><b>save</b></font></tt></a></td><td><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>static</tt> <tt>const</tt> <tt><font color=navy>std::string</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#974"><tt><font color=blue><b>save</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>file</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filter</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>)</tt>;</td>
<tr valign=top><td align=left><h3>Attributes:</h3></td>
<tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_FileDialog.html#975"><tt><font color=blue><b>get_file</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_FileDialog.html#976"><tt><font color=blue><b>get_filter</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_FileDialog.html#977"><tt><font color=blue><b>get_dir</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> </td><td align=right><a href="CL_FileDialog.html#978"><tt><font color=blue><b>get_path</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>bool</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#979"><tt><font color=blue><b>is_hidden_files_visible</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=left><h3>Operations:</h3></td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#980"><tt><font color=blue><b>set_file</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#981"><tt><font color=blue><b>set_dir</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>dir</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#982"><tt><font color=blue><b>set_filter</b></font></tt></a></td><td><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filter</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#983"><tt><font color=blue><b>show_hidden_files</b></font></tt></a></td><td><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>enable</font></tt> = true)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_FileDialog.html#984"><tt><font color=blue><b>refresh</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=left><h3>Signals:</h3></td>
<tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<tt>const</tt> <tt><font color=navy>std::string</font></tt>& >&</tt> </td><td align=right><a href="CL_FileDialog.html#985"><tt><font color=blue><b>sig_file_highlighted</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<tt>const</tt> <tt><font color=navy>std::string</font></tt>& >&</tt> </td><td align=right><a href="CL_FileDialog.html#986"><tt><font color=blue><b>sig_file_selected</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=navy>CL_Signal_v1</font></tt><<tt>const</tt> <tt><font color=navy>std::string</font></tt>& >&</tt> </td><td align=right><a href="CL_FileDialog.html#987"><tt><font color=blue><b>sig_dir_entered</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
<p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="968"><font size=+1><b>CL_FileDialog::CL_FileDialog</b></font></a> -   File dialog constructor<br><tt></tt> <a href="CL_FileDialog.html#968"><tt><font color=blue><b>CL_FileDialog</b></font></tt></a><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="969"><font size=+1><b>CL_FileDialog::CL_FileDialog</b></font></a> -   File dialog constructor<br><tt></tt> <a href="CL_FileDialog.html#969"><tt><font color=blue><b>CL_FileDialog</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>title</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>file</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filter</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>, <a href="CL_StyleManager.html"><tt><font color=navy><b>CL_StyleManager</b></font></tt></a>* <tt><font color=blue>style</font></tt> = NULL)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="977"><font size=+1><b>CL_FileDialog::get_dir</b></font></a> -   Returns the active directory in the file dialog.<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_FileDialog.html#977"><tt><font color=blue><b>get_dir</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="975"><font size=+1><b>CL_FileDialog::get_file</b></font></a> -   Returns the selected file name. <br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_FileDialog.html#975"><tt><font color=blue><b>get_file</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="976"><font size=+1><b>CL_FileDialog::get_filter</b></font></a> -   Returns the filter which the user has chosen in the file dialog.<br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_FileDialog.html#976"><tt><font color=blue><b>get_filter</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="978"><font size=+1><b>CL_FileDialog::get_path</b></font></a> -   Returns the active directory path in the file dialog. <br><tt><tt>const</tt> <tt><font color=navy>std::string</font></tt>&</tt> <a href="CL_FileDialog.html#978"><tt><font color=blue><b>get_path</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="979"><font size=+1><b>CL_FileDialog::is_hidden_files_visible</b></font></a> -   Returns true if hidden files are shown in the filedialog, else false.<br><tt><tt><font color=purple>bool</font></tt></tt> <a href="CL_FileDialog.html#979"><tt><font color=blue><b>is_hidden_files_visible</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="971"><font size=+1><b>CL_FileDialog::open</b></font></a> -   Open<br><tt><tt>static</tt> <tt>const</tt> <tt><font color=navy>std::string</font></tt></tt> <a href="CL_FileDialog.html#971"><tt><font color=blue><b>open</b></font></tt></a><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="972"><font size=+1><b>CL_FileDialog::open</b></font></a> -   Open<br><tt><tt>static</tt> <tt>const</tt> <tt><font color=navy>std::string</font></tt></tt> <a href="CL_FileDialog.html#972"><tt><font color=blue><b>open</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>file</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filter</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="984"><font size=+1><b>CL_FileDialog::refresh</b></font></a> -   Re-reads the active directory in the file dialog. <br>  It is seldom necessary to call this function.  It is provided in case the directory contents change and you want to refresh the directory listbox.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_FileDialog.html#984"><tt><font color=blue><b>refresh</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="973"><font size=+1><b>CL_FileDialog::save</b></font></a> -   Save<br><tt><tt>static</tt> <tt>const</tt> <tt><font color=navy>std::string</font></tt></tt> <a href="CL_FileDialog.html#973"><tt><font color=blue><b>save</b></font></tt></a><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="974"><font size=+1><b>CL_FileDialog::save</b></font></a> -   Save<br><tt><tt>static</tt> <tt>const</tt> <tt><font color=navy>std::string</font></tt></tt> <a href="CL_FileDialog.html#974"><tt><font color=blue><b>save</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>file</font></tt>, <tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filter</font></tt>, <a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* <tt><font color=blue>parent</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="981"><font size=+1><b>CL_FileDialog::set_dir</b></font></a> -   Sets a directory path for the file dialog. <br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_FileDialog.html#981"><tt><font color=blue><b>set_dir</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>dir</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="980"><font size=+1><b>CL_FileDialog::set_file</b></font></a> -   Sets the default selection to filename.<br>  If filename is absolute, set_dir() is also called. <br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_FileDialog.html#980"><tt><font color=blue><b>set_file</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filename</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="982"><font size=+1><b>CL_FileDialog::set_filter</b></font></a> -   Sets the filter to filter.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_FileDialog.html#982"><tt><font color=blue><b>set_filter</b></font></tt></a><tt>(<tt>const</tt> <tt><font color=navy>std::string</font></tt>& <tt><font color=blue>filter</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="983"><font size=+1><b>CL_FileDialog::show_hidden_files</b></font></a> -   If enable is true, hidden files are shown in the filedialog, else no hidden files are shown. <br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_FileDialog.html#983"><tt><font color=blue><b>show_hidden_files</b></font></tt></a><tt>(<tt><font color=purple>bool</font></tt> <tt><font color=blue>enable</font></tt> = true)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="987"><font size=+1><b>CL_FileDialog::sig_dir_entered</b></font></a> -   This signal is emitted when the user has selected a new directory. <br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<tt>const</tt> <tt><font color=navy>std::string</font></tt>& >&</tt> <a href="CL_FileDialog.html#987"><tt><font color=blue><b>sig_dir_entered</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="985"><font size=+1><b>CL_FileDialog::sig_file_highlighted</b></font></a> -   This signal is emitted when the user highlights a file. <br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<tt>const</tt> <tt><font color=navy>std::string</font></tt>& >&</tt> <a href="CL_FileDialog.html#985"><tt><font color=blue><b>sig_file_highlighted</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="986"><font size=+1><b>CL_FileDialog::sig_file_selected</b></font></a> -   This signal is emitted when the user selects a file. <br><tt><tt><font color=navy>CL_Signal_v1</font></tt><<tt>const</tt> <tt><font color=navy>std::string</font></tt>& >&</tt> <a href="CL_FileDialog.html#986"><tt><font color=blue><b>sig_file_selected</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="970"><font size=+1><b>CL_FileDialog::~CL_FileDialog</b></font></a> -   File dialog destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_FileDialog.html#970"><tt><font color=blue><b>~CL_FileDialog</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<hr noshade>
<h2>Variable Member Descriptions:</h2>
<hr noshade>
</body>
</html>