A reference to the QStringList object to be sorted. The list will be sorted "in place".
+
list
A reference to the QStringList object to be sorted. The list will be sorted "in place".
+
bIgnoreCase
If set to true, 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 false, the character case is taken into account.
@@ -370,7 +371,7 @@ QString
MUtils::clean_file
-
Returns
The function retruns a QString holding a random hexadecimal string
+
Returns
The function returns a QString holding a random hexadecimal string
@@ -392,7 +393,7 @@ QString
MUtils::clean_file
Generates a random unsigned 32-Bit value.
The random value is created using a "strong" PRNG of the underlying system, if possible. Otherwise a fallback PRNG is used. It is not required or useful to call srand() or qsrand() prior to using this function. If necessary, the seeding of the PRNG happen automatically on the first call.
-
Returns
The function retruns a random unsigned 32-Bit value.
+
Returns
The function returns a random unsigned 32-Bit value.
@@ -414,7 +415,7 @@ QString
MUtils::clean_file
Generates a random unsigned 64-Bit value.
The random value is created using a "strong" PRNG of the underlying system, if possible. Otherwise a fallback PRNG is used. It is not required or useful to call srand() or qsrand() prior to using this function. If necessary, the seeding of the PRNG happen automatically on the first call.
-
Returns
The function retruns a random unsigned 64-Bit value.
+
Returns
The function returns a random unsigned 64-Bit value.
@@ -557,7 +558,7 @@ QString
MUtils::clean_file
Recursively deletes the specified directory.
-
The function deletes the specified directory. In recusive mode, the directory will be removed including all of its files and sub-directories. Files are deleted using the remove_file() function.
+
The function deletes the specified directory. In recursive mode, the directory will be removed including all of its files and sub-directories. Files are deleted using the remove_file() function.
Parameters
folderPath
The path to the directory to be deleted. This should be a full path.
@@ -614,7 +615,7 @@ QString
MUtils::clean_file
Rerieves the full path of the application's Temp folder.
-
The application's Temp 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 Temp folder will be created as a sub-folder of the system's global Temp folder, as indicated by the TMP or TEMP environment variables. However, it may be created at a different place (e.g. in the users Profile directory), if those environment variables don't point to a usable directory. In any case, this function makes sure that the application's Temp folder exists for the whole lifetime of the application and that it is writable. When the application is about to terminate, the application's Temp folder and all files or sub-directories thereof will be removed automatically!
+
The application's Temp 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 Temp folder will be created as a sub-folder of the system's global Temp folder, as indicated by the TMP or TEMP environment variables. However, it may be created at a different place (e.g. in the users Profile directory), if those environment variables don't point to a usable directory. In any case, this function makes sure that the application's Temp folder exists for the whole lifetime of the application and that it is writable. When the application terminates normally, the application's Temp folder and all files or sub-directories thereof will be removed automatically!
Returns
If the function succeeds, it returns a read-only reference to a QString holding the full path of the application's Temp folder; otherwise a read-only reference to a default-constructed QString is returned.
diff --git a/docs/index.html b/docs/index.html
index f37c015..565e796 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -5,7 +5,7 @@
-MuldeR's Utilities for Qt: MuldeR's Utilities for Qt
+MuldeR's Utilities for Qt: Main Page
@@ -60,17 +60,68 @@ $(function() {
-
MuldeR's Utilities for Qt
+
MuldeR's Utilities for Qt Documentation
-
The MUtilities library is a collection of routines and classes to extend the Qt cross-platform framework. 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 LameXP application: Over the years, a lot of code, not really specific to LameXP, had accumulated in the LameXP code base. Some of that code even had been used in other projects too, in a "copy & paste" fashion – 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 MUtilities (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of LameXP and other OpenSource projects.
-
API-Documentation
-
The public API of the MUtilities library is defined in the following header files:
+
Introduction
+
The MUtilities library is a collection of routines and classes to extend the Qt cross-platform framework. 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 LameXP application: Over the years, a lot of code, not really specific to LameXP, had accumulated in the LameXP code base. Some of that code even had been used in other projects too, in a "copy & paste" fashion – 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 MUtilities (aka "MuldeR's Utilities for Qt") library. This library now forms the foundation of LameXP and other OpenSource projects.
+
Project Structure
+
The MUtilities project directory is organized as follows:
+
+
bin/ – compiled library files (static or shared), link those files in projects that use the MUtilities library
+
docs/ – programming interface documentation, generated with Doxygen tool
+
etc/ – miscellaneous files, everything that doesn't fit in anywhere else
+
include/ – public header files, include this directory in projects that use the MUtilities library
+
obj/ – object code files, intermediate files generated during the build process
+
res/ – resource files, required for building the MUtilities library
+
src/ – source code files, required for building the MUtilities library (third-party code in src/3rd_party/)
+
test/ – unit tests, based on Google Test framework
+
tmp/ – temporary files, automatically generated during the build process
+
+
API Documentation
+
The public API of the MUtilities library is defined in the following header files (select file for details):
In order to use the MUtilities library in your project, your build environment must have already been set up for building Qt-based projects. Setting up Qt is not covered by this document.
+
Additionally, make sure that MUtilities'include/ directory is contained in your "Additional Include Directories" and that the MUtilities'bin/ directory is contained in your "Additional Library Directories".
+
Finally, make sure that your project links against the MUtils32-1.lib library file. For each build configuration, pick the proper **.lib** file from the corresponding bin/<platform>/<config>/ directory!
+
If your projects intends to use the MUtilities library as a static library, then the macro MUTILS_STATIC_LIBmust be added to your project's "Preprocessor Definitions".
MUtilities - MuldeR's Utilities for Qt
+Copyright (C) 2004-2016 LoRd_MuldeR <MuldeR2@GMX.de>. Some rights reserved.
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
Acknowledgement
+
The following third-party code is used in the MUtilities library:
+
+
Keccak/SHA-3 Reference Implementation 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