docs/index.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: Main Page</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 </div><!-- top -->
  47 <!-- window showing the filter options -->
  48 <div id="MSearchSelectWindow"
  49      onmouseover="return searchBox.OnSearchSelectShow()"
  50      onmouseout="return searchBox.OnSearchSelectHide()"
  51      onkeydown="return searchBox.OnSearchSelectKey(event)">
  52 </div>
  53
  54 <!-- iframe showing the search results (closed by default) -->
  55 <div id="MSearchResultsWindow">
  56 <iframe src="javascript:void(0)" frameborder="0"
  57         name="MSearchResults" id="MSearchResults">
  58 </iframe>
  59 </div>
  60
  61 <div class="header">
  62   <div class="headertitle">
  63 <div class="title">MuldeR's Utilities for Qt Documentation</div>  </div>
  64 </div><!--header-->
  65 <div class="contents">
  66 <div class="textblock"><h1>Introduction</h1>
  67 <p>The <b>MUtilities</b> library is a collection of routines and classes to extend the <a href="http://qt-project.org/"><em>Qt cross-platform framework</em></a>. It contains various convenience and utility functions as well as wrappers for OS-specific functionalities. The library was originally created as a "side product" of the <a href="http://lamexp.sourceforge.net/"><b>LameXP</b></a> application: Over the years, a lot of code, <b>not</b> really specific to <em>LameXP</em>, had accumulated in the <em>LameXP</em> code base. Some of that code even had been used in other projects too, in a "copy &amp; paste" fashion &ndash; which had lead to redundancy and much complicated maintenance. In order to clean-up the LameXP code base, to eliminate the ugly redundancy and to simplify maintenance, the code in question has finally been refactored into the <b>MUtilities</b> (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of <em>LameXP</em> and <a href="https://github.com/lordmulder"><em>other OpenSource projects</em></a>.</p>
  68 <h1>Project Structure</h1>
  69 <p>The <em>MUtilities</em> project directory is organized as follows:</p>
  70 <ul>
  71 <li><code>bin/</code> &ndash; compiled library files (static or shared), link those files in projects that use the MUtilities library</li>
  72 <li><code>docs/</code> &ndash; programming interface documentation, generated with Doxygen tool</li>
  73 <li><code>etc/</code> &ndash; miscellaneous files, everything that doesn't fit in anywhere else</li>
  74 <li><code>include/</code> &ndash; public header files, include this directory in projects that use the MUtilities library</li>
  75 <li><code>obj/</code> &ndash; object code files, intermediate files generated during the build process</li>
  76 <li><code>res/</code> &ndash; resource files, required for building the MUtilities library</li>
  77 <li><code>src/</code> &ndash; source code files, required for building the MUtilities library (third-party code in <code>src/3rd_party/</code>)</li>
  78 <li><code>test/</code> &ndash; unit tests, based on Google Test framework</li>
  79 <li><code>tmp/</code> &ndash; temporary files, automatically generated during the build process</li>
  80 </ul>
  81 <h1>API Documentation</h1>
  82 <p>The public API of the <em>MUtilities</em> library is defined in the following header files (select file for details):</p><ul>
  83 <li><b><a class="el" href="d5/d3b/_global_8h.html" title="This file contains miscellaneous functions that are generally useful for Qt-based applications...">Global.h</a></b> &ndash; miscellaneous useful functions</li>
  84 </ul>
  85 <h1>Example</h1>
  86 <p>Here is a minimal example on how to use the <em>MUtilities</em> library in your project: </p><pre class="fragment">//MUtils
  87 #include &lt;MUtils/Global.h&gt;
  88
  89 int main(int argc, char **argv)
  90 {
  91     qDebug("Random number: %u\n", MUtils::next_rand_u32());
  92 }
  93 </pre><h2>Build Notes</h2>
  94 <ul>
  95 <li>In order to use the <em>MUtilities</em> library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is <em>not</em> covered by this document.</li>
  96 <li>Additionally, make sure that <em>MUtilities'</em> <code>include/</code> directory is contained in your "Additional Include Directories" and that the <em>MUtilities'</em> <code>bin/</code> directory is contained in your "Additional Library Directories".</li>
  97 <li>Finally, make sure that your project links against the <code>MUtils32-1.lib</code> library file. For each build configuration, pick the proper **.lib** file from the corresponding <code>bin/&lt;platform&gt;/&lt;config&gt;/</code> directory!</li>
  98 <li>If your projects intends to use the <em>MUtilities</em> library as a <b>static</b> library, then the macro <code>MUTILS_STATIC_LIB</code> <em>must</em> be added to your project's "Preprocessor Definitions".</li>
  99 </ul>
 100 <h1>License</h1>
 101 <p>This library is free software. It is released under the terms of the <a href="https://www.gnu.org/licenses/lgpl-2.1.html"><em>GNU Lesser General Public License (LGPL), Version 2.1</em></a>. </p><pre class="fragment">MUtilities - MuldeR's Utilities for Qt
 102 Copyright (C) 2004-2016 LoRd_MuldeR &lt;MuldeR2@GMX.de&gt;. Some rights reserved.
 103
 104 This library is free software; you can redistribute it and/or
 105 modify it under the terms of the GNU Lesser General Public
 106 License as published by the Free Software Foundation; either
 107 version 2.1 of the License, or (at your option) any later version.
 108
 109 This library is distributed in the hope that it will be useful,
 110 but WITHOUT ANY WARRANTY; without even the implied warranty of
 111 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 112 Lesser General Public License for more details.
 113
 114 You should have received a copy of the GNU Lesser General Public
 115 License along with this library; if not, write to the Free Software
 116 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.
 117 </pre><h1>Acknowledgement</h1>
 118 <p>The following third-party code is used in the MUtilities library:</p>
 119 <ul>
 120 <li><b>Keccak/SHA-3 Reference Implementation</b> Implementation by the Keccak, Keyak and Ketje Teams, namely, Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche and Ronny Van Keer No Copyright / Dedicated to the Public Domain</li>
 121 <li><b>Natural Order String Comparison</b> Copyright (C) 2000, 2004 by Martin Pool <a href="#" onclick="location.href='mai'+'lto:'+'mbp'+'@s'+'our'+'ce'+'fro'+'g.'+'net'; return false;">mbp@s<span style="display: none;">.nosp@m.</span>ourc<span style="display: none;">.nosp@m.</span>efrog<span style="display: none;">.nosp@m.</span>.net</a> Released under the zlib License</li>
 122 <li><b>Adler-32 Checksum Algorithm (from zlib)</b> Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler Released under the zlib License </li>
 123 </ul>
 124 </div></div><!-- contents -->
 125 <!-- start footer part -->
 126 <hr class="footer"/><address class="footer"><small>
 127 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 128 <img class="footer" src="doxygen.png" alt="doxygen"/>
 129 </a> 1.8.12
 130 </small></address>
 131 </body>
 132 </html>