docs/d5/d3b/_global_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>MuldeR&#39;s Utilities for Qt: include/MUtils/Global.h File Reference</title>
   9 <link href="../../tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="../../jquery.js"></script>
  11 <script type="text/javascript" src="../../dynsections.js"></script>
  12 <link href="../../search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="../../search/searchdata.js"></script>
  14 <script type="text/javascript" src="../../search/search.js"></script>
  15 <link href="../../doxygen.css" rel="stylesheet" type="text/css" />
  16 </head>
  17 <body>
  18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19 <div id="titlearea">
  20 <table cellspacing="0" cellpadding="0">
  21  <tbody>
  22  <tr style="height: 56px;">
  23   <td id="projectalign" style="padding-left: 0.5em;">
  24    <div id="projectname">MuldeR&#39;s Utilities for Qt
  25    </div>
  26    <div id="projectbrief">MUtilities</div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.12 -->
  34 <script type="text/javascript">
  35 var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
  36 </script>
  37 <script type="text/javascript" src="../../menudata.js"></script>
  38 <script type="text/javascript" src="../../menu.js"></script>
  39 <script type="text/javascript">
  40 $(function() {
  41   initMenu('../../',true,false,'search.php','Search');
  42   $(document).ready(function() { init_search(); });
  43 });
  44 </script>
  45 <div id="main-nav"></div>
  46 <!-- window showing the filter options -->
  47 <div id="MSearchSelectWindow"
  48      onmouseover="return searchBox.OnSearchSelectShow()"
  49      onmouseout="return searchBox.OnSearchSelectHide()"
  50      onkeydown="return searchBox.OnSearchSelectKey(event)">
  51 </div>
  52
  53 <!-- iframe showing the search results (closed by default) -->
  54 <div id="MSearchResultsWindow">
  55 <iframe src="javascript:void(0)" frameborder="0"
  56         name="MSearchResults" id="MSearchResults">
  57 </iframe>
  58 </div>
  59
  60 <div id="nav-path" class="navpath">
  61   <ul>
  62 <li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_b076b53667bc06ebb413a190e197fc7b.html">MUtils</a></li>  </ul>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#define-members">Macros</a> &#124;
  68 <a href="#func-members">Functions</a>  </div>
  69   <div class="headertitle">
  70 <div class="title">Global.h File Reference</div>  </div>
  71 </div><!--header-->
  72 <div class="contents">
  73
  74 <p>This file contains miscellaneous functions that are generally useful for Qt-based applications.
  75 <a href="#details">More...</a></p>
  76 <div class="textblock"><code>#include &lt;QString&gt;</code><br />
  77 </div>
  78 <p><a href="../../d5/d3b/_global_8h_source.html">Go to the source code of this file.</a></p>
  79 <table class="memberdecls">
  80 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  81 Macros</h2></td></tr>
  82 <tr class="memitem:a761530893b34e2d324f22ddf7bc31455"><td class="memItemLeft" align="right" valign="top"><a id="a761530893b34e2d324f22ddf7bc31455"></a>
  83 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_API</b></td></tr>
  84 <tr class="separator:a761530893b34e2d324f22ddf7bc31455"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <tr class="memitem:ad5b14e1c1267ed90263a45bf6d4289ca"><td class="memItemLeft" align="right" valign="top"><a id="ad5b14e1c1267ed90263a45bf6d4289ca"></a>
  86 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_MAKE_STRING_HELPER</b>(X)&#160;&#160;&#160;#X</td></tr>
  87 <tr class="separator:ad5b14e1c1267ed90263a45bf6d4289ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:af2c5f52bf983b10e2078b03ce36efb22"><td class="memItemLeft" align="right" valign="top"><a id="af2c5f52bf983b10e2078b03ce36efb22"></a>
  89 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_MAKE_STRING</b>(X)&#160;&#160;&#160;MUTILS_MAKE_STRING_HELPER(X)</td></tr>
  90 <tr class="separator:af2c5f52bf983b10e2078b03ce36efb22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:a2b88ab398bf3616fb6826c806f435ddc"><td class="memItemLeft" align="right" valign="top"><a id="a2b88ab398bf3616fb6826c806f435ddc"></a>
  92 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_COMPILER_WARNING</b>(TXT)&#160;&#160;&#160;__pragma(message(__FILE__ &quot;(&quot; MUTILS_MAKE_STRING(__LINE__) &quot;) : warning: &quot; TXT))</td></tr>
  93 <tr class="separator:a2b88ab398bf3616fb6826c806f435ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:a249516197568fbf9bbf980554b4d6d95"><td class="memItemLeft" align="right" valign="top"><a id="a249516197568fbf9bbf980554b4d6d95"></a>
  95 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_DEBUG</b>&#160;&#160;&#160;(1)</td></tr>
  96 <tr class="separator:a249516197568fbf9bbf980554b4d6d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 <tr class="memitem:ad42b1946a83df3bd76734d5ab691fd0d"><td class="memItemLeft" align="right" valign="top"><a id="ad42b1946a83df3bd76734d5ab691fd0d"></a>
  98 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_DELETE</b>(PTR)&#160;&#160;&#160;do { if((PTR)) { delete (PTR); (PTR) = NULL; } } while(0)</td></tr>
  99 <tr class="separator:ad42b1946a83df3bd76734d5ab691fd0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 <tr class="memitem:aa544a37b80f1ab9d86f439a7666e9aa8"><td class="memItemLeft" align="right" valign="top"><a id="aa544a37b80f1ab9d86f439a7666e9aa8"></a>
 101 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_DELETE_ARRAY</b>(PTR)&#160;&#160;&#160;do { if((PTR)) { delete [] (PTR); (PTR) = NULL; } } while(0)</td></tr>
 102 <tr class="separator:aa544a37b80f1ab9d86f439a7666e9aa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 103 <tr class="memitem:a1fe39de37351efa3ca46bdc8653e1f25"><td class="memItemLeft" align="right" valign="top"><a id="a1fe39de37351efa3ca46bdc8653e1f25"></a>
 104 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_ZERO_MEMORY</b>(PTR)&#160;&#160;&#160;memset(&amp;(PTR), 0, sizeof((PTR)))</td></tr>
 105 <tr class="separator:a1fe39de37351efa3ca46bdc8653e1f25"><td class="memSeparator" colspan="2">&#160;</td></tr>
 106 <tr class="memitem:af55d43b39d3f41cf090c138ed190ee6e"><td class="memItemLeft" align="right" valign="top"><a id="af55d43b39d3f41cf090c138ed190ee6e"></a>
 107 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_WCHR</b>(STR)&#160;&#160;&#160;(reinterpret_cast&lt;const wchar_t*&gt;((STR).utf16()))</td></tr>
 108 <tr class="separator:af55d43b39d3f41cf090c138ed190ee6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 109 <tr class="memitem:a88b0902153ea537b12d86267af20eb3f"><td class="memItemLeft" align="right" valign="top"><a id="a88b0902153ea537b12d86267af20eb3f"></a>
 110 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_UTF8</b>(STR)&#160;&#160;&#160;((STR).toUtf8().constData())</td></tr>
 111 <tr class="separator:a88b0902153ea537b12d86267af20eb3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 <tr class="memitem:a04d63f6f60c90f8e3c4029824a7352b0"><td class="memItemLeft" align="right" valign="top"><a id="a04d63f6f60c90f8e3c4029824a7352b0"></a>
 113 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_QSTR</b>(STR)&#160;&#160;&#160;(QString::fromUtf16(reinterpret_cast&lt;const unsigned short*&gt;((STR))))</td></tr>
 114 <tr class="separator:a04d63f6f60c90f8e3c4029824a7352b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 115 <tr class="memitem:a177ecbfe7701c2ac04bb8bdeb208773a"><td class="memItemLeft" align="right" valign="top"><a id="a177ecbfe7701c2ac04bb8bdeb208773a"></a>
 116 #define&#160;</td><td class="memItemRight" valign="bottom"><b>MUTILS_BOOL2STR</b>(X)&#160;&#160;&#160;((X) ? &quot;1&quot; : &quot;0&quot;)</td></tr>
 117 <tr class="separator:a177ecbfe7701c2ac04bb8bdeb208773a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 </table><table class="memberdecls">
 119 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 120 Functions</h2></td></tr>
 121 <tr class="memitem:a9ddb9a2039585b1ef3429db16ea84292"><td class="memItemLeft" align="right" valign="top">const QString &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a9ddb9a2039585b1ef3429db16ea84292">MUtils::temp_folder</a> (void)</td></tr>
 122 <tr class="memdesc:a9ddb9a2039585b1ef3429db16ea84292"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rerieves the full path of the application's <em>Temp</em> folder.  <a href="../../d5/d3b/_global_8h.html#a9ddb9a2039585b1ef3429db16ea84292">More...</a><br /></td></tr>
 123 <tr class="separator:a9ddb9a2039585b1ef3429db16ea84292"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <tr class="memitem:a5a94d9552ee93a19722fdb411e580340"><td class="memItemLeft" align="right" valign="top"><a id="a5a94d9552ee93a19722fdb411e580340"></a>
 125 void&#160;</td><td class="memItemRight" valign="bottom"><b>MUtils::init_process</b> (QProcess &amp;process, const QString &amp;wokringDir, const bool bReplaceTempDir=true, const QStringList *const extraPaths=NULL)</td></tr>
 126 <tr class="separator:a5a94d9552ee93a19722fdb411e580340"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:a4dc7dccb81653ae28e0d37a7c2f62112"><td class="memItemLeft" align="right" valign="top">quint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a4dc7dccb81653ae28e0d37a7c2f62112">MUtils::next_rand_u32</a> (void)</td></tr>
 128 <tr class="memdesc:a4dc7dccb81653ae28e0d37a7c2f62112"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a <em>random</em> unsigned 32-Bit value.  <a href="../../d5/d3b/_global_8h.html#a4dc7dccb81653ae28e0d37a7c2f62112">More...</a><br /></td></tr>
 129 <tr class="separator:a4dc7dccb81653ae28e0d37a7c2f62112"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 <tr class="memitem:a15762bf5b0239e5f67a3815d63ed441a"><td class="memItemLeft" align="right" valign="top">quint64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a15762bf5b0239e5f67a3815d63ed441a">MUtils::next_rand_u64</a> (void)</td></tr>
 131 <tr class="memdesc:a15762bf5b0239e5f67a3815d63ed441a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a <em>random</em> unsigned 64-Bit value.  <a href="../../d5/d3b/_global_8h.html#a15762bf5b0239e5f67a3815d63ed441a">More...</a><br /></td></tr>
 132 <tr class="separator:a15762bf5b0239e5f67a3815d63ed441a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:a996b60884ddf7728178e94f34ca12570"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a996b60884ddf7728178e94f34ca12570">MUtils::next_rand_str</a> (const bool &amp;bLong=false)</td></tr>
 134 <tr class="memdesc:a996b60884ddf7728178e94f34ca12570"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a <em>random</em> string.  <a href="../../d5/d3b/_global_8h.html#a996b60884ddf7728178e94f34ca12570">More...</a><br /></td></tr>
 135 <tr class="separator:a996b60884ddf7728178e94f34ca12570"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:a67cb16c62b213da5135a6fa076f3f005"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a67cb16c62b213da5135a6fa076f3f005">MUtils::make_temp_file</a> (const QString &amp;basePath, const QString &amp;extension, const bool placeholder=false)</td></tr>
 137 <tr class="memdesc:a67cb16c62b213da5135a6fa076f3f005"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a temporary file name.  <a href="../../d5/d3b/_global_8h.html#a67cb16c62b213da5135a6fa076f3f005">More...</a><br /></td></tr>
 138 <tr class="separator:a67cb16c62b213da5135a6fa076f3f005"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a390e56e35eb9329d2e67fa9741d07536"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a390e56e35eb9329d2e67fa9741d07536">MUtils::make_unique_file</a> (const QString &amp;basePath, const QString &amp;baseName, const QString &amp;extension, const bool fancy=false)</td></tr>
 140 <tr class="memdesc:a390e56e35eb9329d2e67fa9741d07536"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a unique file name.  <a href="../../d5/d3b/_global_8h.html#a390e56e35eb9329d2e67fa9741d07536">More...</a><br /></td></tr>
 141 <tr class="separator:a390e56e35eb9329d2e67fa9741d07536"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:ad1bdb5e416839b1f85f6df68e58ae28c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#ad1bdb5e416839b1f85f6df68e58ae28c">MUtils::parity</a> (quint32 value)</td></tr>
 143 <tr class="memdesc:ad1bdb5e416839b1f85f6df68e58ae28c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the <em>parity</em> of the given unsigned 32-Bit value.  <a href="../../d5/d3b/_global_8h.html#ad1bdb5e416839b1f85f6df68e58ae28c">More...</a><br /></td></tr>
 144 <tr class="separator:ad1bdb5e416839b1f85f6df68e58ae28c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:a12259acdd6aff74ee83819d3aebd8ba9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9">MUtils::remove_file</a> (const QString &amp;fileName)</td></tr>
 146 <tr class="memdesc:a12259acdd6aff74ee83819d3aebd8ba9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes the specified file.  <a href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9">More...</a><br /></td></tr>
 147 <tr class="separator:a12259acdd6aff74ee83819d3aebd8ba9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:ac7d2c9bd5c49230b2fed72e3410c3f7d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#ac7d2c9bd5c49230b2fed72e3410c3f7d">MUtils::remove_directory</a> (const QString &amp;folderPath, const bool &amp;recursive)</td></tr>
 149 <tr class="memdesc:ac7d2c9bd5c49230b2fed72e3410c3f7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recursively deletes the specified directory.  <a href="../../d5/d3b/_global_8h.html#ac7d2c9bd5c49230b2fed72e3410c3f7d">More...</a><br /></td></tr>
 150 <tr class="separator:ac7d2c9bd5c49230b2fed72e3410c3f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:a9290a3fe637a05ad2a7515f36fad79bd"><td class="memItemLeft" align="right" valign="top">QString &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a9290a3fe637a05ad2a7515f36fad79bd">MUtils::trim_right</a> (QString &amp;str)</td></tr>
 152 <tr class="memdesc:a9290a3fe637a05ad2a7515f36fad79bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove <em>trailing</em> white-space characters.  <a href="../../d5/d3b/_global_8h.html#a9290a3fe637a05ad2a7515f36fad79bd">More...</a><br /></td></tr>
 153 <tr class="separator:a9290a3fe637a05ad2a7515f36fad79bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:af089c8a40b6ec2e19db3fe612aa81c8c"><td class="memItemLeft" align="right" valign="top">QString &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#af089c8a40b6ec2e19db3fe612aa81c8c">MUtils::trim_left</a> (QString &amp;str)</td></tr>
 155 <tr class="memdesc:af089c8a40b6ec2e19db3fe612aa81c8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove <em>leading</em> white-space characters.  <a href="../../d5/d3b/_global_8h.html#af089c8a40b6ec2e19db3fe612aa81c8c">More...</a><br /></td></tr>
 156 <tr class="separator:af089c8a40b6ec2e19db3fe612aa81c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:a3eb47d6ca49b2700622e3fe99faf14d8"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a3eb47d6ca49b2700622e3fe99faf14d8">MUtils::trim_right</a> (const QString &amp;str)</td></tr>
 158 <tr class="memdesc:a3eb47d6ca49b2700622e3fe99faf14d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove <em>trailing</em> white-space characters.  <a href="../../d5/d3b/_global_8h.html#a3eb47d6ca49b2700622e3fe99faf14d8">More...</a><br /></td></tr>
 159 <tr class="separator:a3eb47d6ca49b2700622e3fe99faf14d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:a8680aeaeb1118353bd099e26ba7d6123"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a8680aeaeb1118353bd099e26ba7d6123">MUtils::trim_left</a> (const QString &amp;str)</td></tr>
 161 <tr class="memdesc:a8680aeaeb1118353bd099e26ba7d6123"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove <em>trailing</em> white-space characters.  <a href="../../d5/d3b/_global_8h.html#a8680aeaeb1118353bd099e26ba7d6123">More...</a><br /></td></tr>
 162 <tr class="separator:a8680aeaeb1118353bd099e26ba7d6123"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 <tr class="memitem:a09e919d419ded903481cf7aba702dcba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a09e919d419ded903481cf7aba702dcba">MUtils::natural_string_sort</a> (QStringList &amp;list, const bool bIgnoreCase)</td></tr>
 164 <tr class="memdesc:a09e919d419ded903481cf7aba702dcba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sort a list of strings using "natural ordering" algorithm.  <a href="../../d5/d3b/_global_8h.html#a09e919d419ded903481cf7aba702dcba">More...</a><br /></td></tr>
 165 <tr class="separator:a09e919d419ded903481cf7aba702dcba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 166 <tr class="memitem:a895e14458df7226110ae70029c1729a9"><td class="memItemLeft" align="right" valign="top"><a id="a895e14458df7226110ae70029c1729a9"></a>
 167 QString&#160;</td><td class="memItemRight" valign="bottom"><b>MUtils::clean_file_name</b> (const QString &amp;name)</td></tr>
 168 <tr class="separator:a895e14458df7226110ae70029c1729a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <tr class="memitem:ac0949226be088ce65a60d5aa4194e1c0"><td class="memItemLeft" align="right" valign="top"><a id="ac0949226be088ce65a60d5aa4194e1c0"></a>
 170 QString&#160;</td><td class="memItemRight" valign="bottom"><b>MUtils::clean_file_path</b> (const QString &amp;path)</td></tr>
 171 <tr class="separator:ac0949226be088ce65a60d5aa4194e1c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 172 <tr class="memitem:a45cb0d1e6a55cf5ffda3b626c25fd957"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a45cb0d1e6a55cf5ffda3b626c25fd957">MUtils::regexp_parse_uint32</a> (const QRegExp &amp;regexp, quint32 &amp;value)</td></tr>
 173 <tr class="memdesc:a45cb0d1e6a55cf5ffda3b626c25fd957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse regular expression results.  <a href="../../d5/d3b/_global_8h.html#a45cb0d1e6a55cf5ffda3b626c25fd957">More...</a><br /></td></tr>
 174 <tr class="separator:a45cb0d1e6a55cf5ffda3b626c25fd957"><td class="memSeparator" colspan="2">&#160;</td></tr>
 175 <tr class="memitem:a367969a260da994876d19c9f7ee40606"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a367969a260da994876d19c9f7ee40606">MUtils::regexp_parse_uint32</a> (const QRegExp &amp;regexp, quint32 *values, const size_t &amp;count)</td></tr>
 176 <tr class="memdesc:a367969a260da994876d19c9f7ee40606"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse regular expression results.  <a href="../../d5/d3b/_global_8h.html#a367969a260da994876d19c9f7ee40606">More...</a><br /></td></tr>
 177 <tr class="separator:a367969a260da994876d19c9f7ee40606"><td class="memSeparator" colspan="2">&#160;</td></tr>
 178 <tr class="memitem:a4fcbdafffc1224776616fcc6aec8278b"><td class="memItemLeft" align="right" valign="top">QStringList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d3b/_global_8h.html#a4fcbdafffc1224776616fcc6aec8278b">MUtils::available_codepages</a> (const bool &amp;noAliases=true)</td></tr>
 179 <tr class="memdesc:a4fcbdafffc1224776616fcc6aec8278b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve a list of all available codepages.  <a href="../../d5/d3b/_global_8h.html#a4fcbdafffc1224776616fcc6aec8278b">More...</a><br /></td></tr>
 180 <tr class="separator:a4fcbdafffc1224776616fcc6aec8278b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 </table>
 182 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 183 <div class="textblock"><p>This file contains miscellaneous functions that are generally useful for Qt-based applications. </p>
 184 </div><h2 class="groupheader">Function Documentation</h2>
 185 <a id="file_a4fcbdafffc1224776616fcc6aec8278b"></a>
 186 <h2 class="memtitle"><span class="permalink"><a href="#file_a4fcbdafffc1224776616fcc6aec8278b">&sect;&nbsp;</a></span>available_codepages()</h2>
 187
 188 <div class="memitem">
 189 <div class="memproto">
 190       <table class="memname">
 191         <tr>
 192           <td class="memname">QStringList MUtils::available_codepages </td>
 193           <td>(</td>
 194           <td class="paramtype">const bool &amp;&#160;</td>
 195           <td class="paramname"><em>noAliases</em> = <code>true</code></td><td>)</td>
 196           <td></td>
 197         </tr>
 198       </table>
 199 </div><div class="memdoc">
 200
 201 <p>Retrieve a list of all available codepages. </p>
 202 <p>The function generates a list of all codepages that are available on the system. Each codepage name returned by this function may be passed to the <code>QTextCodec::codecForName()</code> function in order to obtain a corresponding <a href="http://doc.qt.io/qt-4.8/qtextcodec.html">QTextCodec</a> object.</p>
 203 <dl class="params"><dt>Parameters</dt><dd>
 204   <table class="params">
 205     <tr><td class="paramname">noAliases</td><td>If set to <code>true</code>, only distinct codepages are returned, i.e. any codepage aliases are discarded from the list; if set to <code>false</code>, the returned list may (and usually will) also contain codepage aliases.</td></tr>
 206   </table>
 207   </dd>
 208 </dl>
 209 <dl class="section return"><dt>Returns</dt><dd>If the function succeeds, it returns a QStringList holding the names of all codepages available on the system; otherwise it returns a default-constructed QStringList. </dd></dl>
 210
 211 </div>
 212 </div>
 213 <a id="file_a67cb16c62b213da5135a6fa076f3f005"></a>
 214 <h2 class="memtitle"><span class="permalink"><a href="#file_a67cb16c62b213da5135a6fa076f3f005">&sect;&nbsp;</a></span>make_temp_file()</h2>
 215
 216 <div class="memitem">
 217 <div class="memproto">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname">QString MUtils::make_temp_file </td>
 221           <td>(</td>
 222           <td class="paramtype">const QString &amp;&#160;</td>
 223           <td class="paramname"><em>basePath</em>, </td>
 224         </tr>
 225         <tr>
 226           <td class="paramkey"></td>
 227           <td></td>
 228           <td class="paramtype">const QString &amp;&#160;</td>
 229           <td class="paramname"><em>extension</em>, </td>
 230         </tr>
 231         <tr>
 232           <td class="paramkey"></td>
 233           <td></td>
 234           <td class="paramtype">const bool&#160;</td>
 235           <td class="paramname"><em>placeholder</em> = <code>false</code>&#160;</td>
 236         </tr>
 237         <tr>
 238           <td></td>
 239           <td>)</td>
 240           <td></td><td></td>
 241         </tr>
 242       </table>
 243 </div><div class="memdoc">
 244
 245 <p>Generates a temporary file name. </p>
 246 <p>The function generates a file name that contains a <em>random</em> component and that is guaranteed to <b>not</b> exist yet. The generated file name follows a <code>"&lt;basedir&gt;/&lt;random&gt;.&lt;ext&gt;"</code> pattern. This is useful (not only) for creating temporary files.</p>
 247 <dl class="params"><dt>Parameters</dt><dd>
 248   <table class="params">
 249     <tr><td class="paramname">basePath</td><td>Specifies the "base" directory where the temporary file is supposed to be created. This must be a valid <em>existing</em> directory.</td></tr>
 250     <tr><td class="paramname">extension</td><td>Specifies the desired file extensions of the temporary file. Do <b>not</b> include a leading dot (<code>.</code>) character.</td></tr>
 251     <tr><td class="paramname">placeholder</td><td>If set to <code>true</code>, the function creates an empty "placeholder" file under the returned file name; if set to <code>false</code>, it does <em>not</em>.</td></tr>
 252   </table>
 253   </dd>
 254 </dl>
 255 <dl class="section return"><dt>Returns</dt><dd>If the function succeeds, it returns a QString holding the full path of the temporary file; otherwise it returns a default-constructed QString. </dd></dl>
 256
 257 </div>
 258 </div>
 259 <a id="file_a390e56e35eb9329d2e67fa9741d07536"></a>
 260 <h2 class="memtitle"><span class="permalink"><a href="#file_a390e56e35eb9329d2e67fa9741d07536">&sect;&nbsp;</a></span>make_unique_file()</h2>
 261
 262 <div class="memitem">
 263 <div class="memproto">
 264       <table class="memname">
 265         <tr>
 266           <td class="memname">QString MUtils::make_unique_file </td>
 267           <td>(</td>
 268           <td class="paramtype">const QString &amp;&#160;</td>
 269           <td class="paramname"><em>basePath</em>, </td>
 270         </tr>
 271         <tr>
 272           <td class="paramkey"></td>
 273           <td></td>
 274           <td class="paramtype">const QString &amp;&#160;</td>
 275           <td class="paramname"><em>baseName</em>, </td>
 276         </tr>
 277         <tr>
 278           <td class="paramkey"></td>
 279           <td></td>
 280           <td class="paramtype">const QString &amp;&#160;</td>
 281           <td class="paramname"><em>extension</em>, </td>
 282         </tr>
 283         <tr>
 284           <td class="paramkey"></td>
 285           <td></td>
 286           <td class="paramtype">const bool&#160;</td>
 287           <td class="paramname"><em>fancy</em> = <code>false</code>&#160;</td>
 288         </tr>
 289         <tr>
 290           <td></td>
 291           <td>)</td>
 292           <td></td><td></td>
 293         </tr>
 294       </table>
 295 </div><div class="memdoc">
 296
 297 <p>Generates a unique file name. </p>
 298 <p>The function generates a unique file name in the specified directory. The function guarantees that the returned file name does <em>not</em> exist yet. If necessary, a <em>counter</em> will be included in the file name in order to ensure its uniqueness.</p>
 299 <dl class="params"><dt>Parameters</dt><dd>
 300   <table class="params">
 301     <tr><td class="paramname">basePath</td><td>Specifies the "base" directory where the unique file is supposed to be created. This must be a valid <em>existing</em> directory.</td></tr>
 302     <tr><td class="paramname">baseName</td><td>Specifies the desired "base" file name of the unique file. Do <b>not</b> include a file extension.</td></tr>
 303     <tr><td class="paramname">extension</td><td>Specifies the desired file extensions of the unique file. Do <b>not</b> include a leading dot (<code>.</code>) character.</td></tr>
 304     <tr><td class="paramname">fancy</td><td>If set to <code>true</code>, the file name is generated according to the <code>"&lt;basedir&gt;/&lt;basename&gt; (N).&lt;ext&gt;"</code> pattern; if set to <code>false</code>, the file name is generated according to the <code>"&lt;basedir&gt;/&lt;basename&gt;.XXXX.&lt;ext&gt;"</code> pattern.</td></tr>
 305   </table>
 306   </dd>
 307 </dl>
 308 <dl class="section return"><dt>Returns</dt><dd>If the function succeeds, it returns a QString holding the full path of the unique file; otherwise it returns a default-constructed QString. </dd></dl>
 309
 310 </div>
 311 </div>
 312 <a id="file_a09e919d419ded903481cf7aba702dcba"></a>
 313 <h2 class="memtitle"><span class="permalink"><a href="#file_a09e919d419ded903481cf7aba702dcba">&sect;&nbsp;</a></span>natural_string_sort()</h2>
 314
 315 <div class="memitem">
 316 <div class="memproto">
 317       <table class="memname">
 318         <tr>
 319           <td class="memname">void MUtils::natural_string_sort </td>
 320           <td>(</td>
 321           <td class="paramtype">QStringList &amp;&#160;</td>
 322           <td class="paramname"><em>list</em>, </td>
 323         </tr>
 324         <tr>
 325           <td class="paramkey"></td>
 326           <td></td>
 327           <td class="paramtype">const bool&#160;</td>
 328           <td class="paramname"><em>bIgnoreCase</em>&#160;</td>
 329         </tr>
 330         <tr>
 331           <td></td>
 332           <td>)</td>
 333           <td></td><td></td>
 334         </tr>
 335       </table>
 336 </div><div class="memdoc">
 337
 338 <p>Sort a list of strings using "natural ordering" algorithm. </p>
 339 <p>This function implements a sort algorithm that orders alphanumeric strings in the way a human being would. See <a href="http://sourcefrog.net/projects/natsort/"><em>Natural Order String Comparison</em></a> for details!</p>
 340 <dl class="params"><dt>Parameters</dt><dd>
 341   <table class="params">
 342     <tr><td class="paramname">list</td><td>A reference to the QStringList object to be sorted. The list will be sorted "in place".</td></tr>
 343     <tr><td class="paramname">bIgnoreCase</td><td>If set to <code>true</code>, the list will be sorted disregarding the character case, i.e. upper-case and lower-case characters (of the same letter) are treated the same; if set to <code>false</code>, the character case <em>is</em> taken into account. </td></tr>
 344   </table>
 345   </dd>
 346 </dl>
 347
 348 </div>
 349 </div>
 350 <a id="file_a996b60884ddf7728178e94f34ca12570"></a>
 351 <h2 class="memtitle"><span class="permalink"><a href="#file_a996b60884ddf7728178e94f34ca12570">&sect;&nbsp;</a></span>next_rand_str()</h2>
 352
 353 <div class="memitem">
 354 <div class="memproto">
 355       <table class="memname">
 356         <tr>
 357           <td class="memname">QString MUtils::next_rand_str </td>
 358           <td>(</td>
 359           <td class="paramtype">const bool &amp;&#160;</td>
 360           <td class="paramname"><em>bLong</em> = <code>false</code></td><td>)</td>
 361           <td></td>
 362         </tr>
 363       </table>
 364 </div><div class="memdoc">
 365
 366 <p>Generates a <em>random</em> string. </p>
 367 <p>The random string is generated using the same PRNG as the <code><a class="el" href="../../d5/d3b/_global_8h.html#a15762bf5b0239e5f67a3815d63ed441a" title="Generates a random unsigned 64-Bit value. ">next_rand_u64()</a></code> function. The <em>random</em> bytes are converted to a hexadecimal string and, if necessary, zero-padded to a toal length of 16 or 32 characters. There is <b>no</b> <code>0x</code>-prefix included in the result.</p>
 368 <dl class="params"><dt>Parameters</dt><dd>
 369   <table class="params">
 370     <tr><td class="paramname">bLong</td><td>If set to <code>true</code>, a "long" random string (32 characters) will be generated; if set to <code>false</code>, a "short" random string (16 characters) is generated.</td></tr>
 371   </table>
 372   </dd>
 373 </dl>
 374 <dl class="section return"><dt>Returns</dt><dd>The function returns a QString holding a <em>random</em> hexadecimal string </dd></dl>
 375
 376 </div>
 377 </div>
 378 <a id="file_a4dc7dccb81653ae28e0d37a7c2f62112"></a>
 379 <h2 class="memtitle"><span class="permalink"><a href="#file_a4dc7dccb81653ae28e0d37a7c2f62112">&sect;&nbsp;</a></span>next_rand_u32()</h2>
 380
 381 <div class="memitem">
 382 <div class="memproto">
 383       <table class="memname">
 384         <tr>
 385           <td class="memname">quint32 MUtils::next_rand_u32 </td>
 386           <td>(</td>
 387           <td class="paramtype">void&#160;</td>
 388           <td class="paramname"></td><td>)</td>
 389           <td></td>
 390         </tr>
 391       </table>
 392 </div><div class="memdoc">
 393
 394 <p>Generates a <em>random</em> unsigned 32-Bit value. </p>
 395 <p>The <em>random</em> value is created using a "strong" PRNG of the underlying system, if possible. Otherwise a fallback PRNG is used. It is <b>not</b> required or useful to call <code>srand()</code> or <code>qsrand()</code> prior to using this function. If necessary, the seeding of the PRNG happen <em>automatically</em> on the first call.</p>
 396 <dl class="section return"><dt>Returns</dt><dd>The function returns a <em>random</em> unsigned 32-Bit value. </dd></dl>
 397
 398 </div>
 399 </div>
 400 <a id="file_a15762bf5b0239e5f67a3815d63ed441a"></a>
 401 <h2 class="memtitle"><span class="permalink"><a href="#file_a15762bf5b0239e5f67a3815d63ed441a">&sect;&nbsp;</a></span>next_rand_u64()</h2>
 402
 403 <div class="memitem">
 404 <div class="memproto">
 405       <table class="memname">
 406         <tr>
 407           <td class="memname">quint64 MUtils::next_rand_u64 </td>
 408           <td>(</td>
 409           <td class="paramtype">void&#160;</td>
 410           <td class="paramname"></td><td>)</td>
 411           <td></td>
 412         </tr>
 413       </table>
 414 </div><div class="memdoc">
 415
 416 <p>Generates a <em>random</em> unsigned 64-Bit value. </p>
 417 <p>The <em>random</em> value is created using a "strong" PRNG of the underlying system, if possible. Otherwise a fallback PRNG is used. It is <b>not</b> required or useful to call <code>srand()</code> or <code>qsrand()</code> prior to using this function. If necessary, the seeding of the PRNG happen <em>automatically</em> on the first call.</p>
 418 <dl class="section return"><dt>Returns</dt><dd>The function returns a <em>random</em> unsigned 64-Bit value. </dd></dl>
 419
 420 </div>
 421 </div>
 422 <a id="file_ad1bdb5e416839b1f85f6df68e58ae28c"></a>
 423 <h2 class="memtitle"><span class="permalink"><a href="#file_ad1bdb5e416839b1f85f6df68e58ae28c">&sect;&nbsp;</a></span>parity()</h2>
 424
 425 <div class="memitem">
 426 <div class="memproto">
 427       <table class="memname">
 428         <tr>
 429           <td class="memname">bool MUtils::parity </td>
 430           <td>(</td>
 431           <td class="paramtype">quint32&#160;</td>
 432           <td class="paramname"><em>value</em></td><td>)</td>
 433           <td></td>
 434         </tr>
 435       </table>
 436 </div><div class="memdoc">
 437
 438 <p>Computes the <em>parity</em> of the given unsigned 32-Bit value. </p>
 439 <dl class="params"><dt>Parameters</dt><dd>
 440   <table class="params">
 441     <tr><td class="paramname">value</td><td>The 32-Bit unsigned value from which the parity is to be computed.</td></tr>
 442   </table>
 443   </dd>
 444 </dl>
 445 <dl class="section return"><dt>Returns</dt><dd>The function returns <code>true</code>, if the number of <b>1</b> bits in the given value is <em>odd</em>; it returns <code>false</code>, if the number of <b>1</b> bits in the given value is <em>even</em>. </dd></dl>
 446
 447 </div>
 448 </div>
 449 <a id="file_a45cb0d1e6a55cf5ffda3b626c25fd957"></a>
 450 <h2 class="memtitle"><span class="permalink"><a href="#file_a45cb0d1e6a55cf5ffda3b626c25fd957">&sect;&nbsp;</a></span>regexp_parse_uint32() <span class="overload">[1/2]</span></h2>
 451
 452 <div class="memitem">
 453 <div class="memproto">
 454       <table class="memname">
 455         <tr>
 456           <td class="memname">bool MUtils::regexp_parse_uint32 </td>
 457           <td>(</td>
 458           <td class="paramtype">const QRegExp &amp;&#160;</td>
 459           <td class="paramname"><em>regexp</em>, </td>
 460         </tr>
 461         <tr>
 462           <td class="paramkey"></td>
 463           <td></td>
 464           <td class="paramtype">quint32 &amp;&#160;</td>
 465           <td class="paramname"><em>value</em>&#160;</td>
 466         </tr>
 467         <tr>
 468           <td></td>
 469           <td>)</td>
 470           <td></td><td></td>
 471         </tr>
 472       </table>
 473 </div><div class="memdoc">
 474
 475 <p>Parse regular expression results. </p>
 476 <p>This function tries to parses the result (capture) of a regular expression as an unsigned 32-Bit value. The given regular expression must contain at least <em>one</em> capture. Only the <em>first</em> capture is considered, additional captures are ignored.</p>
 477 <dl class="params"><dt>Parameters</dt><dd>
 478   <table class="params">
 479     <tr><td class="paramname">regexp</td><td>A read-only reference to the <a href="http://doc.qt.io/qt-4.8/qregexp.html">QRegExp</a> object whose result (capture) will be parsed. This <a href="http://doc.qt.io/qt-4.8/qregexp.html">QRegExp</a> must already have been <em>successfully</em> matched against the respective input string, e.g. via <code>QRegExp::indexIn()</code>, prior to calling this function.</td></tr>
 480     <tr><td class="paramname">value</td><td>A reference to a variable of type <code>quint32</code>, where the unsigned 32-Bit representation of the result will be stored. The contents of this variable are <em>undefined</em>, if the function failed.</td></tr>
 481   </table>
 482   </dd>
 483 </dl>
 484 <dl class="section return"><dt>Returns</dt><dd>The function returns <code>true</code>, if the regular expression's capture could be parsed successfully; it returns <code>false</code>, if the capture contains an invalid string or if there are insufficient captures in given the <a href="http://doc.qt.io/qt-4.8/qregexp.html">QRegExp</a> object. </dd></dl>
 485
 486 </div>
 487 </div>
 488 <a id="file_a367969a260da994876d19c9f7ee40606"></a>
 489 <h2 class="memtitle"><span class="permalink"><a href="#file_a367969a260da994876d19c9f7ee40606">&sect;&nbsp;</a></span>regexp_parse_uint32() <span class="overload">[2/2]</span></h2>
 490
 491 <div class="memitem">
 492 <div class="memproto">
 493       <table class="memname">
 494         <tr>
 495           <td class="memname">bool MUtils::regexp_parse_uint32 </td>
 496           <td>(</td>
 497           <td class="paramtype">const QRegExp &amp;&#160;</td>
 498           <td class="paramname"><em>regexp</em>, </td>
 499         </tr>
 500         <tr>
 501           <td class="paramkey"></td>
 502           <td></td>
 503           <td class="paramtype">quint32 *&#160;</td>
 504           <td class="paramname"><em>values</em>, </td>
 505         </tr>
 506         <tr>
 507           <td class="paramkey"></td>
 508           <td></td>
 509           <td class="paramtype">const size_t &amp;&#160;</td>
 510           <td class="paramname"><em>count</em>&#160;</td>
 511         </tr>
 512         <tr>
 513           <td></td>
 514           <td>)</td>
 515           <td></td><td></td>
 516         </tr>
 517       </table>
 518 </div><div class="memdoc">
 519
 520 <p>Parse regular expression results. </p>
 521 <p>This function tries to parses the results (captures) of a regular expression as unsigned 32-Bit values. The given regular expression must contain at least <code>count</code> captures. Only the <em>first</em> <code>count</code> captures are considered, additional captures are ignored.</p>
 522 <dl class="params"><dt>Parameters</dt><dd>
 523   <table class="params">
 524     <tr><td class="paramname">regexp</td><td>A read-only reference to the <a href="http://doc.qt.io/qt-4.8/qregexp.html">QRegExp</a> object whose results (captures) will be parsed. This <a href="http://doc.qt.io/qt-4.8/qregexp.html">QRegExp</a> must already have been <em>successfully</em> matched against the respective input string, e.g. via <code>QRegExp::indexIn()</code>, prior to calling this function.</td></tr>
 525     <tr><td class="paramname">value</td><td>A pointer to an array of type <code>quint32</code>, where the unsigned 32-Bit representations of the results will be stored (the <code>n</code>-th result is stored at <code>value[n-1]</code>). The array must be at least <code>count</code> elements in length. The contents of this array are <em>undefined</em>, if the function failed.</td></tr>
 526     <tr><td class="paramname">count</td><td>Specifies the number of results (captures) in the given <a href="http://doc.qt.io/qt-4.8/qregexp.html">QRegExp</a> object. The function tries to parse the first <code>count</code> captures and ignores any additional captures that may exist. This parameter also determines the required (minimum) length of the <code>value</code> array.</td></tr>
 527   </table>
 528   </dd>
 529 </dl>
 530 <dl class="section return"><dt>Returns</dt><dd>The function returns <code>true</code>, if all of the regular expression's captures could be parsed successfully; it returns <code>false</code>, if any of the captures contain an invalid string or if there are insufficient captures in given the <a href="http://doc.qt.io/qt-4.8/qregexp.html">QRegExp</a> object. </dd></dl>
 531
 532 </div>
 533 </div>
 534 <a id="file_ac7d2c9bd5c49230b2fed72e3410c3f7d"></a>
 535 <h2 class="memtitle"><span class="permalink"><a href="#file_ac7d2c9bd5c49230b2fed72e3410c3f7d">&sect;&nbsp;</a></span>remove_directory()</h2>
 536
 537 <div class="memitem">
 538 <div class="memproto">
 539       <table class="memname">
 540         <tr>
 541           <td class="memname">bool MUtils::remove_directory </td>
 542           <td>(</td>
 543           <td class="paramtype">const QString &amp;&#160;</td>
 544           <td class="paramname"><em>folderPath</em>, </td>
 545         </tr>
 546         <tr>
 547           <td class="paramkey"></td>
 548           <td></td>
 549           <td class="paramtype">const bool &amp;&#160;</td>
 550           <td class="paramname"><em>recursive</em>&#160;</td>
 551         </tr>
 552         <tr>
 553           <td></td>
 554           <td>)</td>
 555           <td></td><td></td>
 556         </tr>
 557       </table>
 558 </div><div class="memdoc">
 559
 560 <p>Recursively deletes the specified directory. </p>
 561 <p>The function deletes the specified directory. In <em>recursive</em> mode, the directory will be removed including all of its files and sub-directories. Files are deleted using the <code><a class="el" href="../../d5/d3b/_global_8h.html#a12259acdd6aff74ee83819d3aebd8ba9" title="Deletes the specified file. ">remove_file()</a></code> function.</p>
 562 <dl class="params"><dt>Parameters</dt><dd>
 563   <table class="params">
 564     <tr><td class="paramname">folderPath</td><td>The path to the directory to be deleted. This should be a full path.</td></tr>
 565     <tr><td class="paramname">recursive</td><td>If set to <code>true</code> the function removes all files and sub-directories in the specified directory; if set to <code>false</code>, the function will <em>not</em> try to delete any files or sub-directories, which means that it will fail on non-empty directories.</td></tr>
 566   </table>
 567   </dd>
 568 </dl>
 569 <dl class="section return"><dt>Returns</dt><dd>The function returns <code>true</code>, if the directory was deleted successfully or if the directory doesn't exist; it returns <code>false</code>, if the directory could <em>not</em> be deleted. </dd></dl>
 570
 571 </div>
 572 </div>
 573 <a id="file_a12259acdd6aff74ee83819d3aebd8ba9"></a>
 574 <h2 class="memtitle"><span class="permalink"><a href="#file_a12259acdd6aff74ee83819d3aebd8ba9">&sect;&nbsp;</a></span>remove_file()</h2>
 575
 576 <div class="memitem">
 577 <div class="memproto">
 578       <table class="memname">
 579         <tr>
 580           <td class="memname">bool MUtils::remove_file </td>
 581           <td>(</td>
 582           <td class="paramtype">const QString &amp;&#160;</td>
 583           <td class="paramname"><em>fileName</em></td><td>)</td>
 584           <td></td>
 585         </tr>
 586       </table>
 587 </div><div class="memdoc">
 588
 589 <p>Deletes the specified file. </p>
 590 <p>The function deletes the specified file, even if it has the "read only" flag set. If the file is currently locked (e.g. by another process), the function retries multiple times to delete the file before it fails.</p>
 591 <dl class="params"><dt>Parameters</dt><dd>
 592   <table class="params">
 593     <tr><td class="paramname">fileName</td><td>The path to the file to be deleted. This should be a full path.</td></tr>
 594   </table>
 595   </dd>
 596 </dl>
 597 <dl class="section return"><dt>Returns</dt><dd>The function returns <code>true</code>, if the file was deleted successfully or if the file doesn't exist; it returns <code>false</code>, if the file could <em>not</em> be deleted. </dd></dl>
 598
 599 </div>
 600 </div>
 601 <a id="file_a9ddb9a2039585b1ef3429db16ea84292"></a>
 602 <h2 class="memtitle"><span class="permalink"><a href="#file_a9ddb9a2039585b1ef3429db16ea84292">&sect;&nbsp;</a></span>temp_folder()</h2>
 603
 604 <div class="memitem">
 605 <div class="memproto">
 606       <table class="memname">
 607         <tr>
 608           <td class="memname">const QString&amp; MUtils::temp_folder </td>
 609           <td>(</td>
 610           <td class="paramtype">void&#160;</td>
 611           <td class="paramname"></td><td>)</td>
 612           <td></td>
 613         </tr>
 614       </table>
 615 </div><div class="memdoc">
 616
 617 <p>Rerieves the full path of the application's <em>Temp</em> folder. </p>
 618 <p>The application's <em>Temp</em> folder is a unique application-specific folder, intended to store any temporary files that the application may need. It will be created when this function is called for the first time (lazy initialization); subsequent calls are guaranteed to return the same path. Usually the application's <em>Temp</em> folder will be created as a sub-folder of the system's global <em>Temp</em> folder, as indicated by the <code>TMP</code> or <code>TEMP</code> environment variables. However, it may be created at a different place (e.g. in the users <em>Profile</em> directory), if those environment variables don't point to a usable directory. In any case, this function makes sure that the application's <em>Temp</em> folder exists for the whole lifetime of the application and that it is writable. When the application terminates normally, the application's <em>Temp</em> folder and all files or sub-directories thereof will be <em>removed</em> automatically!</p>
 619 <dl class="section return"><dt>Returns</dt><dd>If the function succeeds, it returns a read-only reference to a QString holding the full path of the application's <em>Temp</em> folder; otherwise a read-only reference to a default-constructed QString is returned. </dd></dl>
 620
 621 </div>
 622 </div>
 623 <a id="file_af089c8a40b6ec2e19db3fe612aa81c8c"></a>
 624 <h2 class="memtitle"><span class="permalink"><a href="#file_af089c8a40b6ec2e19db3fe612aa81c8c">&sect;&nbsp;</a></span>trim_left() <span class="overload">[1/2]</span></h2>
 625
 626 <div class="memitem">
 627 <div class="memproto">
 628       <table class="memname">
 629         <tr>
 630           <td class="memname">QString&amp; MUtils::trim_left </td>
 631           <td>(</td>
 632           <td class="paramtype">QString &amp;&#160;</td>
 633           <td class="paramname"><em>str</em></td><td>)</td>
 634           <td></td>
 635         </tr>
 636       </table>
 637 </div><div class="memdoc">
 638
 639 <p>Remove <em>leading</em> white-space characters. </p>
 640 <p>The function removes all <em>leading</em> white-space characters from the specified string. Trailing white-space characters are <em>not</em> removed. White-space characters are defined by the <code>\s</code> character class.</p>
 641 <dl class="params"><dt>Parameters</dt><dd>
 642   <table class="params">
 643     <tr><td class="paramname">str</td><td>A reference to the QString object to be trimmed. This QString object will be modified directly.</td></tr>
 644   </table>
 645   </dd>
 646 </dl>
 647 <dl class="section return"><dt>Returns</dt><dd>A reference to the trimmed QString object. This is the same QString object that was specified in the <code>str</code> parameter. </dd></dl>
 648
 649 </div>
 650 </div>
 651 <a id="file_a8680aeaeb1118353bd099e26ba7d6123"></a>
 652 <h2 class="memtitle"><span class="permalink"><a href="#file_a8680aeaeb1118353bd099e26ba7d6123">&sect;&nbsp;</a></span>trim_left() <span class="overload">[2/2]</span></h2>
 653
 654 <div class="memitem">
 655 <div class="memproto">
 656       <table class="memname">
 657         <tr>
 658           <td class="memname">QString MUtils::trim_left </td>
 659           <td>(</td>
 660           <td class="paramtype">const QString &amp;&#160;</td>
 661           <td class="paramname"><em>str</em></td><td>)</td>
 662           <td></td>
 663         </tr>
 664       </table>
 665 </div><div class="memdoc">
 666
 667 <p>Remove <em>trailing</em> white-space characters. </p>
 668 <p>The function removes all <em>leading</em> white-space characters from the specified string. Trailing white-space characters are <em>not</em> removed. White-space characters are defined by the <code>\s</code> character class.</p>
 669 <dl class="params"><dt>Parameters</dt><dd>
 670   <table class="params">
 671     <tr><td class="paramname">str</td><td>A read-only reference to the QString object to be trimmed. The original QString object is <em>not</em> modified.</td></tr>
 672   </table>
 673   </dd>
 674 </dl>
 675 <dl class="section return"><dt>Returns</dt><dd>A new QString object that equals the original QString object, except that it has all <em>leading</em> white-space characters removed. </dd></dl>
 676
 677 </div>
 678 </div>
 679 <a id="file_a9290a3fe637a05ad2a7515f36fad79bd"></a>
 680 <h2 class="memtitle"><span class="permalink"><a href="#file_a9290a3fe637a05ad2a7515f36fad79bd">&sect;&nbsp;</a></span>trim_right() <span class="overload">[1/2]</span></h2>
 681
 682 <div class="memitem">
 683 <div class="memproto">
 684       <table class="memname">
 685         <tr>
 686           <td class="memname">QString&amp; MUtils::trim_right </td>
 687           <td>(</td>
 688           <td class="paramtype">QString &amp;&#160;</td>
 689           <td class="paramname"><em>str</em></td><td>)</td>
 690           <td></td>
 691         </tr>
 692       </table>
 693 </div><div class="memdoc">
 694
 695 <p>Remove <em>trailing</em> white-space characters. </p>
 696 <p>The function removes all <em>trailing</em> white-space characters from the specified string. Leading white-space characters are <em>not</em> removed. White-space characters are defined by the <code>\s</code> character class.</p>
 697 <dl class="params"><dt>Parameters</dt><dd>
 698   <table class="params">
 699     <tr><td class="paramname">str</td><td>A reference to the QString object to be trimmed. This QString object will be modified directly.</td></tr>
 700   </table>
 701   </dd>
 702 </dl>
 703 <dl class="section return"><dt>Returns</dt><dd>A reference to the trimmed QString object. This is the same QString object that was specified in the <code>str</code> parameter. </dd></dl>
 704
 705 </div>
 706 </div>
 707 <a id="file_a3eb47d6ca49b2700622e3fe99faf14d8"></a>
 708 <h2 class="memtitle"><span class="permalink"><a href="#file_a3eb47d6ca49b2700622e3fe99faf14d8">&sect;&nbsp;</a></span>trim_right() <span class="overload">[2/2]</span></h2>
 709
 710 <div class="memitem">
 711 <div class="memproto">
 712       <table class="memname">
 713         <tr>
 714           <td class="memname">QString MUtils::trim_right </td>
 715           <td>(</td>
 716           <td class="paramtype">const QString &amp;&#160;</td>
 717           <td class="paramname"><em>str</em></td><td>)</td>
 718           <td></td>
 719         </tr>
 720       </table>
 721 </div><div class="memdoc">
 722
 723 <p>Remove <em>trailing</em> white-space characters. </p>
 724 <p>The function removes all <em>trailing</em> white-space characters from the specified string. Leading white-space characters are <em>not</em> removed. White-space characters are defined by the <code>\s</code> character class.</p>
 725 <dl class="params"><dt>Parameters</dt><dd>
 726   <table class="params">
 727     <tr><td class="paramname">str</td><td>A read-only reference to the QString object to be trimmed. The original QString object is <em>not</em> modified.</td></tr>
 728   </table>
 729   </dd>
 730 </dl>
 731 <dl class="section return"><dt>Returns</dt><dd>A new QString object that equals the original QString object, except that it has all <em>trailing</em> white-space characters removed. </dd></dl>
 732
 733 </div>
 734 </div>
 735 </div><!-- contents -->
 736 <!-- start footer part -->
 737 <hr class="footer"/><address class="footer"><small>
 738 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 739 <img class="footer" src="../../doxygen.png" alt="doxygen"/>
 740 </a> 1.8.12
 741 </small></address>
 742 </body>
 743 </html>