vaikene.ee Git - evaf/blob - src/libs/Common/globals.h

   1 /**
   2  * @file Common/globals.h
   3  * @brief Global constants and macros for eVaf
   4  * @author Enar Vaikene
   5  *
   6  * Copyright (c) 2011 Enar Vaikene
   7  *
   8  * This file is part of the eVaf C++ cross-platform application development framework.
   9  *
  10  * This file can be used under the terms of the GNU General Public License
  11  * version 3.0 as published by the Free Software Foundation and appearing in
  12  * the file LICENSE included in the packaging of this file. Please review the
  13  * the following information to ensure the GNU General Public License version
  14  * 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
  15  *
  16  * Alternatively, this file may be used in accordance with the Commercial License
  17  * Agreement provided with the Software.
  18  */
  19
  20 #ifndef __COMMON_GLOBALS_H
  21 #  define __COMMON_GLOBALS_H
  22
  23 #include "libcommon.h"
  24
  25 /**
  26  * Common namespace for eVaf.
  27  */
  28 namespace eVaf {
  29
  30 /**
  31  * Common eVaf library.
  32  *
  33  * This library contains interfaces, classes and functions shared by all the eVaf applications
  34  * and modules. This library is the required dependency for all the other libraries, modules and
  35  * applications.
  36  *
  37  * The common eVaf library shall be initialized with the eVaf::Common::init() function.
  38  */
  39 namespace Common {
  40
  41 /**
  42  * eVaf common library initialized
  43  * @param args List of arguments
  44  * @return True if ok; false if the initialization failed
  45  *
  46  * Call this function to initialize the common eVaf library after creating the Qt application
  47  * object and before loading any of the modules.
  48  */
  49 extern bool COMMON_EXPORT init(QStringList const & args);
  50
  51 } // namespace eVaf::Common
  52 } // namespace eVaf
  53
  54 #endif // globals.h