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