OSDN Git Service

Documentation was updated.
[mutilities/MUtilities.git] / docs / d5 / d3b / _global_8h.html
index bc8e1cd..ad8a564 100644 (file)
@@ -64,8 +64,10 @@ $(function() {
 </div><!-- top -->
 <div class="header">
   <div class="summary">
+<a href="#nested-classes">Classes</a> &#124;
 <a href="#namespaces">Namespaces</a> &#124;
 <a href="#define-members">Macros</a> &#124;
+<a href="#typedef-members">Typedefs</a> &#124;
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle">
 <div class="title">Global.h File Reference</div>  </div>
@@ -78,6 +80,14 @@ $(function() {
 </div>
 <p><a href="../../d5/d3b/_global_8h_source.html">Go to the source code of this file.</a></p>
 <table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Classes</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d9c/class_q_hash.html">QHash&lt; K, V &gt;</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d46/struct_m_utils_1_1__fp__parts__t.html">MUtils::_fp_parts_t</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This struct containes the parts (integral and fractional part) of a floating-point number.  <a href="../../da/d46/struct_m_utils_1_1__fp__parts__t.html#details">More...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
 Namespaces</h2></td></tr>
 <tr class="memitem:d3/da6/namespace_m_utils"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html">MUtils</a></td></tr>
@@ -130,17 +140,27 @@ Macros</h2></td></tr>
 <tr class="memdesc:a8e7b4857b78f9749233e5abc96534ca8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables copy constructor and assignment operator in the specified class. This macro should be used in the "private" section of the class' declaration.  <a href="#a8e7b4857b78f9749233e5abc96534ca8">More...</a><br /></td></tr>
 <tr class="separator:a8e7b4857b78f9749233e5abc96534ca8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
+Typedefs</h2></td></tr>
+<tr class="memitem:a75209365a097871cb2bb8fc3a21ce14b"><td class="memItemLeft" align="right" valign="top"><a id="a75209365a097871cb2bb8fc3a21ce14b"></a>
+typedef struct <a class="el" href="../../da/d46/struct_m_utils_1_1__fp__parts__t.html">MUtils::_fp_parts_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#a75209365a097871cb2bb8fc3a21ce14b">MUtils::fp_parts_t</a></td></tr>
+<tr class="memdesc:a75209365a097871cb2bb8fc3a21ce14b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This struct containes the parts (integral and fractional part) of a floating-point number. <br /></td></tr>
+<tr class="separator:a75209365a097871cb2bb8fc3a21ce14b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
 <tr class="memitem:a3f198156e8be91f3e74dd9ed69ffaa34"><td class="memItemLeft" align="right" valign="top">MUTILS_API const QString &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#a3f198156e8be91f3e74dd9ed69ffaa34">MUtils::temp_folder</a> (void)</td></tr>
 <tr class="memdesc:a3f198156e8be91f3e74dd9ed69ffaa34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rerieves the full path of the application's <em>Temp</em> folder.  <a href="../../d3/da6/namespace_m_utils.html#a3f198156e8be91f3e74dd9ed69ffaa34">More...</a><br /></td></tr>
 <tr class="separator:a3f198156e8be91f3e74dd9ed69ffaa34"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a0ecb5d72f33a7b6feadd7deb8ed46cc3"><td class="memItemLeft" align="right" valign="top">MUTILS_API void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#a0ecb5d72f33a7b6feadd7deb8ed46cc3">MUtils::init_process</a> (QProcess &amp;process, const QString &amp;wokringDir, const bool bReplaceTempDir=true, const QStringList *const extraPaths=NULL)</td></tr>
-<tr class="memdesc:a0ecb5d72f33a7b6feadd7deb8ed46cc3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a given <a href="http://doc.qt.io/qt-4.8/qprocess.html">QProcess</a> object.  <a href="../../d3/da6/namespace_m_utils.html#a0ecb5d72f33a7b6feadd7deb8ed46cc3">More...</a><br /></td></tr>
-<tr class="separator:a0ecb5d72f33a7b6feadd7deb8ed46cc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a80205a5816416cc49e8d9f524894132a"><td class="memItemLeft" align="right" valign="top">MUTILS_API void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#a80205a5816416cc49e8d9f524894132a">MUtils::init_process</a> (QProcess &amp;process, const QString &amp;wokringDir, const bool bReplaceTempDir=true, const QStringList *const extraPaths=NULL, const <a class="el" href="../../d6/d9c/class_q_hash.html">QHash</a>&lt; QString, QString &gt; *const extraEnv=NULL)</td></tr>
+<tr class="memdesc:a80205a5816416cc49e8d9f524894132a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a given <a href="http://doc.qt.io/qt-4.8/qprocess.html">QProcess</a> object.  <a href="../../d3/da6/namespace_m_utils.html#a80205a5816416cc49e8d9f524894132a">More...</a><br /></td></tr>
+<tr class="separator:a80205a5816416cc49e8d9f524894132a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1c9832c1d645a2c90e9bd52d57d843b3"><td class="memItemLeft" align="right" valign="top">MUTILS_API quint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#a1c9832c1d645a2c90e9bd52d57d843b3">MUtils::next_rand_u32</a> (void)</td></tr>
 <tr class="memdesc:a1c9832c1d645a2c90e9bd52d57d843b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a <em>random</em> unsigned 32-Bit value.  <a href="../../d3/da6/namespace_m_utils.html#a1c9832c1d645a2c90e9bd52d57d843b3">More...</a><br /></td></tr>
 <tr class="separator:a1c9832c1d645a2c90e9bd52d57d843b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6a20348df6f4f780d37f1d7440f7eff8"><td class="memItemLeft" align="right" valign="top"><a id="a6a20348df6f4f780d37f1d7440f7eff8"></a>
+MUTILS_API quint32&#160;</td><td class="memItemRight" valign="bottom"><b>MUtils::next_rand_u32</b> (const quint32 max)</td></tr>
+<tr class="separator:a6a20348df6f4f780d37f1d7440f7eff8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ad7edd4aece64faf3aa16c9509243608c"><td class="memItemLeft" align="right" valign="top">MUTILS_API quint64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#ad7edd4aece64faf3aa16c9509243608c">MUtils::next_rand_u64</a> (void)</td></tr>
 <tr class="memdesc:ad7edd4aece64faf3aa16c9509243608c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a <em>random</em> unsigned 64-Bit value.  <a href="../../d3/da6/namespace_m_utils.html#ad7edd4aece64faf3aa16c9509243608c">More...</a><br /></td></tr>
 <tr class="separator:ad7edd4aece64faf3aa16c9509243608c"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -150,9 +170,15 @@ Functions</h2></td></tr>
 <tr class="memitem:a29461116550863e8730f3f4ec479bbcb"><td class="memItemLeft" align="right" valign="top">MUTILS_API QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#a29461116550863e8730f3f4ec479bbcb">MUtils::make_temp_file</a> (const QString &amp;basePath, const QString &amp;extension, const bool placeholder=false)</td></tr>
 <tr class="memdesc:a29461116550863e8730f3f4ec479bbcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a temporary file name.  <a href="../../d3/da6/namespace_m_utils.html#a29461116550863e8730f3f4ec479bbcb">More...</a><br /></td></tr>
 <tr class="separator:a29461116550863e8730f3f4ec479bbcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:af9afe3821ae9bef7bdf56a4183fdea0d"><td class="memItemLeft" align="right" valign="top">MUTILS_API QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#af9afe3821ae9bef7bdf56a4183fdea0d">MUtils::make_unique_file</a> (const QString &amp;basePath, const QString &amp;baseName, const QString &amp;extension, const bool fancy=false)</td></tr>
-<tr class="memdesc:af9afe3821ae9bef7bdf56a4183fdea0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a unique file name.  <a href="../../d3/da6/namespace_m_utils.html#af9afe3821ae9bef7bdf56a4183fdea0d">More...</a><br /></td></tr>
-<tr class="separator:af9afe3821ae9bef7bdf56a4183fdea0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a32eec23b83ebbf837cbb2675d6183587"><td class="memItemLeft" align="right" valign="top"><a id="a32eec23b83ebbf837cbb2675d6183587"></a>
+MUTILS_API QString&#160;</td><td class="memItemRight" valign="bottom"><b>MUtils::make_temp_file</b> (const QDir &amp;basePath, const QString &amp;extension, const bool placeholder=false)</td></tr>
+<tr class="separator:a32eec23b83ebbf837cbb2675d6183587"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4d288d8fbe9a187cffe8db04e70df3de"><td class="memItemLeft" align="right" valign="top">MUTILS_API QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#a4d288d8fbe9a187cffe8db04e70df3de">MUtils::make_unique_file</a> (const QString &amp;basePath, const QString &amp;baseName, const QString &amp;extension, const bool fancy=false, const bool placeholder=false)</td></tr>
+<tr class="memdesc:a4d288d8fbe9a187cffe8db04e70df3de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a unique file name.  <a href="../../d3/da6/namespace_m_utils.html#a4d288d8fbe9a187cffe8db04e70df3de">More...</a><br /></td></tr>
+<tr class="separator:a4d288d8fbe9a187cffe8db04e70df3de"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:abd5b70b2cf6ae3ba7d161beb823f9ef0"><td class="memItemLeft" align="right" valign="top"><a id="abd5b70b2cf6ae3ba7d161beb823f9ef0"></a>
+MUTILS_API QString&#160;</td><td class="memItemRight" valign="bottom"><b>MUtils::make_unique_file</b> (const QDir &amp;basePath, const QString &amp;baseName, const QString &amp;extension, const bool fancy=false, const bool placeholder=false)</td></tr>
+<tr class="separator:abd5b70b2cf6ae3ba7d161beb823f9ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aea4a212153b09b24b04f30ef5159f29b"><td class="memItemLeft" align="right" valign="top">MUTILS_API bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#aea4a212153b09b24b04f30ef5159f29b">MUtils::parity</a> (quint32 value)</td></tr>
 <tr class="memdesc:aea4a212153b09b24b04f30ef5159f29b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the <em>parity</em> of the given unsigned 32-Bit value.  <a href="../../d3/da6/namespace_m_utils.html#aea4a212153b09b24b04f30ef5159f29b">More...</a><br /></td></tr>
 <tr class="separator:aea4a212153b09b24b04f30ef5159f29b"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -210,6 +236,9 @@ MUTILS_API bool&#160;</td><td class="memItemRight" valign="bottom"><b>MUtils::re
 <tr class="memitem:a2275e64c3c74dea855c39b66be67f705"><td class="memItemLeft" align="right" valign="top">MUTILS_API QStringList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#a2275e64c3c74dea855c39b66be67f705">MUtils::available_codepages</a> (const bool &amp;noAliases=true)</td></tr>
 <tr class="memdesc:a2275e64c3c74dea855c39b66be67f705"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a list of all available codepages.  <a href="../../d3/da6/namespace_m_utils.html#a2275e64c3c74dea855c39b66be67f705">More...</a><br /></td></tr>
 <tr class="separator:a2275e64c3c74dea855c39b66be67f705"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:adba57bb9c5055c3ed1d528cd2151b5a9"><td class="memItemLeft" align="right" valign="top">MUTILS_API fp_parts_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/da6/namespace_m_utils.html#adba57bb9c5055c3ed1d528cd2151b5a9">MUtils::break_fp</a> (const double value)</td></tr>
+<tr class="memdesc:adba57bb9c5055c3ed1d528cd2151b5a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Break floating-point number into fractional and integral parts.  <a href="../../d3/da6/namespace_m_utils.html#adba57bb9c5055c3ed1d528cd2151b5a9">More...</a><br /></td></tr>
+<tr class="separator:adba57bb9c5055c3ed1d528cd2151b5a9"><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>This file contains miscellaneous functions that are generally useful for Qt-based applications. </p>