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