interface/wx/init.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        init.h
   3 // Purpose:     interface of global functions
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /** @ingroup group_funcmacro_appinitterm */
  10 //@{
  11
  12 /**
  13     This function can be used to perform the initialization of wxWidgets if you
  14     can't use the default initialization code for any reason.
  15
  16     If the function returns true, the initialization was successful and the
  17     global wxApp object ::wxTheApp has been created. Moreover, wxEntryCleanup()
  18     must be called afterwards. If the function returns false, a catastrophic
  19     initialization error occured and (at least the GUI part of) the library
  20     can't be used at all.
  21
  22     Notice that parameters @c argc and @c argv may be modified by this
  23     function.
  24
  25     @header{wx/init.h}
  26 */
  27 bool wxEntryStart(int& argc, wxChar** argv);
  28
  29 /**
  30     See wxEntryStart(int&,wxChar**) for more info about this function.
  31
  32     This is an additional overload of wxEntryStart() provided under MSW only.
  33     It is meant to be called with the parameters passed to WinMain().
  34
  35     @note Under Windows CE platform, and only there, the type of @a pCmdLine is
  36     @c wchar_t *, otherwise it is @c char *, even in Unicode build.
  37
  38     @header{wx/init.h}
  39 */
  40 bool wxEntryStart(HINSTANCE hInstance,
  41                   HINSTANCE hPrevInstance = NULL,
  42                   char* pCmdLine = NULL,
  43                   int nCmdShow = SW_SHOWNORMAL);
  44
  45 /**
  46     Free resources allocated by a successful call to wxEntryStart().
  47
  48     @header{wx/init.h}
  49 */
  50 void wxEntryCleanup();
  51
  52 //@}
  53