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 events posted with wxEvtHandler::QueueEvent or wxEvtHandler::AddPendingEvent.
 129
 130         This happens during each event loop iteration (see wxEventLoopBase) in GUI mode but
 131         it may be also called directly.
 132
 133         Note that this function does not only process the pending events for the wxApp object
 134         itself (which derives from wxEvtHandler) but also the pending events for @e any
 135         event handler of this application.
 136
 137         This function will immediately return and do nothing if SuspendProcessingOfPendingEvents()
 138         was called.
 139     */
 140     virtual void ProcessPendingEvents();
 141
 142     /**
 143         Deletes the pending events of all wxEvtHandlers of this application.
 144
 145         See wxEvtHandler::DeletePendingEvents() for warnings about deleting the pending
 146         events.
 147     */
 148     void DeletePendingEvents();
 149
 150     /**
 151         Returns @true if there are pending events on the internal pending event list.
 152
 153         Whenever wxEvtHandler::QueueEvent or wxEvtHandler::AddPendingEvent() are
 154         called (not only for wxApp itself, but for any event handler of the application!),
 155         the internal wxApp's list of handlers with pending events is updated and this
 156         function will return true.
 157     */
 158     bool HasPendingEvents() const;
 159
 160     /**
 161         Temporary suspends processing of the pending events.
 162
 163         @see ResumeProcessingOfPendingEvents()
 164     */
 165     void SuspendProcessingOfPendingEvents();
 166
 167     /**
 168         Resume processing of the pending events previously stopped because of a
 169         call to SuspendProcessingOfPendingEvents().
 170     */
 171     void ResumeProcessingOfPendingEvents();
 172
 173     //@}
 174
 175
 176     /**
 177         Allows external code to modify global ::wxTheApp, but you should really
 178         know what you're doing if you call it.
 179
 180         @param app
 181             Replacement for the global application object.
 182
 183         @see GetInstance()
 184     */
 185     static void SetInstance(wxAppConsole* app);
 186
 187     /**
 188         Returns the one and only global application object.
 189         Usually ::wxTheApp is used instead.
 190
 191         @see SetInstance()
 192     */
 193     static wxAppConsole* GetInstance();
 194
 195     /**
 196         Returns @true if the main event loop is currently running, i.e. if the
 197         application is inside OnRun().
 198
 199         This can be useful to test whether events can be dispatched. For example,
 200         if this function returns @false, non-blocking sockets cannot be used because
 201         the events from them would never be processed.
 202     */
 203     static bool IsMainLoopRunning();
 204
 205
 206     /**
 207         @name Mac-specific functions
 208     */
 209     //@{
 210
 211     /**
 212         Called in response of an "open-application" Apple event.
 213         Override this to create a new document in your app.
 214
 215         @onlyfor{wxmac}
 216     */
 217     virtual void MacNewFile();
 218
 219     /**
 220         Called in response of an "open-document" Apple event.
 221
 222         You need to override this method in order to open a document file after the
 223         user double clicked on it or if the document file was dropped on either the
 224         running application or the application icon in Finder.
 225
 226         @onlyfor{wxmac}
 227     */
 228     virtual void MacOpenFile(const wxString& fileName);
 229
 230     /**
 231         Called in response of a "get-url" Apple event.
 232
 233         @onlyfor{wxmac}
 234     */
 235     virtual void MacOpenURL(const wxString& url);
 236
 237     /**
 238         Called in response of a "print-document" Apple event.
 239
 240         @onlyfor{wxmac}
 241     */
 242     virtual void MacPrintFile(const wxString& fileName);
 243
 244     /**
 245         Called in response of a "reopen-application" Apple event.
 246
 247         @onlyfor{wxmac}
 248     */
 249     virtual void MacReopenApp();
 250
 251     //@}
 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 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 inside
 424         OnRun() (the exceptions which occur during the program startup and shutdown
 425         might not be caught at all). Notice that by now the main event loop has been
 426         terminated and the program will exit, if you want to prevent this from happening
 427         (i.e. continue running after catching an exception) you need to override
 428         OnExceptionInMainLoop().
 429
 430         The default implementation shows information about the exception in debug build
 431         but does nothing in the release build.
 432     */
 433     virtual void OnUnhandledException();
 434
 435     //@}
 436
 437
 438     /**
 439         @name Application informations
 440     */
 441     //@{
 442
 443     /**
 444         Returns the user-readable application name.
 445
 446         The difference between this string and the one returned by GetAppName()
 447         is that this one is meant to be shown to the user and so should be used
 448         for the window titles, page headers and so on while the other one
 449         should be only used internally, e.g. for the file names or
 450         configuration file keys. By default, returns the application name as
 451         returned by GetAppName() capitalized using wxString::Capitalize().
 452
 453         @since 2.9.0
 454     */
 455     wxString GetAppDisplayName() const;
 456
 457     /**
 458         Returns the application name.
 459
 460         @remarks wxWidgets sets this to a reasonable default before calling
 461                  OnInit(), but the application can reset it at will.
 462
 463         @see GetAppDisplayName()
 464     */
 465     wxString GetAppName() const;
 466
 467     /**
 468         Gets the class name of the application. The class name may be used in a
 469         platform specific manner to refer to the application.
 470
 471         @see SetClassName()
 472     */
 473     wxString GetClassName() const;
 474
 475     /**
 476         Returns a pointer to the wxAppTraits object for the application.
 477         If you want to customize the wxAppTraits object, you must override the
 478         CreateTraits() function.
 479     */
 480     wxAppTraits* GetTraits();
 481
 482     /**
 483         Returns the user-readable vendor name. The difference between this string
 484         and the one returned by GetVendorName() is that this one is meant to be shown
 485         to the user and so should be used for the window titles, page headers and so on
 486         while the other one should be only used internally, e.g. for the file names or
 487         configuration file keys.
 488
 489         By default, returns the same string as GetVendorName().
 490
 491         @since 2.9.0
 492     */
 493     const wxString& GetVendorDisplayName() const;
 494
 495     /**
 496         Returns the application's vendor name.
 497     */
 498     const wxString& GetVendorName() const;
 499
 500     /**
 501         Set the application name to be used in the user-visible places such as
 502         window titles.
 503
 504         See GetAppDisplayName() for more about the differences between the
 505         display name and name.
 506
 507         Notice that if this function is called, the name is used as is, without
 508         any capitalization as done by default by GetAppDisplayName().
 509     */
 510     void SetAppDisplayName(const wxString& name);
 511
 512     /**
 513         Sets the name of the application. This name should be used for file names,
 514         configuration file entries and other internal strings. For the user-visible
 515         strings, such as the window titles, the application display name set by
 516         SetAppDisplayName() is used instead.
 517
 518         By default the application name is set to the name of its executable file.
 519
 520         @see GetAppName()
 521     */
 522     void SetAppName(const wxString& name);
 523
 524     /**
 525         Sets the class name of the application. This may be used in a platform specific
 526         manner to refer to the application.
 527
 528         @see GetClassName()
 529     */
 530     void SetClassName(const wxString& name);
 531
 532     /**
 533         Set the vendor name to be used in the user-visible places.
 534         See GetVendorDisplayName() for more about the differences between the
 535         display name and name.
 536     */
 537     void SetVendorDisplayName(const wxString& name);
 538
 539     /**
 540         Sets the name of application's vendor. The name will be used
 541         in registry access. A default name is set by wxWidgets.
 542
 543         @see GetVendorName()
 544     */
 545     void SetVendorName(const wxString& name);
 546
 547     //@}
 548
 549
 550     /**
 551         Number of command line arguments (after environment-specific processing).
 552     */
 553     int argc;
 554
 555     /**
 556         Command line arguments (after environment-specific processing).
 557
 558         Under Windows and Linux/Unix, you should parse the command line
 559         arguments and check for files to be opened when starting your
 560         application. Under OS X, you need to override MacOpenFile()
 561         since command line arguments are used differently there.
 562
 563         You may use the wxCmdLineParser to parse command line arguments.
 564     */
 565     wxChar** argv;
 566 };
 567
 568
 569
 570
 571 /**
 572     @class wxApp
 573
 574     The wxApp class represents the application itself when @c wxUSE_GUI=1.
 575
 576     In addition to the features provided by wxAppConsole it keeps track of
 577     the <em>top window</em> (see SetTopWindow()) and adds support for
 578     video modes (see SetVideoMode()).
 579
 580     In general, application-wide settings for GUI-only apps are accessible
 581     from wxApp (or from wxSystemSettings or wxSystemOptions classes).
 582
 583     @beginEventEmissionTable
 584     @event{EVT_QUERY_END_SESSION(func)}
 585         Process a query end session event, supplying the member function.
 586         See wxCloseEvent.
 587     @event{EVT_END_SESSION(func)}
 588         Process an end session event, supplying the member function.
 589         See wxCloseEvent.
 590     @event{EVT_ACTIVATE_APP(func)}
 591         Process a @c wxEVT_ACTIVATE_APP event. See wxActivateEvent.
 592     @event{EVT_HIBERNATE(func)}
 593         Process a hibernate event. See wxActivateEvent.
 594     @event{EVT_DIALUP_CONNECTED(func)}
 595         A connection with the network was established. See wxDialUpEvent.
 596     @event{EVT_DIALUP_DISCONNECTED(func)}
 597         The connection with the network was lost. See wxDialUpEvent.
 598     @event{EVT_IDLE(func)}
 599         Process a @c wxEVT_IDLE event. See wxIdleEvent.
 600     @endEventTable
 601
 602     @library{wxbase}
 603     @category{appmanagement}
 604
 605     @see @ref overview_app, wxAppTraits, wxEventLoopBase, wxSystemSettings
 606 */
 607 class wxApp : public wxAppConsole
 608 {
 609 public:
 610     /**
 611         Constructor. Called implicitly with a definition of a wxApp object.
 612     */
 613     wxApp();
 614
 615     /**
 616         Destructor. Will be called implicitly on program exit if the wxApp
 617         object is created on the stack.
 618     */
 619     virtual ~wxApp();
 620
 621     /**
 622         Get display mode that is used use. This is only used in framebuffer
 623         wxWidgets ports (such as wxMGL or wxDFB).
 624     */
 625     virtual wxVideoMode GetDisplayMode() const;
 626
 627     /**
 628         Returns @true if the application will exit when the top-level frame is deleted.
 629
 630         @see SetExitOnFrameDelete()
 631     */
 632     bool GetExitOnFrameDelete() const;
 633
 634     /**
 635         Return the layout direction for the current locale or @c wxLayout_Default
 636         if it's unknown.
 637     */
 638     virtual wxLayoutDirection GetLayoutDirection() const;
 639
 640     /**
 641         Returns @true if the application will use the best visual on systems that support
 642         different visuals, @false otherwise.
 643
 644         @see SetUseBestVisual()
 645     */
 646     bool GetUseBestVisual() const;
 647
 648     /**
 649         Returns a pointer to the top window.
 650
 651         @remarks
 652             If the top window hasn't been set using SetTopWindow(), this function
 653             will find the first top-level window (frame or dialog or instance of
 654             wxTopLevelWindow) from the internal top level window list and return that.
 655
 656         @see SetTopWindow()
 657     */
 658     virtual wxWindow* GetTopWindow() const;
 659
 660     /**
 661         Returns @true if the application is active, i.e. if one of its windows is
 662         currently in the foreground.
 663
 664         If this function returns @false and you need to attract users attention to
 665         the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
 666     */
 667     virtual bool IsActive() const;
 668
 669     /**
 670         This function is similar to wxYield(), except that it disables the user
 671         input to all program windows before calling wxAppConsole::Yield and re-enables it
 672         again afterwards. If @a win is not @NULL, this window will remain enabled,
 673         allowing the implementation of some limited user interaction.
 674         Returns the result of the call to wxAppConsole::Yield.
 675
 676         @see wxSafeYield
 677     */
 678     virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded);
 679
 680     /**
 681         Works like SafeYield() with @e onlyIfNeeded == @true except that
 682         it allows the caller to specify a mask of events to be processed.
 683
 684         See wxAppConsole::YieldFor for more info.
 685     */
 686     virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);
 687
 688     /**
 689         Windows-only function for processing a message. This function is called
 690         from the main message loop, checking for windows that may wish to process it.
 691
 692         The function returns @true if the message was processed, @false otherwise.
 693         If you use wxWidgets with another class library with its own message loop,
 694         you should make sure that this function is called to allow wxWidgets to
 695         receive messages. For example, to allow co-existence with the Microsoft
 696         Foundation Classes, override the PreTranslateMessage function:
 697
 698         @code
 699         // Provide wxWidgets message loop compatibility
 700         BOOL CTheApp::PreTranslateMessage(MSG *msg)
 701         {
 702             if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
 703                 return true;
 704             else
 705                 return CWinApp::PreTranslateMessage(msg);
 706         }
 707         @endcode
 708
 709         @onlyfor{wxmsw}
 710     */
 711     bool ProcessMessage(WXMSG* msg);
 712
 713     /**
 714         Sends idle events to a window and its children.
 715         Please note that this function is internal to wxWidgets and shouldn't be used
 716         by user code.
 717
 718         @remarks These functions poll the top-level windows, and their children,
 719                  for idle event processing. If @true is returned, more OnIdle
 720                  processing is requested by one or more window.
 721
 722         @see wxIdleEvent
 723     */
 724     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 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
 795 // ============================================================================
 796 // Global functions/macros
 797 // ============================================================================
 798
 799
 800 /** @addtogroup group_funcmacro_rtti */
 801 //@{
 802
 803 /**
 804     This is used in headers to create a forward declaration of the ::wxGetApp()
 805     function implemented by IMPLEMENT_APP().
 806
 807     It creates the declaration <tt>className& wxGetApp()</tt>.
 808
 809     @header{wx/app.h}
 810
 811     Example:
 812
 813     @code
 814     DECLARE_APP(MyApp)
 815     @endcode
 816 */
 817 #define DECLARE_APP( className )
 818
 819 /**
 820     This is used in the application class implementation file to make the
 821     application class known to wxWidgets for dynamic construction.
 822
 823     @header{wx/app.h}
 824
 825     Example:
 826
 827     @code
 828     IMPLEMENT_APP(MyApp)
 829     @endcode
 830
 831     @see DECLARE_APP().
 832 */
 833 #define IMPLEMENT_APP( className )
 834
 835 //@}
 836
 837
 838
 839 /**
 840     The global pointer to the singleton wxApp object.
 841
 842     @see wxApp::GetInstance()
 843 */
 844 wxApp *wxTheApp;
 845
 846
 847
 848 /** @addtogroup group_funcmacro_appinitterm */
 849 //@{
 850
 851 /**
 852     This function doesn't exist in wxWidgets but it is created by using the
 853     IMPLEMENT_APP() macro.
 854
 855     Thus, before using it anywhere but in the same module where this macro is
 856     used, you must make it available using DECLARE_APP().
 857
 858     The advantage of using this function compared to directly using the global
 859     ::wxTheApp pointer is that the latter is of type wxApp* and so wouldn't
 860     allow you to access the functions specific to your application class but
 861     not present in wxApp while wxGetApp() returns the object of the right type.
 862
 863     @header{wx/app.h}
 864 */
 865 wxAppDerivedClass& wxGetApp();
 866
 867 /**
 868     If @a doIt is @true, the fatal exceptions (also known as general protection
 869     faults under Windows or segmentation violations in the Unix world) will be
 870     caught and passed to wxApp::OnFatalException.
 871
 872     By default, i.e. before this function is called, they will be handled in
 873     the normal way which usually just means that the application will be
 874     terminated. Calling wxHandleFatalExceptions() with @a doIt equal to @false
 875     will restore this default behaviour.
 876
 877     Notice that this function is only available if @c wxUSE_ON_FATAL_EXCEPTION
 878     is 1 and under Windows platform this requires a compiler with support for
 879     SEH (structured exception handling) which currently means only Microsoft
 880     Visual C++ or a recent Borland C++ version.
 881
 882     @header{wx/app.h}
 883 */
 884 bool wxHandleFatalExceptions(bool doIt = true);
 885
 886 /**
 887     This function is used in wxBase only and only if you don't create
 888     wxApp object at all. In this case you must call it from your
 889     @c main() function before calling any other wxWidgets functions.
 890
 891     If the function returns @false the initialization could not be performed,
 892     in this case the library cannot be used and wxUninitialize() shouldn't be
 893     called neither.
 894
 895     This function may be called several times but wxUninitialize() must be
 896     called for each successful call to this function.
 897
 898     @header{wx/app.h}
 899 */
 900 bool wxInitialize();
 901
 902 /**
 903     This function is for use in console (wxBase) programs only. It must be called
 904     once for each previous successful call to wxInitialize().
 905
 906     @header{wx/app.h}
 907 */
 908 void wxUninitialize();
 909
 910 /**
 911     This function wakes up the (internal and platform dependent) idle system,
 912     i.e. it will force the system to send an idle event even if the system
 913     currently @e is idle and thus would not send any idle event until after
 914     some other event would get sent. This is also useful for sending events
 915     between two threads and is used by the corresponding functions
 916     wxPostEvent() and wxEvtHandler::AddPendingEvent().
 917
 918     @header{wx/app.h}
 919 */
 920 void wxWakeUpIdle();
 921
 922 /**
 923     Calls wxAppConsole::Yield.
 924
 925     @deprecated
 926     This function is kept only for backwards compatibility. Please use
 927     the wxAppConsole::Yield method instead in any new code.
 928
 929     @header{wx/app.h}
 930 */
 931 bool wxYield();
 932
 933 /**
 934     Calls wxApp::SafeYield.
 935
 936     @header{wx/app.h}
 937 */
 938 bool wxSafeYield(wxWindow* win = NULL, bool onlyIfNeeded = false);
 939
 940 /**
 941     This function initializes wxWidgets in a platform-dependent way. Use this if you
 942     are not using the default wxWidgets entry code (e.g. main or WinMain).
 943
 944     For example, you can initialize wxWidgets from an Microsoft Foundation Classes
 945     (MFC) application using this function.
 946
 947     @note This overload of wxEntry is available under all platforms.
 948
 949     @see wxEntryStart()
 950
 951     @header{wx/app.h}
 952 */
 953 int wxEntry(int& argc, wxChar** argv);
 954
 955 /**
 956     See wxEntry(int&,wxChar**) for more info about this function.
 957
 958     Notice that under Windows CE platform, and only there, the type of @a pCmdLine
 959     is @c wchar_t *, otherwise it is @c char *, even in Unicode build.
 960
 961     @remarks To clean up wxWidgets, call wxApp::OnExit followed by the static
 962              function wxApp::CleanUp. For example, if exiting from an MFC application
 963              that also uses wxWidgets:
 964              @code
 965              int CTheApp::ExitInstance()
 966              {
 967                 // OnExit isn't called by CleanUp so must be called explicitly.
 968                 wxTheApp->OnExit();
 969                 wxApp::CleanUp();
 970
 971                 return CWinApp::ExitInstance();
 972              }
 973              @endcode
 974
 975     @header{wx/app.h}
 976 */
 977 int wxEntry(HINSTANCE hInstance,
 978             HINSTANCE hPrevInstance = NULL,
 979             char* pCmdLine = NULL,
 980             int nCmdShow = SW_SHOWNORMAL);
 981
 982 //@}
 983
 984
 985
 986 /** @addtogroup group_funcmacro_procctrl */
 987 //@{
 988
 989 /**
 990     Exits application after calling wxApp::OnExit.
 991
 992     Should only be used in an emergency: normally the top-level frame
 993     should be deleted (after deleting all other frames) to terminate the
 994     application. See wxCloseEvent and wxApp.
 995
 996     @header{wx/app.h}
 997 */
 998 void wxExit();
 999
1000 //@}
1001