TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: FileDialogData Struct 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_file_dialog_data-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">FileDialogData Struct Reference<div class="ingroups"><a class="el" href="group___system_dialogs.html">Using System Dialogs</a></div></div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;fileDialog.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:acea07de0d459558957477f74b205b7fc" id="r_acea07de0d459558957477f74b205b7fc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fc">DialogStyle</a> { <br />
&#160;&#160;<a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fca711f99c21091762da874cfa77723d516">FDS_OPEN</a> = BIT(0)
, <a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fca87f28eaab2f9e795a2fff15db7171879">FDS_SAVE</a> = BIT(1)
, <a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fca9dc76405a2043e2fafa0eecf30b39e17">FDS_OVERWRITEPROMPT</a> = BIT(2)
, <a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fca77bf02ba642eb66ba1b9bd652520be51">FDS_MUSTEXIST</a> = BIT(3)
, <br />
&#160;&#160;<a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fca9151a79c8e8f00d6e1c34950bc61e0a9">FDS_MULTIPLEFILES</a> = BIT(4)
, <a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fcae1a2cc9e9bc76b0aefb3dbd37a9337b4">FDS_CHANGEPATH</a> = BIT(5)
, <a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fca142596fa0aa20556046d298d3db4f57e">FDS_BROWSEFOLDER</a> = BIT(6)
<br />
 }</td></tr>
