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