include/wx/init.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/init.h
   3 // Purpose:     wxWindows initialization and finalization functions
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     29.06.2003
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_INIT_H_
  13 #define _WX_INIT_H_
  14
  15 #include "wx/wxchar.h"
  16
  17 // ----------------------------------------------------------------------------
  18 // wxEntry helper functions which allow to have more fine grained control
  19 // ----------------------------------------------------------------------------
  20
  21 // do common initialization, return true if ok (in this case wxEntryCleanup
  22 // must be called later), otherwise the program can't use wxWindows at all
  23 //
  24 // this function also creates wxTheApp as a side effect, if IMPLEMENT_APP
  25 // hadn't been used a dummy default application object is created
  26 //
  27 // note that the parameters may be modified, this is why we pass them by
  28 // reference!
  29 extern bool WXDLLEXPORT wxEntryStart(int& argc, wxChar **argv);
  30
  31 // free the resources allocated by the library in wxEntryStart() and shut it
  32 // down (wxEntryStart() may be called again afterwards if necessary)
  33 extern void WXDLLEXPORT wxEntryCleanup();
  34
  35
  36 // ----------------------------------------------------------------------------
  37 // wxEntry: this function initializes the library, runs the main event loop
  38 //          and cleans it up
  39 // ----------------------------------------------------------------------------
  40
  41 // note that other, platform-specific, overloads of wxEntry may exist as well
  42 // but this one always exists under all platforms
  43 //
  44 // returns the program exit code
  45 extern int WXDLLEXPORT wxEntry(int& argc, wxChar **argv);
  46
  47
  48 // ----------------------------------------------------------------------------
  49 // Using the library without (explicit) application object: you may avoid using
  50 // DECLARE_APP and IMPLEMENT_APP macros and call the functions below instead at
  51 // the program startup and termination
  52 // ----------------------------------------------------------------------------
  53
  54 // initialize the library (may be called as many times as needed, but each
  55 // call to wxInitialize() must be matched by wxUninitialize())
  56 extern bool WXDLLEXPORT wxInitialize(int argc = 0, wxChar **argv = NULL);
  57
  58 // clean up -- the library can't be used any more after the last call to
  59 // wxUninitialize()
  60 extern void WXDLLEXPORT wxUninitialize();
  61
  62 // create an object of this class on stack to initialize/cleanup the library
  63 // automatically
  64 class WXDLLEXPORT wxInitializer
  65 {
  66 public:
  67     // initialize the library
  68     wxInitializer() { m_ok = wxInitialize(); }
  69
  70     // has the initialization been successful? (explicit test)
  71     bool IsOk() const { return m_ok; }
  72
  73     // has the initialization been successful? (implicit test)
  74     operator bool() const { return m_ok; }
  75
  76     // dtor only does clean up if we initialized the library properly
  77     ~wxInitializer() { if ( m_ok ) wxUninitialize(); }
  78
  79 private:
  80     bool m_ok;
  81 };
  82
  83 #endif // _WX_INIT_H_
  84