Sophie

Sophie

distrib > Fedora > 18 > i386 > by-pkgid > 92f84e59d4dc7cfd45889b3a0d83bc68 > files > 3089

ClanLib-devel-2.3.7-1.fc18.i686.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>ClanLib: CL_SaveFileDialog Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">ClanLib
   &#160;<span id="projectnumber">2.3.7</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classCL__SaveFileDialog-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CL_SaveFileDialog Class Reference<div class="ingroups"><a class="el" href="group__clanGUI__Components.html">clanGUI Components</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>SaveFileDialog component.  
 <a href="classCL__SaveFileDialog.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="savefiledialog_8h_source.html">savefiledialog.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Construction</div></td></tr>
<tr class="memitem:a3e0b780c92c98ea730fa0c471a9a63f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#a3e0b780c92c98ea730fa0c471a9a63f9">CL_SaveFileDialog</a> (<a class="el" href="classCL__GUIComponent.html">CL_GUIComponent</a> *owner)</td></tr>
<tr class="memdesc:a3e0b780c92c98ea730fa0c471a9a63f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a save file dialog.  <a href="#a3e0b780c92c98ea730fa0c471a9a63f9">More...</a><br/></td></tr>
<tr class="separator:a3e0b780c92c98ea730fa0c471a9a63f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfc299be4ad1729f5e9bd3aa0b1d2200"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#abfc299be4ad1729f5e9bd3aa0b1d2200">~CL_SaveFileDialog</a> ()</td></tr>
<tr class="separator:abfc299be4ad1729f5e9bd3aa0b1d2200"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Attributes</div></td></tr>
<tr class="memitem:a9002f22a16779b1c47328c81d664ee97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#a9002f22a16779b1c47328c81d664ee97">get_filename</a> () const </td></tr>
<tr class="memdesc:a9002f22a16779b1c47328c81d664ee97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the full path of the file selected.  <a href="#a9002f22a16779b1c47328c81d664ee97">More...</a><br/></td></tr>
<tr class="separator:a9002f22a16779b1c47328c81d664ee97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Operations</div></td></tr>
<tr class="memitem:a10ccfc802fe64efee3571a5bcb0788ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#a10ccfc802fe64efee3571a5bcb0788ca">set_filename</a> (const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;filename)</td></tr>
<tr class="memdesc:a10ccfc802fe64efee3571a5bcb0788ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a string containing the full path of the file selected.  <a href="#a10ccfc802fe64efee3571a5bcb0788ca">More...</a><br/></td></tr>
<tr class="separator:a10ccfc802fe64efee3571a5bcb0788ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55682e850f7da2cb44fd53d818686259"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#a55682e850f7da2cb44fd53d818686259">add_filter</a> (const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;filter_description, const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;filter_extension, bool is_default=false)</td></tr>
<tr class="memdesc:a55682e850f7da2cb44fd53d818686259"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a filter that determines what types of files are displayed.  <a href="#a55682e850f7da2cb44fd53d818686259">More...</a><br/></td></tr>
<tr class="separator:a55682e850f7da2cb44fd53d818686259"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd4d505ca06367db6486430f19942fcf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#afd4d505ca06367db6486430f19942fcf">clear_filters</a> ()</td></tr>
<tr class="memdesc:afd4d505ca06367db6486430f19942fcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all filters.  <a href="#afd4d505ca06367db6486430f19942fcf">More...</a><br/></td></tr>
<tr class="separator:afd4d505ca06367db6486430f19942fcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a795e5e2837d9c0cee7466f5d26098b69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#a795e5e2837d9c0cee7466f5d26098b69">set_filter_index</a> (int filter_index)</td></tr>
<tr class="memdesc:a795e5e2837d9c0cee7466f5d26098b69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a default filter, on a 0-based index.  <a href="#a795e5e2837d9c0cee7466f5d26098b69">More...</a><br/></td></tr>
<tr class="separator:a795e5e2837d9c0cee7466f5d26098b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a834d029b6864d4662c3ede1525ff3054"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#a834d029b6864d4662c3ede1525ff3054">set_initial_directory</a> (const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;path)</td></tr>
<tr class="memdesc:a834d029b6864d4662c3ede1525ff3054"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the initial directory that is displayed.  <a href="#a834d029b6864d4662c3ede1525ff3054">More...</a><br/></td></tr>
<tr class="separator:a834d029b6864d4662c3ede1525ff3054"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afba2f7f3b0aef296b899624efba173ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#afba2f7f3b0aef296b899624efba173ac">set_title</a> (const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;title)</td></tr>
<tr class="memdesc:afba2f7f3b0aef296b899624efba173ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the text that appears in the title bar.  <a href="#afba2f7f3b0aef296b899624efba173ac">More...</a><br/></td></tr>
<tr class="separator:afba2f7f3b0aef296b899624efba173ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1222fed1c5d3360e50fc12d28c518317"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCL__SaveFileDialog.html#a1222fed1c5d3360e50fc12d28c518317">show</a> ()</td></tr>
<tr class="memdesc:a1222fed1c5d3360e50fc12d28c518317"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shows the file dialog.  <a href="#a1222fed1c5d3360e50fc12d28c518317">More...</a><br/></td></tr>
<tr class="separator:a1222fed1c5d3360e50fc12d28c518317"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SaveFileDialog component. </p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3e0b780c92c98ea730fa0c471a9a63f9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CL_SaveFileDialog::CL_SaveFileDialog </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCL__GUIComponent.html">CL_GUIComponent</a> *&#160;</td>
          <td class="paramname"><em>owner</em>)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructs a save file dialog. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">owner</td><td>= Owning GUIComponent </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="abfc299be4ad1729f5e9bd3aa0b1d2200"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual CL_SaveFileDialog::~CL_SaveFileDialog </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a55682e850f7da2cb44fd53d818686259"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CL_SaveFileDialog::add_filter </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;&#160;</td>
          <td class="paramname"><em>filter_description</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;&#160;</td>
          <td class="paramname"><em>filter_extension</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>is_default</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Add a filter that determines what types of files are displayed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filter_description</td><td>= filter_description </td></tr>
    <tr><td class="paramname">filter_extension</td><td>= filter_extension </td></tr>
    <tr><td class="paramname">is_default</td><td>= is_default </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="afd4d505ca06367db6486430f19942fcf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CL_SaveFileDialog::clear_filters </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears all filters. </p>

