MUtilities/docs/d5/d3b/_global_8h_source.html

102 lines
42 KiB
HTML
Raw Normal View History

<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MuldeR&#39;s Utilities for Qt: include/MUtils/Global.h Source File</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" />
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MuldeR&#39;s Utilities for Qt
</div>
<div id="projectbrief">MUtilities</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<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>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Global.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="../../d5/d3b/_global_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// MuldeR&#39;s Utilities for Qt</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Copyright (C) 2004-2019 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// This library is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// modify it under the terms of the GNU Lesser General Public</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// License as published by the Free Software Foundation; either</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// version 2.1 of the License, or (at your option) any later version.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// This library is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// Lesser General Public License for more details.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// License along with this library; if not, write to the Free Software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">// http://www.gnu.org/licenses/lgpl-2.1.txt</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;QString&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">//Forward Declarations</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">class </span>QProcess;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">class </span>QDir;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="../../d6/d9c/class_q_hash.html"> 34</a></span>&#160;<span class="ke
2018-04-02 18:34:29 +02:00
<div class="ttc" id="namespace_m_utils_html_a75209365a097871cb2bb8fc3a21ce14b"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a75209365a097871cb2bb8fc3a21ce14b">MUtils::fp_parts_t</a></div><div class="ttdeci">struct MUtils::_fp_parts_t fp_parts_t</div><div class="ttdoc">This struct containes the parts (integral and fractional part) of a floating-point number...</div></div>
2016-12-19 20:58:42 +01:00
<div class="ttc" id="namespace_m_utils_html_ac583617546d5ae100ce7436546d9662c"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#ac583617546d5ae100ce7436546d9662c">MUtils::next_rand_str</a></div><div class="ttdeci">MUTILS_API QString next_rand_str(const bool &amp;bLong=false)</div><div class="ttdoc">Generates a random string. </div></div>
<div class="ttc" id="namespace_m_utils_html_a5a14e75627eebd09efc37898d74c5ac6"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a5a14e75627eebd09efc37898d74c5ac6">MUtils::remove_file</a></div><div class="ttdeci">MUTILS_API bool remove_file(const QString &amp;fileName)</div><div class="ttdoc">Deletes the specified file. </div></div>
<div class="ttc" id="namespace_m_utils_html_adb5da6435b27e10443060dd2550784f3"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#adb5da6435b27e10443060dd2550784f3">MUtils::clean_file_path</a></div><div class="ttdeci">MUTILS_API QString clean_file_path(const QString &amp;path, const bool &amp;pretty)</div><div class="ttdoc">Clean up a file path string. </div></div>
<div class="ttc" id="struct_m_utils_1_1__fp__parts__t_html"><div class="ttname"><a href="../../da/d46/struct_m_utils_1_1__fp__parts__t.html">MUtils::_fp_parts_t</a></div><div class="ttdoc">This struct containes the parts (integral and fractional part) of a floating-point number...</div><div class="ttdef"><b>Definition:</b> Global.h:106</div></div>
<div class="ttc" id="namespace_m_utils_html_a9916e02e90bdb987b95b3cc9d463f949"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a9916e02e90bdb987b95b3cc9d463f949">MUtils::parent_path</a></div><div class="ttdeci">MUTILS_API QString parent_path(const QString &amp;path)</div><div class="ttdoc">Get parent path. </div></div>
2016-12-19 20:58:42 +01:00
<div class="ttc" id="namespace_m_utils_html_a4d4c545ea06892f6487f15a48808564f"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a4d4c545ea06892f6487f15a48808564f">MUtils::natural_string_sort</a></div><div class="ttdeci">MUTILS_API void natural_string_sort(QStringList &amp;list, const bool bIgnoreCase)</div><div class="ttdoc">Sort a list of strings using &quot;natural ordering&quot; algorithm. </div></div>
<div class="ttc" id="namespace_m_utils_html_ad2a851b289ee66873d3a1ec86f5f34eb"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#ad2a851b289ee66873d3a1ec86f5f34eb">MUtils::regexp_parse_uint32</a></div><div class="ttdeci">MUTILS_API bool regexp_parse_uint32(const QRegExp &amp;regexp, quint32 &amp;value)</div><div class="ttdoc">Parse regular expression results. </div></div>
<div class="ttc" id="namespace_m_utils_html_aea4a212153b09b24b04f30ef5159f29b"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#aea4a212153b09b24b04f30ef5159f29b">MUtils::parity</a></div><div class="ttdeci">MUTILS_API bool parity(quint32 value)</div><div class="ttdoc">Computes the parity of the given unsigned 32-Bit value. </div></div>
2018-04-02 18:34:29 +02:00
<div class="ttc" id="namespace_m_utils_html_adba57bb9c5055c3ed1d528cd2151b5a9"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#adba57bb9c5055c3ed1d528cd2151b5a9">MUtils::break_fp</a></div><div class="ttdeci">MUTILS_API fp_parts_t break_fp(const double value)</div><div class="ttdoc">Break floating-point number into fractional and integral parts. </div></div>
2016-12-19 20:58:42 +01:00
<div class="ttc" id="namespace_m_utils_html_ad7edd4aece64faf3aa16c9509243608c"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#ad7edd4aece64faf3aa16c9509243608c">MUtils::next_rand_u64</a></div><div class="ttdeci">MUTILS_API quint64 next_rand_u64(void)</div><div class="ttdoc">Generates a random unsigned 64-Bit value. </div></div>
<div class="ttc" id="namespace_m_utils_html_a6118cf23d2b771fae1ad159c7ea6686a"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a6118cf23d2b771fae1ad159c7ea6686a">MUtils::trim_right</a></div><div class="ttdeci">MUTILS_API QString &amp; trim_right(QString &amp;str)</div><div class="ttdoc">Remove trailing white-space characters. </div></div>
<div class="ttc" id="namespace_m_utils_html_a3f198156e8be91f3e74dd9ed69ffaa34"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a3f198156e8be91f3e74dd9ed69ffaa34">MUtils::temp_folder</a></div><div class="ttdeci">MUTILS_API const QString &amp; temp_folder(void)</div><div class="ttdoc">Rerieves the full path of the application&amp;#39;s Temp folder. </div></div>
2016-12-23 22:16:12 +01:00
<div class="ttc" id="namespace_m_utils_html"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html">MUtils</a></div><div class="ttdoc">Global MUtils namespace. </div><div class="ttdef"><b>Definition:</b> CPUFeatures.h:37</div></div>
<div class="ttc" id="namespace_m_utils_html_aeb7783b8ecbe163501ce60dce8b6709f"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#aeb7783b8ecbe163501ce60dce8b6709f">MUtils::clean_file_name</a></div><div class="ttdeci">MUTILS_API QString clean_file_name(const QString &amp;name, const bool &amp;pretty)</div><div class="ttdoc">Clean up a file name string. </div></div>
2016-12-19 20:58:42 +01:00
<div class="ttc" id="namespace_m_utils_html_a1c9832c1d645a2c90e9bd52d57d843b3"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a1c9832c1d645a2c90e9bd52d57d843b3">MUtils::next_rand_u32</a></div><div class="ttdeci">MUTILS_API quint32 next_rand_u32(void)</div><div class="ttdoc">Generates a random unsigned 32-Bit value. </div></div>
<div class="ttc" id="namespace_m_utils_html_a4d451ddc82668d1298f2922f62474b5d"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a4d451ddc82668d1298f2922f62474b5d">MUtils::remove_directory</a></div><div class="ttdeci">MUTILS_API bool remove_directory(const QString &amp;folderPath, const bool &amp;recursive)</div><div class="ttdoc">Recursively deletes the specified directory. </div></div>
<div class="ttc" id="namespace_m_utils_html_a29461116550863e8730f3f4ec479bbcb"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a29461116550863e8730f3f4ec479bbcb">MUtils::make_temp_file</a></div><div class="ttdeci">MUTILS_API QString make_temp_file(const QString &amp;basePath, const QString &amp;extension, const bool placeholder=false)</div><div class="ttdoc">Generates a temporary file name. </div></div>
2018-10-28 14:44:37 +01:00
<div class="ttc" id="namespace_m_utils_html_a80205a5816416cc49e8d9f524894132a"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a80205a5816416cc49e8d9f524894132a">MUtils::init_process</a></div><div class="ttdeci">MUTILS_API void init_process(QProcess &amp;process, const QString &amp;wokringDir, const bool bReplaceTempDir=true, const QStringList *const extraPaths=NULL, const QHash&lt; QString, QString &gt; *const extraEnv=NULL)</div><div class="ttdoc">Initialize a given QProcess object. </div></div>
2016-12-19 20:58:42 +01:00
<div class="ttc" id="namespace_m_utils_html_a20b8fc56856ee904caaded756399e705"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a20b8fc56856ee904caaded756399e705">MUtils::trim_left</a></div><div class="ttdeci">MUTILS_API QString &amp; trim_left(QString &amp;str)</div><div class="ttdoc">Remove leading white-space characters. </div></div>
2018-10-28 14:44:37 +01:00
<div class="ttc" id="class_q_hash_html"><div class="ttname"><a href="../../d6/d9c/class_q_hash.html">QHash</a></div><div class="ttdef"><b>Definition:</b> Global.h:34</div></div>
<div class="ttc" id="namespace_m_utils_html_a4d288d8fbe9a187cffe8db04e70df3de"><div class="ttname"><a href="../../d3/da6/namespace_m_utils.html#a4d288d8fbe9a187cffe8db04e70df3de">MUtils::make_unique_file</a></div><div class="ttdeci">MUTILS_API QString make_unique_file(const QString &amp;basePath, const QString &amp;baseName, const QString &amp;extension, const bool fancy=false, const bool placeholder=false)</div><div class="ttdoc">Generates a unique file name. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2016-12-19 17:09:58 +01:00
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>