interface/wx/app.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        app.h
   3 // Purpose:     interface of wxApp
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11     @class wxAppConsole
  12
  13     This class is essential for writing console-only or hybrid apps without
  14     having to define @c wxUSE_GUI=0.
  15
  16     It is used to:
  17     @li set and get application-wide properties (see wxAppConsole::CreateTraits
  18         and wxAppConsole::SetXXX functions)
  19     @li implement the windowing system message or event loop: events in fact are
  20         supported even in console-mode applications (see wxAppConsole::HandleEvent
  21         and wxAppConsole::ProcessPendingEvents);
  22     @li initiate application processing via wxApp::OnInit;
  23     @li allow default processing of events not handled by other
  24         objects in the application (see wxAppConsole::FilterEvent)
  25     @li implement Apple-specific event handlers (see wxAppConsole::MacXXX functions)
  26
  27     You should use the macro IMPLEMENT_APP(appClass) in your application
  28     implementation file to tell wxWidgets how to create an instance of your
  29     application class.
  30
  31     Use DECLARE_APP(appClass) in a header file if you want the ::wxGetApp() function
  32     (which returns a reference to your application object) to be visible to other
  33     files.
  34
  35     @library{wxbase}
  36     @category{appmanagement}
  37
  38     @see @ref overview_app, wxApp, wxAppTraits, wxEventLoopBase
  39 */
  40 class wxAppConsole : public wxEvtHandler
  41 {
  42 protected:
  43     /**
  44         Creates the wxAppTraits object when GetTraits() needs it for the first time.
  45
  46         @see wxAppTraits
  47     */
  48     virtual wxAppTraits* CreateTraits();
  49
  50 public:
  51
  52     /**
  53         Destructor.
  54     */
  55     virtual ~wxAppConsole();
  56
  57
  58     /**
  59         @name Event-handling
  60
  61         Note that you should look at wxEvtLoopBase for more event-processing
  62         documentation.
  63     */
  64     //@{
  65
  66     /**
  67         Called by wxWidgets on creation of the application. Override this if you wish
  68         to provide your own (environment-dependent) main loop.
  69
  70         @return 0 under X, and the wParam of the WM_QUIT message under Windows.
  71     */
  72     virtual int MainLoop();
  73
  74     /**
  75         Call this to explicitly exit the main message (event) loop.
  76         You should normally exit the main loop (and the application) by deleting
  77         the top window.
  78
  79         This function simply calls wxEvtLoopBase::Exit() on the active loop.
  80     */
  81     virtual void ExitMainLoop();
  82
  83     /**
  84         This function is called before processing any event and allows the application
  85         to preempt the processing of some events.
  86
  87         If this method returns -1 the event is processed normally, otherwise either
  88         @true or @false should be returned and the event processing stops immediately
  89         considering that the event had been already processed (for the former return
  90         value) or that it is not going to be processed at all (for the latter one).
  91     */
  92     virtual int FilterEvent(wxEvent& event);
  93
  94
  95     /**
  96         This function simply invokes the given method @a func of the specified
  97         event handler @a handler with the @a event as parameter. It exists solely
  98         to allow to catch the C++ exceptions which could be thrown by all event
  99         handlers in the application in one place: if you want to do this, override
 100         this function in your wxApp-derived class and add try/catch clause(s) to it.
 101     */
 102     virtual void HandleEvent(wxEvtHandler* handler,
 103                              wxEventFunction func,
 104                              wxEvent& event) const;
 105
 106     //@}
 107
 108
 109     /**
 110         Allows external code to modify global ::wxTheApp, but you should really
 111         know what you're doing if you call it.
 112
 113         @param app
 114             Replacement for the global application object.
 115
 116         @see GetInstance()
 117     */
 118     static void SetInstance(wxAppConsole* app);
 119
 120     /**
 121         Returns the one and only global application object.
 122         Usually ::wxTheApp is used instead.
 123
 124         @see SetInstance()
 125     */
 126     static wxAppConsole* GetInstance();
 127
 128     /**
 129         Returns @true if the main event loop is currently running, i.e. if the
 130         application is inside OnRun().
 131
 132         This can be useful to test whether events can be dispatched. For example,
 133         if this function returns @false, non-blocking sockets cannot be used because
 134         the events from them would never be processed.
 135     */
 136     static bool IsMainLoopRunning();
 137
 138
 139     /**
 140         @name Mac-specific functions
 141     */
 142     //@{
 143
 144     /**
 145         Called in response of an "open-application" Apple event.
 146         Override this to create a new document in your app.
 147
 148         @onlyfor{wxmac}
 149     */
 150     virtual void MacNewFile();
 151
 152     /**
 153         Called in response of an "open-document" Apple event.
 154
 155         You need to override this method in order to open a document file after the
 156         user double clicked on it or if the document file was dropped on either the
 157         running application or the application icon in Finder.
 158
 159         @onlyfor{wxmac}
 160     */
 161     virtual void MacOpenFile(const wxString& fileName);
 162
 163     /**
 164         Called in response of a "get-url" Apple event.
 165
 166         @onlyfor{wxmac}
 167     */
 168     virtual void MacOpenURL(const wxString& url);
 169
 170     /**
 171         Called in response of a "print-document" Apple event.
 172
 173         @onlyfor{wxmac}
 174     */
 175     virtual void MacPrintFile(const wxString& fileName);
 176
 177     /**
 178         Called in response of a "reopen-application" Apple event.
 179
 180         @onlyfor{wxmac}
 181     */
 182     virtual void MacReopenApp();
 183
 184     //@}
 185
 186
 187     /**
 188         @name Callbacks for application-wide "events"
 189     */
 190     //@{
 191
 192     /**
 193         This function is called when an assert failure occurs, i.e. the condition
 194         specified in wxASSERT() macro evaluated to @false.
 195
 196         It is only called in debug mode (when @c __WXDEBUG__ is defined) as
 197         asserts are not left in the release code at all.
 198         The base class version shows the default assert failure dialog box proposing to
 199         the user to stop the program, continue or ignore all subsequent asserts.
 200
 201         @param file
 202             the name of the source file where the assert occurred
 203         @param line
 204             the line number in this file where the assert occurred
 205         @param func
 206             the name of the function where the assert occurred, may be
 207             empty if the compiler doesn't support C99 __FUNCTION__
 208         @param cond
 209             the condition of the failed assert in text form
 210         @param msg
 211             the message specified as argument to wxASSERT_MSG or wxFAIL_MSG, will
 212             be @NULL if just wxASSERT or wxFAIL was used
 213     */
 214     virtual void OnAssertFailure(const wxChar *file,
 215                                  int line,
 216                                  const wxChar *func,
 217                                  const wxChar *cond,
 218                                  const wxChar *msg);
 219
 220     /**
 221         Called when command line parsing fails (i.e. an incorrect command line option
 222         was specified by the user). The default behaviour is to show the program usage
 223         text and abort the program.
 224
 225         Return @true to continue normal execution or @false to return
 226         @false from OnInit() thus terminating the program.
 227
 228         @see OnInitCmdLine()
 229     */
 230     virtual bool OnCmdLineError(wxCmdLineParser& parser);
 231
 232     /**
 233         Called when the help option (@c --help) was specified on the command line.
 234         The default behaviour is to show the program usage text and abort the program.
 235
 236         Return @true to continue normal execution or @false to return
 237         @false from OnInit() thus terminating the program.
 238
 239         @see OnInitCmdLine()
 240     */
 241     virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
 242
 243     /**
 244         Called after the command line had been successfully parsed. You may override
 245         this method to test for the values of the various parameters which could be
 246         set from the command line.
 247
 248         Don't forget to call the base class version unless you want to suppress
 249         processing of the standard command line options.
 250         Return @true to continue normal execution or @false to return @false from
 251         OnInit() thus terminating the program.
 252
 253         @see OnInitCmdLine()
 254     */
 255     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
 256
 257     /**
 258         This function is called if an unhandled exception occurs inside the main
 259         application event loop. It can return @true to ignore the exception and to
 260         continue running the loop or @false to exit the loop and terminate the
 261         program. In the latter case it can also use C++ @c throw keyword to
 262         rethrow the current exception.
 263
 264         The default behaviour of this function is the latter in all ports except under
 265         Windows where a dialog is shown to the user which allows him to choose between
 266         the different options. You may override this function in your class to do
 267         something more appropriate.
 268
 269         Finally note that if the exception is rethrown from here, it can be caught in
 270         OnUnhandledException().
 271     */
 272     virtual bool OnExceptionInMainLoop();
 273
 274     /**
 275         Override this member function for any processing which needs to be
 276         done as the application is about to exit. OnExit is called after
 277         destroying all application windows and controls, but before
 278         wxWidgets cleanup. Note that it is not called at all if
 279         OnInit() failed.
 280
 281         The return value of this function is currently ignored, return the same
 282         value as returned by the base class method if you override it.
 283     */
 284     virtual int OnExit();
 285
 286     /**
 287         This function may be called if something fatal happens: an unhandled
 288         exception under Win32 or a a fatal signal under Unix, for example. However,
 289         this will not happen by default: you have to explicitly call
 290         wxHandleFatalExceptions() to enable this.
 291
 292         Generally speaking, this function should only show a message to the user and
 293         return. You may attempt to save unsaved data but this is not guaranteed to
 294         work and, in fact, probably won't.
 295
 296         @see wxHandleFatalExceptions()
 297     */
 298     virtual void OnFatalException();
 299
 300     /**
 301         This must be provided by the application, and will usually create the
 302         application's main window, optionally calling SetTopWindow().
 303
 304         You may use OnExit() to clean up anything initialized here, provided
 305         that the function returns @true.
 306
 307         Notice that if you want to to use the command line processing provided by
 308         wxWidgets you have to call the base class version in the derived class
 309         OnInit().
 310
 311         Return @true to continue processing, @false to exit the application
 312         immediately.
 313     */
 314     virtual bool OnInit();
 315
 316     /**
 317         Called from OnInit() and may be used to initialize the parser with the
 318         command line options for this application. The base class versions adds
 319         support for a few standard options only.
 320     */
 321     virtual void OnInitCmdLine(wxCmdLineParser& parser);
 322
 323     /**
 324         This virtual function is where the execution of a program written in wxWidgets
 325         starts. The default implementation just enters the main loop and starts
 326         handling the events until it terminates, either because ExitMainLoop() has
 327         been explicitly called or because the last frame has been deleted and
 328         GetExitOnFrameDelete() flag is @true (this is the default).
 329
 330         The return value of this function becomes the exit code of the program, so it
 331         should return 0 in case of successful termination.
 332     */
 333     virtual int OnRun();
 334
 335     /**
 336         This function is called when an unhandled C++ exception occurs inside
 337         OnRun() (the exceptions which occur during the program startup and shutdown
 338         might not be caught at all). Notice that by now the main event loop has been
 339         terminated and the program will exit, if you want to prevent this from happening
 340         (i.e. continue running after catching an exception) you need to override
 341         OnExceptionInMainLoop().
 342
 343         The default implementation shows information about the exception in debug build
 344         but does nothing in the release build.
 345     */
 346     virtual void OnUnhandledException();
 347
 348     //@}
 349
 350
 351     /**
 352         @name Application informations
 353     */
 354     //@{
 355
 356     /**
 357         Returns the user-readable application name.
 358
 359         The difference between this string and the one returned by GetAppName()
 360         is that this one is meant to be shown to the user and so should be used
 361         for the window titles, page headers and so on while the other one
 362         should be only used internally, e.g. for the file names or
 363         configuration file keys. By default, returns the application name as
 364         returned by GetAppName() capitalized using wxString::Capitalize().
 365
 366         @since 2.9.0
 367     */
 368     wxString GetAppDisplayName() const;
 369
 370     /**
 371         Returns the application name.
 372
 373         @remarks wxWidgets sets this to a reasonable default before calling
 374                  OnInit(), but the application can reset it at will.
 375
 376         @see GetAppDisplayName()
 377     */
 378     wxString GetAppName() const;
 379
 380     /**
 381         Gets the class name of the application. The class name may be used in a
 382         platform specific manner to refer to the application.
 383
 384         @see SetClassName()
 385     */
 386     wxString GetClassName() const;
 387
 388     /**
 389         Returns a pointer to the wxAppTraits object for the application.
 390         If you want to customize the wxAppTraits object, you must override the
 391         CreateTraits() function.
 392     */
 393     wxAppTraits* GetTraits();
 394
 395     /**
 396         Returns the user-readable vendor name. The difference between this string
 397         and the one returned by GetVendorName() is that this one is meant to be shown
 398         to the user and so should be used for the window titles, page headers and so on
 399         while the other one should be only used internally, e.g. for the file names or
 400         configuration file keys.
 401
 402         By default, returns the same string as GetVendorName().
 403
 404         @since 2.9.0
 405     */
 406     const wxString& GetVendorDisplayName() const;
 407
 408     /**
 409         Returns the application's vendor name.
 410     */
 411     const wxString& GetVendorName() const;
 412
 413     /**
 414         Set the application name to be used in the user-visible places such as
 415         window titles.
 416
 417         See GetAppDisplayName() for more about the differences between the
 418         display name and name.
 419
 420         Notice that if this function is called, the name is used as is, without
 421         any capitalization as done by default by GetAppDisplayName().
 422     */
 423     void SetAppDisplayName(const wxString& name);
 424
 425     /**
 426         Sets the name of the application. This name should be used for file names,
 427         configuration file entries and other internal strings. For the user-visible
 428         strings, such as the window titles, the application display name set by
 429         SetAppDisplayName() is used instead.
 430
 431         By default the application name is set to the name of its executable file.
 432
 433         @see GetAppName()
 434     */
 435     void SetAppName(const wxString& name);
 436
 437     /**
 438         Sets the class name of the application. This may be used in a platform specific
 439         manner to refer to the application.
 440
 441         @see GetClassName()
 442     */
 443     void SetClassName(const wxString& name);
 444
 445     /**
 446         Set the vendor name to be used in the user-visible places.
 447         See GetVendorDisplayName() for more about the differences between the
 448         display name and name.
 449     */
 450     void SetVendorDisplayName(const wxString& name);
 451
 452     /**
 453         Sets the name of application's vendor. The name will be used
 454         in registry access. A default name is set by wxWidgets.
 455
 456         @see GetVendorName()
 457     */
 458     void SetVendorName(const wxString& name);
 459
 460     //@}
 461
 462
 463     /**
 464         Number of command line arguments (after environment-specific processing).
 465     */
 466     int argc;
 467
 468     /**
 469         Command line arguments (after environment-specific processing).
 470
 471         Under Windows and Linux/Unix, you should parse the command line
 472         arguments and check for files to be opened when starting your
 473         application. Under OS X, you need to override MacOpenFile()
 474         since command line arguments are used differently there.
 475
 476         You may use the wxCmdLineParser to parse command line arguments.
 477     */
 478     wxChar** argv;
 479 };
 480
 481
 482
 483
 484 /**
 485     @class wxApp
 486
 487     The wxApp class represents the application itself when @c wxUSE_GUI=1.
 488
 489     In addition to the features provided by wxAppConsole it keeps track of
 490     the <em>top window</em> (see SetTopWindow()) and adds support for
 491     video modes (see SetVideoMode()).
 492
 493     In general, application-wide settings for GUI-only apps are accessible
 494     from wxApp (or from wxSystemSettings or wxSystemOptions classes).
 495
 496     @library{wxbase}
 497     @category{appmanagement}
 498
 499     @see @ref overview_app, wxAppTraits, wxEventLoopBase, wxSystemSettings
 500 */
 501 class wxApp : public wxAppConsole
 502 {
 503 public:
 504     /**
 505         Constructor. Called implicitly with a definition of a wxApp object.
 506     */
 507     wxApp();
 508
 509     /**
 510         Destructor. Will be called implicitly on program exit if the wxApp
 511         object is created on the stack.
 512     */
 513     virtual ~wxApp();
 514
 515     /**
 516         Get display mode that is used use. This is only used in framebuffer
 517         wxWin ports (such as wxMGL or wxDFB).
 518     */
 519     virtual wxVideoMode GetDisplayMode() const;
 520
 521     /**
 522         Returns @true if the application will exit when the top-level frame is deleted.
 523
 524         @see SetExitOnFrameDelete()
 525     */
 526     bool GetExitOnFrameDelete() const;
 527
 528     /**
 529         Return the layout direction for the current locale or @c wxLayout_Default
 530         if it's unknown.
 531     */
 532     virtual wxLayoutDirection GetLayoutDirection() const;
 533
 534     /**
 535         Returns @true if the application will use the best visual on systems that support
 536         different visuals, @false otherwise.
 537
 538         @see SetUseBestVisual()
 539     */
 540     bool GetUseBestVisual() const;
 541
 542     /**
 543         Returns a pointer to the top window.
 544
 545         @remarks
 546             If the top window hasn't been set using SetTopWindow(), this function
 547             will find the first top-level window (frame or dialog or instance of
 548             wxTopLevelWindow) from the internal top level window list and return that.
 549
 550         @see SetTopWindow()
 551     */
 552     virtual wxWindow* GetTopWindow() const;
 553
 554     /**
 555         Returns @true if the application is active, i.e. if one of its windows is
 556         currently in the foreground.
 557
 558         If this function returns @false and you need to attract users attention to
 559         the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
 560     */
 561     virtual bool IsActive() const;
 562
 563     /**
 564         This function is similar to wxYield(), except that it disables the user
 565         input to all program windows before calling wxAppConsole::Yield and re-enables it
 566         again afterwards. If @a win is not @NULL, this window will remain enabled,
 567         allowing the implementation of some limited user interaction.
 568         Returns the result of the call to wxAppConsole::Yield.
 569
 570         @see wxSafeYield
 571     */
 572     virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded);
 573
 574     /**
 575         Works like SafeYield() with @e onlyIfNeeded == @true except that
 576         it allows the caller to specify a mask of events to be processed.
 577
 578         See wxAppConsole::YieldFor for more info.
 579     */
 580     virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);
 581
 582     /**
 583         Windows-only function for processing a message. This function is called
 584         from the main message loop, checking for windows that may wish to process it.
 585
 586         The function returns @true if the message was processed, @false otherwise.
 587         If you use wxWidgets with another class library with its own message loop,
 588         you should make sure that this function is called to allow wxWidgets to
 589         receive messages. For example, to allow co-existence with the Microsoft
 590         Foundation Classes, override the PreTranslateMessage function:
 591
 592         @code
 593         // Provide wxWidgets message loop compatibility
 594         BOOL CTheApp::PreTranslateMessage(MSG *msg)
 595         {
 596             if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
 597                 return true;
 598             else
 599                 return CWinApp::PreTranslateMessage(msg);
 600         }
 601         @endcode
 602
 603         @onlyfor{wxmsw}
 604     */
 605     bool ProcessMessage(WXMSG* msg);
 606
 607     /**
 608         Sends idle events to a window and its children.
 609         Please note that this function is internal to wxWidgets and shouldn't be used
 610         by user code.
 611
 612         @remarks These functions poll the top-level windows, and their children,
 613                  for idle event processing. If @true is returned, more OnIdle
 614                  processing is requested by one or more window.
 615
 616         @see wxIdleEvent
 617     */
 618     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 619
 620     /**
 621         Set display mode to use. This is only used in framebuffer wxWin
 622         ports (such as wxMGL or wxDFB). This method should be called from
 623         wxApp::OnInitGui.
 624     */
 625     virtual bool SetDisplayMode(const wxVideoMode& info);
 626
 627     /**
 628         Allows the programmer to specify whether the application will exit when the
 629         top-level frame is deleted.
 630
 631         @param flag
 632             If @true (the default), the application will exit when the top-level frame
 633             is deleted. If @false, the application will continue to run.
 634
 635         @see GetExitOnFrameDelete(), @ref overview_app_shutdown
 636     */
 637     void SetExitOnFrameDelete(bool flag);
 638
 639     /**
 640         Allows runtime switching of the UI environment theme.
 641
 642         Currently implemented for wxGTK2-only.
 643         Return @true if theme was successfully changed.
 644
 645         @param theme
 646             The name of the new theme or an absolute path to a gtkrc-theme-file
 647     */
 648     virtual bool SetNativeTheme(const wxString& theme);
 649
 650     /**
 651         Sets the 'top' window. You can call this from within OnInit() to let wxWidgets
 652         know which is the main window. You don't have to set the top window;
 653         it is only a convenience so that (for example) certain dialogs without parents
 654         can use a specific window as the top window.
 655
 656         If no top window is specified by the application, wxWidgets just uses the
 657         first frame or dialog (or better, any wxTopLevelWindow) in its top-level
 658         window list, when it needs to use the top window.
 659         If you previously called SetTopWindow() and now you need to restore this
 660         automatic behaviour you can call @code wxApp::SetTopWindow(NULL) @endcode.
 661
 662         @param window
 663             The new top window.
 664
 665         @see GetTopWindow(), OnInit()
 666     */
 667     void SetTopWindow(wxWindow* window);
 668
 669     /**
 670         Allows the programmer to specify whether the application will use the best
 671         visual on systems that support several visual on the same display. This is typically
 672         the case under Solaris and IRIX, where the default visual is only 8-bit whereas
 673         certain applications are supposed to run in TrueColour mode.
 674
 675         Note that this function has to be called in the constructor of the wxApp
 676         instance and won't have any effect when called later on.
 677         This function currently only has effect under GTK.
 678
 679         @param flag
 680             If @true, the app will use the best visual.
 681         @param forceTrueColour
 682             If @true then the application will try to force using a TrueColour
 683             visual and abort the app if none is found.
 684     */
 685     void SetUseBestVisual(bool flag, bool forceTrueColour = false);
 686 };
 687
 688
 689
 690 // ============================================================================
 691 // Global functions/macros
 692 // ============================================================================
 693
 694
 695 /** @addtogroup group_funcmacro_rtti */
 696 //@{
 697
 698 /**
 699     This is used in headers to create a forward declaration of the ::wxGetApp()
 700     function implemented by IMPLEMENT_APP().
 701
 702     It creates the declaration <tt>className& wxGetApp()</tt>.
 703
 704     @header{wx/app.h}
 705
 706     Example:
 707
 708     @code
 709     DECLARE_APP(MyApp)
 710     @endcode
 711 */
 712 #define DECLARE_APP( className )
 713
 714 /**
 715     This is used in the application class implementation file to make the
 716     application class known to wxWidgets for dynamic construction.
 717
 718     @header{wx/app.h}
 719
 720     Example:
 721
 722     @code
 723     IMPLEMENT_APP(MyApp)
 724     @endcode
 725
 726     @see DECLARE_APP().
 727 */
 728 #define IMPLEMENT_APP( className )
 729
 730 //@}
 731
 732
 733
 734 /**
 735     The global pointer to the singleton wxApp object.
 736
 737     @see wxApp::GetInstance()
 738 */
 739 wxApp *wxTheApp;
 740
 741
 742
 743 /** @addtogroup group_funcmacro_appinitterm */
 744 //@{
 745
 746 /**
 747     This function doesn't exist in wxWidgets but it is created by using the
 748     IMPLEMENT_APP() macro.
 749
 750     Thus, before using it anywhere but in the same module where this macro is
 751     used, you must make it available using DECLARE_APP().
 752
 753     The advantage of using this function compared to directly using the global
 754     ::wxTheApp pointer is that the latter is of type wxApp* and so wouldn't
 755     allow you to access the functions specific to your application class but
 756     not present in wxApp while wxGetApp() returns the object of the right type.
 757
 758     @header{wx/app.h}
 759 */
 760 wxAppDerivedClass& wxGetApp();
 761
 762 /**
 763     If @a doIt is @true, the fatal exceptions (also known as general protection
 764     faults under Windows or segmentation violations in the Unix world) will be
 765     caught and passed to wxApp::OnFatalException.
 766
 767     By default, i.e. before this function is called, they will be handled in
 768     the normal way which usually just means that the application will be
 769     terminated. Calling wxHandleFatalExceptions() with @a doIt equal to @false
 770     will restore this default behaviour.
 771
 772     Notice that this function is only available if @c wxUSE_ON_FATAL_EXCEPTION
 773     is 1 and under Windows platform this requires a compiler with support for
 774     SEH (structured exception handling) which currently means only Microsoft
 775     Visual C++ or a recent Borland C++ version.
 776
 777     @header{wx/app.h}
 778 */
 779 bool wxHandleFatalExceptions(bool doIt = true);
 780
 781 /**
 782     This function is used in wxBase only and only if you don't create
 783     wxApp object at all. In this case you must call it from your
 784     @c main() function before calling any other wxWidgets functions.
 785
 786     If the function returns @false the initialization could not be performed,
 787     in this case the library cannot be used and wxUninitialize() shouldn't be
 788     called neither.
 789
 790     This function may be called several times but wxUninitialize() must be
 791     called for each successful call to this function.
 792
 793     @header{wx/app.h}
 794 */
 795 bool wxInitialize();
 796
 797 /**
 798     This function is for use in console (wxBase) programs only. It must be called
 799     once for each previous successful call to wxInitialize().
 800
 801     @header{wx/app.h}
 802 */
 803 void wxUninitialize();
 804
 805 /**
 806     This function wakes up the (internal and platform dependent) idle system,
 807     i.e. it will force the system to send an idle event even if the system
 808     currently @e is idle and thus would not send any idle event until after
 809     some other event would get sent. This is also useful for sending events
 810     between two threads and is used by the corresponding functions
 811     wxPostEvent() and wxEvtHandler::AddPendingEvent().
 812
 813     @header{wx/app.h}
 814 */
 815 void wxWakeUpIdle();
 816
 817 /**
 818     Calls wxAppConsole::Yield.
 819
 820     @deprecated
 821     This function is kept only for backwards compatibility. Please use
 822     the wxAppConsole::Yield method instead in any new code.
 823
 824     @header{wx/app.h}
 825 */
 826 bool wxYield();
 827
 828 /**
 829     Calls wxApp::SafeYield.
 830
 831     @header{wx/app.h}
 832 */
 833 bool wxSafeYield(wxWindow* win = NULL, bool onlyIfNeeded = false);
 834
 835 /**
 836     This function initializes wxWidgets in a platform-dependent way. Use this if you
 837     are not using the default wxWidgets entry code (e.g. main or WinMain).
 838
 839     For example, you can initialize wxWidgets from an Microsoft Foundation Classes
 840     (MFC) application using this function.
 841
 842     @note This overload of wxEntry is available under all platforms.
 843
 844     @see wxEntryStart()
 845
 846     @header{wx/app.h}
 847 */
 848 int wxEntry(int& argc, wxChar** argv);
 849
 850 /**
 851     See wxEntry(int&,wxChar**) for more info about this function.
 852
 853     Notice that under Windows CE platform, and only there, the type of @a pCmdLine
 854     is @c wchar_t *, otherwise it is @c char *, even in Unicode build.
 855
 856     @remarks To clean up wxWidgets, call wxApp::OnExit followed by the static
 857              function wxApp::CleanUp. For example, if exiting from an MFC application
 858              that also uses wxWidgets:
 859              @code
 860              int CTheApp::ExitInstance()
 861              {
 862                 // OnExit isn't called by CleanUp so must be called explicitly.
 863                 wxTheApp->OnExit();
 864                 wxApp::CleanUp();
 865
 866                 return CWinApp::ExitInstance();
 867              }
 868              @endcode
 869
 870     @header{wx/app.h}
 871 */
 872 int wxEntry(HINSTANCE hInstance,
 873             HINSTANCE hPrevInstance = NULL,
 874             char* pCmdLine = NULL,
 875             int nCmdShow = SW_SHOWNORMAL);
 876
 877 //@}
 878
 879
 880
 881 /** @addtogroup group_funcmacro_procctrl */
 882 //@{
 883
 884 /**
 885     Exits application after calling wxApp::OnExit.
 886
 887     Should only be used in an emergency: normally the top-level frame
 888     should be deleted (after deleting all other frames) to terminate the
 889     application. See wxCloseEvent and wxApp.
 890
 891     @header{wx/app.h}
 892 */
 893 void wxExit();
 894
 895 //@}
 896