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