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         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 inside
 472         OnRun() (the exceptions which occur during the program startup and shutdown
 473         might not be caught at all). Notice that by now the main event loop has been
 474         terminated and the program will exit, if you want to prevent this from happening
 475         (i.e. continue running after catching an exception) you need to override
 476         OnExceptionInMainLoop().
 477
 478         The default implementation shows information about the exception in debug build
 479         but does nothing in the release build.
 480     */
 481     virtual void OnUnhandledException();
 482
 483     //@}
 484
 485
 486     /**
 487         @name Application informations
 488     */
 489     //@{
 490
 491     /**
 492         Returns the user-readable application name.
 493
 494         The difference between this string and the one returned by GetAppName()
 495         is that this one is meant to be shown to the user and so should be used
 496         for the window titles, page headers and so on while the other one
 497         should be only used internally, e.g. for the file names or
 498         configuration file keys. By default, returns the application name as
 499         returned by GetAppName() capitalized using wxString::Capitalize().
 500
 501         @since 2.9.0
 502     */
 503     wxString GetAppDisplayName() const;
 504
 505     /**
 506         Returns the application name.
 507
 508         @remarks wxWidgets sets this to a reasonable default before calling
 509                  OnInit(), but the application can reset it at will.
 510
 511         @see GetAppDisplayName()
 512     */
 513     wxString GetAppName() const;
 514
 515     /**
 516         Gets the class name of the application. The class name may be used in a
 517         platform specific manner to refer to the application.
 518
 519         @see SetClassName()
 520     */
 521     wxString GetClassName() const;
 522
 523     /**
 524         Returns a pointer to the wxAppTraits object for the application.
 525         If you want to customize the wxAppTraits object, you must override the
 526         CreateTraits() function.
 527     */
 528     wxAppTraits* GetTraits();
 529
 530     /**
 531         Returns the user-readable vendor name. The difference between this string
 532         and the one returned by GetVendorName() is that this one is meant to be shown
 533         to the user and so should be used for the window titles, page headers and so on
 534         while the other one should be only used internally, e.g. for the file names or
 535         configuration file keys.
 536
 537         By default, returns the same string as GetVendorName().
 538
 539         @since 2.9.0
 540     */
 541     const wxString& GetVendorDisplayName() const;
 542
 543     /**
 544         Returns the application's vendor name.
 545     */
 546     const wxString& GetVendorName() const;
 547
 548     /**
 549         Set the application name to be used in the user-visible places such as
 550         window titles.
 551
 552         See GetAppDisplayName() for more about the differences between the
 553         display name and name.
 554
 555         Notice that if this function is called, the name is used as is, without
 556         any capitalization as done by default by GetAppDisplayName().
 557     */
 558     void SetAppDisplayName(const wxString& name);
 559
 560     /**
 561         Sets the name of the application. This name should be used for file names,
 562         configuration file entries and other internal strings. For the user-visible
 563         strings, such as the window titles, the application display name set by
 564         SetAppDisplayName() is used instead.
 565
 566         By default the application name is set to the name of its executable file.
 567
 568         @see GetAppName()
 569     */
 570     void SetAppName(const wxString& name);
 571
 572     /**
 573         Sets the class name of the application. This may be used in a platform specific
 574         manner to refer to the application.
 575
 576         @see GetClassName()
 577     */
 578     void SetClassName(const wxString& name);
 579
 580     /**
 581         Set the vendor name to be used in the user-visible places.
 582         See GetVendorDisplayName() for more about the differences between the
 583         display name and name.
 584     */
 585     void SetVendorDisplayName(const wxString& name);
 586
 587     /**
 588         Sets the name of application's vendor. The name will be used
 589         in registry access. A default name is set by wxWidgets.
 590
 591         @see GetVendorName()
 592     */
 593     void SetVendorName(const wxString& name);
 594
 595     //@}
 596
 597
 598     /**
 599         Number of command line arguments (after environment-specific processing).
 600     */
 601     int argc;
 602
 603     /**
 604         Command line arguments (after environment-specific processing).
 605
 606         Under Windows and Linux/Unix, you should parse the command line
 607         arguments and check for files to be opened when starting your
 608         application. Under OS X, you need to override MacOpenFile()
 609         since command line arguments are used differently there.
 610
 611         You may use the wxCmdLineParser to parse command line arguments.
 612     */
 613     wxChar** argv;
 614 };
 615
 616
 617
 618
 619 /**
 620     @class wxApp
 621
 622     The wxApp class represents the application itself when @c wxUSE_GUI=1.
 623
 624     In addition to the features provided by wxAppConsole it keeps track of
 625     the <em>top window</em> (see SetTopWindow()) and adds support for
 626     video modes (see SetVideoMode()).
 627
 628     In general, application-wide settings for GUI-only apps are accessible
 629     from wxApp (or from wxSystemSettings or wxSystemOptions classes).
 630
 631     @beginEventEmissionTable
 632     @event{EVT_QUERY_END_SESSION(func)}
 633         Process a query end session event, supplying the member function.
 634         See wxCloseEvent.
 635     @event{EVT_END_SESSION(func)}
 636         Process an end session event, supplying the member function.
 637         See wxCloseEvent.
 638     @event{EVT_ACTIVATE_APP(func)}
 639         Process a @c wxEVT_ACTIVATE_APP event. See wxActivateEvent.
 640     @event{EVT_HIBERNATE(func)}
 641         Process a hibernate event. See wxActivateEvent.
 642     @event{EVT_DIALUP_CONNECTED(func)}
 643         A connection with the network was established. See wxDialUpEvent.
 644     @event{EVT_DIALUP_DISCONNECTED(func)}
 645         The connection with the network was lost. See wxDialUpEvent.
 646     @event{EVT_IDLE(func)}
 647         Process a @c wxEVT_IDLE event. See wxIdleEvent.
 648     @endEventTable
 649
 650     @library{wxbase}
 651     @category{appmanagement}
 652
 653     @see @ref overview_app, wxAppTraits, wxEventLoopBase, wxSystemSettings
 654 */
 655 class wxApp : public wxAppConsole
 656 {
 657 public:
 658     /**
 659         Constructor. Called implicitly with a definition of a wxApp object.
 660     */
 661     wxApp();
 662
 663     /**
 664         Destructor. Will be called implicitly on program exit if the wxApp
 665         object is created on the stack.
 666     */
 667     virtual ~wxApp();
 668
 669     /**
 670         Get display mode that is used use. This is only used in framebuffer
 671         wxWidgets ports (such as wxMGL or wxDFB).
 672     */
 673     virtual wxVideoMode GetDisplayMode() const;
 674
 675     /**
 676         Returns @true if the application will exit when the top-level frame is deleted.
 677
 678         @see SetExitOnFrameDelete()
 679     */
 680     bool GetExitOnFrameDelete() const;
 681
 682     /**
 683         Return the layout direction for the current locale or @c wxLayout_Default
 684         if it's unknown.
 685     */
 686     virtual wxLayoutDirection GetLayoutDirection() const;
 687
 688     /**
 689         Returns @true if the application will use the best visual on systems that support
 690         different visuals, @false otherwise.
 691
 692         @see SetUseBestVisual()
 693     */
 694     bool GetUseBestVisual() const;
 695
 696     /**
 697         Returns a pointer to the top window.
 698
 699         @remarks
 700             If the top window hasn't been set using SetTopWindow(), this function
 701             will find the first top-level window (frame or dialog or instance of
 702             wxTopLevelWindow) from the internal top level window list and return that.
 703
 704         @see SetTopWindow()
 705     */
 706     virtual wxWindow* GetTopWindow() const;
 707
 708     /**
 709         Returns @true if the application is active, i.e. if one of its windows is
 710         currently in the foreground.
 711
 712         If this function returns @false and you need to attract users attention to
 713         the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
 714     */
 715     virtual bool IsActive() const;
 716
 717     /**
 718         This function is similar to wxYield(), except that it disables the user
 719         input to all program windows before calling wxAppConsole::Yield and re-enables it
 720         again afterwards. If @a win is not @NULL, this window will remain enabled,
 721         allowing the implementation of some limited user interaction.
 722         Returns the result of the call to wxAppConsole::Yield.
 723
 724         @see wxSafeYield
 725     */
 726     virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded);
 727
 728     /**
 729         Works like SafeYield() with @e onlyIfNeeded == @true except that
 730         it allows the caller to specify a mask of events to be processed.
 731
 732         See wxAppConsole::YieldFor for more info.
 733     */
 734     virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);
 735
 736     /**
 737         Windows-only function for processing a message. This function is called
 738         from the main message loop, checking for windows that may wish to process it.
 739
 740         The function returns @true if the message was processed, @false otherwise.
 741         If you use wxWidgets with another class library with its own message loop,
 742         you should make sure that this function is called to allow wxWidgets to
 743         receive messages. For example, to allow co-existence with the Microsoft
 744         Foundation Classes, override the PreTranslateMessage function:
 745
 746         @code
 747         // Provide wxWidgets message loop compatibility
 748         BOOL CTheApp::PreTranslateMessage(MSG *msg)
 749         {
 750             if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
 751                 return true;
 752             else
 753                 return CWinApp::PreTranslateMessage(msg);
 754         }
 755         @endcode
 756
 757         @onlyfor{wxmsw}
 758     */
 759     bool ProcessMessage(WXMSG* msg);
 760
 761     /**
 762         Sends idle events to a window and its children.
 763         Please note that this function is internal to wxWidgets and shouldn't be used
 764         by user code.
 765
 766         @remarks These functions poll the top-level windows, and their children,
 767                  for idle event processing. If @true is returned, more OnIdle
 768                  processing is requested by one or more window.
 769
 770         @see wxIdleEvent
 771     */
 772     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 773
 774     /**
 775         Set display mode to use. This is only used in framebuffer wxWidgets
 776         ports (such as wxMGL or wxDFB).
 777     */
 778     virtual bool SetDisplayMode(const wxVideoMode& info);
 779
 780     /**
 781         Allows the programmer to specify whether the application will exit when the
 782         top-level frame is deleted.
 783
 784         @param flag
 785             If @true (the default), the application will exit when the top-level frame
 786             is deleted. If @false, the application will continue to run.
 787
 788         @see GetExitOnFrameDelete(), @ref overview_app_shutdown
 789     */
 790     void SetExitOnFrameDelete(bool flag);
 791
 792     /**
 793         Allows runtime switching of the UI environment theme.
 794
 795         Currently implemented for wxGTK2-only.
 796         Return @true if theme was successfully changed.
 797
 798         @param theme
 799             The name of the new theme or an absolute path to a gtkrc-theme-file
 800     */
 801     virtual bool SetNativeTheme(const wxString& theme);
 802
 803     /**
 804         Sets the 'top' window. You can call this from within OnInit() to let wxWidgets
 805         know which is the main window. You don't have to set the top window;
 806         it is only a convenience so that (for example) certain dialogs without parents
 807         can use a specific window as the top window.
 808
 809         If no top window is specified by the application, wxWidgets just uses the
 810         first frame or dialog (or better, any wxTopLevelWindow) in its top-level
 811         window list, when it needs to use the top window.
 812         If you previously called SetTopWindow() and now you need to restore this
 813         automatic behaviour you can call @code wxApp::SetTopWindow(NULL) @endcode.
 814
 815         @param window
 816             The new top window.
 817
 818         @see GetTopWindow(), OnInit()
 819     */
 820     void SetTopWindow(wxWindow* window);
 821
 822     /**
 823         Allows the programmer to specify whether the application will use the best
 824         visual on systems that support several visual on the same display. This is typically
 825         the case under Solaris and IRIX, where the default visual is only 8-bit whereas
 826         certain applications are supposed to run in TrueColour mode.
 827
 828         Note that this function has to be called in the constructor of the wxApp
 829         instance and won't have any effect when called later on.
 830         This function currently only has effect under GTK.
 831
 832         @param flag
 833             If @true, the app will use the best visual.
 834         @param forceTrueColour
 835             If @true then the application will try to force using a TrueColour
 836             visual and abort the app if none is found.
 837     */
 838     void SetUseBestVisual(bool flag, bool forceTrueColour = false);
 839 };
 840
 841
 842
 843 // ============================================================================
 844 // Global functions/macros
 845 // ============================================================================
 846
 847
 848 /** @addtogroup group_funcmacro_rtti */
 849 //@{
 850
 851 /**
 852     This is used in headers to create a forward declaration of the ::wxGetApp()
 853     function implemented by IMPLEMENT_APP().
 854
 855     It creates the declaration <tt>className& wxGetApp()</tt>.
 856
 857     @header{wx/app.h}
 858
 859     Example:
 860
 861     @code
 862     DECLARE_APP(MyApp)
 863     @endcode
 864 */
 865 #define DECLARE_APP( className )
 866
 867 /**
 868     This is used in the application class implementation file to make the
 869     application class known to wxWidgets for dynamic construction.
 870
 871     @header{wx/app.h}
 872
 873     Example:
 874
 875     @code
 876     IMPLEMENT_APP(MyApp)
 877     @endcode
 878
 879     @see DECLARE_APP().
 880 */
 881 #define IMPLEMENT_APP( className )
 882
 883 //@}
 884
 885
 886
 887 /**
 888     The global pointer to the singleton wxApp object.
 889
 890     @see wxApp::GetInstance()
 891 */
 892 wxApp *wxTheApp;
 893
 894
 895
 896 /** @addtogroup group_funcmacro_appinitterm */
 897 //@{
 898
 899 /**
 900     This function doesn't exist in wxWidgets but it is created by using the
 901     IMPLEMENT_APP() macro.
 902
 903     Thus, before using it anywhere but in the same module where this macro is
 904     used, you must make it available using DECLARE_APP().
 905
 906     The advantage of using this function compared to directly using the global
 907     ::wxTheApp pointer is that the latter is of type wxApp* and so wouldn't
 908     allow you to access the functions specific to your application class but
 909     not present in wxApp while wxGetApp() returns the object of the right type.
 910
 911     @header{wx/app.h}
 912 */
 913 wxAppDerivedClass& wxGetApp();
 914
 915 /**
 916     If @a doIt is @true, the fatal exceptions (also known as general protection
 917     faults under Windows or segmentation violations in the Unix world) will be
 918     caught and passed to wxApp::OnFatalException.
 919
 920     By default, i.e. before this function is called, they will be handled in
 921     the normal way which usually just means that the application will be
 922     terminated. Calling wxHandleFatalExceptions() with @a doIt equal to @false
 923     will restore this default behaviour.
 924
 925     Notice that this function is only available if @c wxUSE_ON_FATAL_EXCEPTION
 926     is 1 and under Windows platform this requires a compiler with support for
 927     SEH (structured exception handling) which currently means only Microsoft
 928     Visual C++ or a recent Borland C++ version.
 929
 930     @header{wx/app.h}
 931 */
 932 bool wxHandleFatalExceptions(bool doIt = true);
 933
 934 /**
 935     This function is used in wxBase only and only if you don't create
 936     wxApp object at all. In this case you must call it from your
 937     @c main() function before calling any other wxWidgets functions.
 938
 939     If the function returns @false the initialization could not be performed,
 940     in this case the library cannot be used and wxUninitialize() shouldn't be
 941     called neither.
 942
 943     This function may be called several times but wxUninitialize() must be
 944     called for each successful call to this function.
 945
 946     @header{wx/app.h}
 947 */
 948 bool wxInitialize();
 949
 950 /**
 951     This function is for use in console (wxBase) programs only. It must be called
 952     once for each previous successful call to wxInitialize().
 953
 954     @header{wx/app.h}
 955 */
 956 void wxUninitialize();
 957
 958 /**
 959     This function wakes up the (internal and platform dependent) idle system,
 960     i.e. it will force the system to send an idle event even if the system
 961     currently @e is idle and thus would not send any idle event until after
 962     some other event would get sent. This is also useful for sending events
 963     between two threads and is used by the corresponding functions
 964     wxPostEvent() and wxEvtHandler::AddPendingEvent().
 965
 966     @header{wx/app.h}
 967 */
 968 void wxWakeUpIdle();
 969
 970 /**
 971     Calls wxAppConsole::Yield.
 972
 973     @deprecated
 974     This function is kept only for backwards compatibility. Please use
 975     the wxAppConsole::Yield method instead in any new code.
 976
 977     @header{wx/app.h}
 978 */
 979 bool wxYield();
 980
 981 /**
 982     Calls wxApp::SafeYield.
 983
 984     @header{wx/app.h}
 985 */
 986 bool wxSafeYield(wxWindow* win = NULL, bool onlyIfNeeded = false);
 987
 988 /**
 989     This function initializes wxWidgets in a platform-dependent way. Use this if you
 990     are not using the default wxWidgets entry code (e.g. main or WinMain).
 991
 992     For example, you can initialize wxWidgets from an Microsoft Foundation Classes
 993     (MFC) application using this function.
 994
 995     @note This overload of wxEntry is available under all platforms.
 996
 997     @see wxEntryStart()
 998
 999     @header{wx/app.h}
1000 */
1001 int wxEntry(int& argc, wxChar** argv);
1002
1003 /**
1004     See wxEntry(int&,wxChar**) for more info about this function.
1005
1006     Notice that under Windows CE platform, and only there, the type of @a pCmdLine
1007     is @c wchar_t *, otherwise it is @c char *, even in Unicode build.
1008
1009     @remarks To clean up wxWidgets, call wxApp::OnExit followed by the static
1010              function wxApp::CleanUp. For example, if exiting from an MFC application
1011              that also uses wxWidgets:
1012              @code
1013              int CTheApp::ExitInstance()
1014              {
1015                 // OnExit isn't called by CleanUp so must be called explicitly.
1016                 wxTheApp->OnExit();
1017                 wxApp::CleanUp();
1018
1019                 return CWinApp::ExitInstance();
1020              }
1021              @endcode
1022
1023     @header{wx/app.h}
1024 */
1025 int wxEntry(HINSTANCE hInstance,
1026             HINSTANCE hPrevInstance = NULL,
1027             char* pCmdLine = NULL,
1028             int nCmdShow = SW_SHOWNORMAL);
1029
1030 //@}
1031
1032
1033
1034 /** @addtogroup group_funcmacro_procctrl */
1035 //@{
1036
1037 /**
1038     Exits application after calling wxApp::OnExit.
1039
1040     Should only be used in an emergency: normally the top-level frame
1041     should be deleted (after deleting all other frames) to terminate the
1042     application. See wxCloseEvent and wxApp.
1043
1044     @header{wx/app.h}
1045 */
1046 void wxExit();
1047
1048 //@}
1049