<tr class="separator:acea07de0d459558957477f74b205b7fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a01b92e73b235f313c6b4e2b6180e72f2" id="r_a01b92e73b235f313c6b4e2b6180e72f2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#a01b92e73b235f313c6b4e2b6180e72f2">FileDialogData</a> ()</td></tr>
<tr class="separator:a01b92e73b235f313c6b4e2b6180e72f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c4baa9df6f9583d2b2a98c01e96d37e" id="r_a3c4baa9df6f9583d2b2a98c01e96d37e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#a3c4baa9df6f9583d2b2a98c01e96d37e">~FileDialogData</a> ()</td></tr>
<tr class="separator:a3c4baa9df6f9583d2b2a98c01e96d37e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a4fb1923cd9e805a01bb594645a866986" id="r_a4fb1923cd9e805a01bb594645a866986"><td class="memItemLeft" align="right" valign="top">U8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#a4fb1923cd9e805a01bb594645a866986">mStyle</a></td></tr>
<tr class="memdesc:a4fb1923cd9e805a01bb594645a866986"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specifies the Style of the <a class="el" href="class_file.html">File</a> Dialog.  <br /></td></tr>
<tr class="separator:a4fb1923cd9e805a01bb594645a866986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f3a7651049d3bcb9616c7ed6a51bfa5" id="r_a7f3a7651049d3bcb9616c7ed6a51bfa5"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#a7f3a7651049d3bcb9616c7ed6a51bfa5">mFilters</a></td></tr>
<tr class="memdesc:a7f3a7651049d3bcb9616c7ed6a51bfa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of Filters pipe separated e.g. "PNG Files (*.png)|*.png|JPG Files (*.jpg)|*.jpg".  <br /></td></tr>
<tr class="separator:a7f3a7651049d3bcb9616c7ed6a51bfa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ac6fb677e7f3242e27e92f3d93e7df0" id="r_a5ac6fb677e7f3242e27e92f3d93e7df0"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#a5ac6fb677e7f3242e27e92f3d93e7df0">mFile</a></td></tr>
<tr class="memdesc:a5ac6fb677e7f3242e27e92f3d93e7df0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should be referenced when dialogStyle MultipleFiles is NOT used: the file path of the user selected file.  <br /></td></tr>
<tr class="separator:a5ac6fb677e7f3242e27e92f3d93e7df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63282fb1207c9cb8cb7403fa364542d1" id="r_a63282fb1207c9cb8cb7403fa364542d1"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#a63282fb1207c9cb8cb7403fa364542d1">mDefaultPath</a></td></tr>
<tr class="memdesc:a63282fb1207c9cb8cb7403fa364542d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default path of dialog.  <br /></td></tr>
<tr class="separator:a63282fb1207c9cb8cb7403fa364542d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc5c9be059247a007f0e0875bed18154" id="r_abc5c9be059247a007f0e0875bed18154"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#abc5c9be059247a007f0e0875bed18154">mDefaultFile</a></td></tr>
<tr class="memdesc:abc5c9be059247a007f0e0875bed18154"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default selected file of dialog.  <br /></td></tr>
<tr class="separator:abc5c9be059247a007f0e0875bed18154"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88c98a1bc97a4dfe9073c8cc38541351" id="r_a88c98a1bc97a4dfe9073c8cc38541351"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#a88c98a1bc97a4dfe9073c8cc38541351">mTitle</a></td></tr>
<tr class="memdesc:a88c98a1bc97a4dfe9073c8cc38541351"><td class="mdescLeft">&#160;</td><td class="mdescRight">Title to display in file dialog.  <br /></td></tr>
<tr class="separator:a88c98a1bc97a4dfe9073c8cc38541351"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f1d2e09ba801be7dec57705de5a44f2" id="r_a3f1d2e09ba801be7dec57705de5a44f2"><td class="memItemLeft" align="right" valign="top">FileDialogOpaqueData *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_file_dialog_data.html#a3f1d2e09ba801be7dec57705de5a44f2">mOpaqueData</a></td></tr>
<tr class="memdesc:a3f1d2e09ba801be7dec57705de5a44f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores platform specific info about the dialog.  <br /></td></tr>
<tr class="separator:a3f1d2e09ba801be7dec57705de5a44f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="acea07de0d459558957477f74b205b7fc" name="acea07de0d459558957477f74b205b7fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acea07de0d459558957477f74b205b7fc">&#9670;&#160;</a></span>DialogStyle</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fc">DialogStyle</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acea07de0d459558957477f74b205b7fca711f99c21091762da874cfa77723d516" name="acea07de0d459558957477f74b205b7fca711f99c21091762da874cfa77723d516"></a>FDS_OPEN&#160;</td><td class="fielddoc"><p>This is an open dialog. </p>
</td></tr>
<tr><td class="fieldname"><a id="acea07de0d459558957477f74b205b7fca87f28eaab2f9e795a2fff15db7171879" name="acea07de0d459558957477f74b205b7fca87f28eaab2f9e795a2fff15db7171879"></a>FDS_SAVE&#160;</td><td class="fielddoc"><p>This is a save dialog. </p>
</td></tr>
<tr><td class="fieldname"><a id="acea07de0d459558957477f74b205b7fca9dc76405a2043e2fafa0eecf30b39e17" name="acea07de0d459558957477f74b205b7fca9dc76405a2043e2fafa0eecf30b39e17"></a>FDS_OVERWRITEPROMPT&#160;</td><td class="fielddoc"><p>Can only be used in conjunction with style SaveDialog: prompt for a confirmation if a file will be overwritten. </p>
</td></tr>
<tr><td class="fieldname"><a id="acea07de0d459558957477f74b205b7fca77bf02ba642eb66ba1b9bd652520be51" name="acea07de0d459558957477f74b205b7fca77bf02ba642eb66ba1b9bd652520be51"></a>FDS_MUSTEXIST&#160;</td><td class="fielddoc"><p>The user may only select files that actually exist. </p>
</td></tr>
<tr><td class="fieldname"><a id="acea07de0d459558957477f74b205b7fca9151a79c8e8f00d6e1c34950bc61e0a9" name="acea07de0d459558957477f74b205b7fca9151a79c8e8f00d6e1c34950bc61e0a9"></a>FDS_MULTIPLEFILES&#160;</td><td class="fielddoc"><p>Can only be used in conjunction with style OpenDialog: allows selecting multiple files. </p>
</td></tr>
<tr><td class="fieldname"><a id="acea07de0d459558957477f74b205b7fcae1a2cc9e9bc76b0aefb3dbd37a9337b4" name="acea07de0d459558957477f74b205b7fcae1a2cc9e9bc76b0aefb3dbd37a9337b4"></a>FDS_CHANGEPATH&#160;</td><td class="fielddoc"><p>Change the current working path to the directory where the file(s) chosen by the user are. </p>
</td></tr>
<tr><td class="fieldname"><a id="acea07de0d459558957477f74b205b7fca142596fa0aa20556046d298d3db4f57e" name="acea07de0d459558957477f74b205b7fca142596fa0aa20556046d298d3db4f57e"></a>FDS_BROWSEFOLDER&#160;</td><td class="fielddoc"><p>Select folders instead of files. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a01b92e73b235f313c6b4e2b6180e72f2" name="a01b92e73b235f313c6b4e2b6180e72f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01b92e73b235f313c6b4e2b6180e72f2">&#9670;&#160;</a></span>FileDialogData()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_file_dialog_data.html">FileDialogData</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a3c4baa9df6f9583d2b2a98c01e96d37e" name="a3c4baa9df6f9583d2b2a98c01e96d37e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c4baa9df6f9583d2b2a98c01e96d37e">&#9670;&#160;</a></span>~FileDialogData()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="struct_file_dialog_data.html">FileDialogData</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abc5c9be059247a007f0e0875bed18154" name="abc5c9be059247a007f0e0875bed18154"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc5c9be059247a007f0e0875bed18154">&#9670;&#160;</a></span>mDefaultFile</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StringTableEntry mDefaultFile</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default selected file of dialog. </p>