</div>
</div>
<a class="anchor" id="a9002f22a16779b1c47328c81d664ee97"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> CL_SaveFileDialog::get_filename </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the full path of the file selected. </p>
<dl class="section return"><dt>Returns</dt><dd>CL_String </dd></dl>

</div>
</div>
<a class="anchor" id="a10ccfc802fe64efee3571a5bcb0788ca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CL_SaveFileDialog::set_filename </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;&#160;</td>
          <td class="paramname"><em>filename</em>)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets a string containing the full path of the file selected. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>= filename </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a795e5e2837d9c0cee7466f5d26098b69"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CL_SaveFileDialog::set_filter_index </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>filter_index</em>)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets a default filter, on a 0-based index. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filter_index</td><td>= filter_index </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a834d029b6864d4662c3ede1525ff3054"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CL_SaveFileDialog::set_initial_directory </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;&#160;</td>
          <td class="paramname"><em>path</em>)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the initial directory that is displayed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>= path </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="afba2f7f3b0aef296b899624efba173ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CL_SaveFileDialog::set_title </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__clanCore__Text.html#gae0222584649c6e2888037173687e55ed">CL_String</a> &amp;&#160;</td>
          <td class="paramname"><em>title</em>)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the text that appears in the title bar. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">title</td><td>= title </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1222fed1c5d3360e50fc12d28c518317"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CL_SaveFileDialog::show </td>
          <td>(</td>
          <td class="paramname">)</td><td></td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Shows the file dialog. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the user clicks the OK button of the dialog that is displayed, false otherwise. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="savefiledialog_8h_source.html">savefiledialog.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 14 2013 13:05:59 for ClanLib by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>