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