interface/wx/app.h

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