</div>
</div>
<a id="a63282fb1207c9cb8cb7403fa364542d1" name="a63282fb1207c9cb8cb7403fa364542d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63282fb1207c9cb8cb7403fa364542d1">&#9670;&#160;</a></span>mDefaultPath</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StringTableEntry mDefaultPath</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default path of dialog. </p>

</div>
</div>
<a id="a5ac6fb677e7f3242e27e92f3d93e7df0" name="a5ac6fb677e7f3242e27e92f3d93e7df0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ac6fb677e7f3242e27e92f3d93e7df0">&#9670;&#160;</a></span>mFile</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StringTableEntry mFile</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Should be referenced when dialogStyle MultipleFiles is NOT used: the file path of the user selected file. </p>

</div>
</div>
<a id="a7f3a7651049d3bcb9616c7ed6a51bfa5" name="a7f3a7651049d3bcb9616c7ed6a51bfa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f3a7651049d3bcb9616c7ed6a51bfa5">&#9670;&#160;</a></span>mFilters</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StringTableEntry mFilters</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>List of Filters pipe separated e.g. "PNG Files (*.png)|*.png|JPG Files (*.jpg)|*.jpg". </p>

</div>
</div>
<a id="a3f1d2e09ba801be7dec57705de5a44f2" name="a3f1d2e09ba801be7dec57705de5a44f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f1d2e09ba801be7dec57705de5a44f2">&#9670;&#160;</a></span>mOpaqueData</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FileDialogOpaqueData* mOpaqueData</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stores platform specific info about the dialog. </p>

</div>
</div>
<a id="a4fb1923cd9e805a01bb594645a866986" name="a4fb1923cd9e805a01bb594645a866986"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fb1923cd9e805a01bb594645a866986">&#9670;&#160;</a></span>mStyle</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U8 mStyle</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Specifies the Style of the <a class="el" href="class_file.html">File</a> Dialog. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="struct_file_dialog_data.html#acea07de0d459558957477f74b205b7fc">DialogStyle</a> </dd></dl>

</div>
</div>
<a id="a88c98a1bc97a4dfe9073c8cc38541351" name="a88c98a1bc97a4dfe9073c8cc38541351"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88c98a1bc97a4dfe9073c8cc38541351">&#9670;&#160;</a></span>mTitle</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">StringTableEntry mTitle</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Title to display in file dialog. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>platform/nativeDialogs/<b>fileDialog.h</b></li>
<li>platform/nativeDialogs/<b>fileDialog.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>