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 wxUSE_GUI=0.
  15
  16     @todo MORE INFO
  17
  18     @library{wxbase}
  19     @category{appmanagement}
  20
  21     @see @ref overview_app
  22 */
  23 class wxAppConsole : public wxEvtHandler
  24 {
  25 protected:
  26     /**
  27         Creates the wxAppTraits object when GetTraits() needs it for the first time.
  28
  29         @see wxAppTraits
  30     */
  31     virtual wxAppTraits* CreateTraits();
  32
  33 public:
  34
  35     /**
  36         Destructor.
  37     */
  38     virtual ~wxAppConsole();
  39
  40     /**
  41         Dispatches the next event in the windowing system event queue.
  42         Blocks until an event appears if there are none currently
  43         (use Pending() if this is not wanted).
  44
  45         This can be used for programming event loops, e.g.
  46
  47         @code
  48         while (app.Pending())
  49             Dispatch();
  50         @endcode
  51
  52         @return @false if the event loop should stop and @true otherwise.
  53
  54         @see Pending()
  55     */
  56     virtual bool Dispatch();
  57
  58     /**
  59         Call this to explicitly exit the main message (event) loop.
  60         You should normally exit the main loop (and the application) by deleting
  61         the top window.
  62     */
  63     virtual void ExitMainLoop();
  64
  65     /**
  66         This function is called before processing any event and allows the application
  67         to preempt the processing of some events.
  68
  69         If this method returns -1 the event is processed normally, otherwise either
  70         @true or @false should be returned and the event processing stops immediately
  71         considering that the event had been already processed (for the former return
  72         value) or that it is not going to be processed at all (for the latter one).
  73     */
  74     virtual int FilterEvent(wxEvent& event);
  75
  76     /**
  77         Returns the user-readable application name.
  78
  79         The difference between this string and the one returned by GetAppName()
  80         is that this one is meant to be shown to the user and so should be used
  81         for the window titles, page headers and so on while the other one
  82         should be only used internally, e.g. for the file names or
  83         configuration file keys. By default, returns the application name as
  84         returned by GetAppName() capitalized using wxString::Capitalize().
  85
  86         @since 2.9.0
  87     */
  88     wxString GetAppDisplayName() const;
  89
  90     /**
  91         Returns the application name.
  92
  93         @remarks wxWidgets sets this to a reasonable default before calling
  94                  OnInit(), but the application can reset it at will.
  95
  96         @see GetAppDisplayName()
  97     */
  98     wxString GetAppName() const;
  99
 100     /**
 101         Gets the class name of the application. The class name may be used in a
 102         platform specific manner to refer to the application.
 103
 104         @see SetClassName()
 105     */
 106     wxString GetClassName() const;
 107
 108     /**
 109         Returns the one and only global application object.
 110         Usually wxTheApp is used instead.
 111
 112         @see SetInstance()
 113     */
 114     static wxAppConsole* GetInstance();
 115
 116     /**
 117         Returns a pointer to the wxAppTraits object for the application.
 118         If you want to customize the wxAppTraits object, you must override the
 119         CreateTraits() function.
 120     */
 121     wxAppTraits* GetTraits();
 122
 123     /**
 124         Returns the user-readable vendor name. The difference between this string
 125         and the one returned by GetVendorName() is that this one is meant to be shown
 126         to the user and so should be used for the window titles, page headers and so on
 127         while the other one should be only used internally, e.g. for the file names or
 128         configuration file keys.
 129
 130         By default, returns the same string as GetVendorName().
 131
 132         @since 2.9.0
 133     */
 134     const wxString& GetVendorDisplayName() const;
 135
 136     /**
 137         Returns the application's vendor name.
 138     */
 139     const wxString& GetVendorName() const;
 140
 141     /**
 142         This function simply invokes the given method @a func of the specified
 143         event handler @a handler with the @a event as parameter. It exists solely
 144         to allow to catch the C++ exceptions which could be thrown by all event
 145         handlers in the application in one place: if you want to do this, override
 146         this function in your wxApp-derived class and add try/catch clause(s) to it.
 147     */
 148     virtual void HandleEvent(wxEvtHandler* handler,
 149                              wxEventFunction func,
 150                              wxEvent& event) const;
 151
 152     /**
 153         Returns @true if the main event loop is currently running, i.e. if the
 154         application is inside OnRun().
 155
 156         This can be useful to test whether events can be dispatched. For example,
 157         if this function returns @false, non-blocking sockets cannot be used because
 158         the events from them would never be processed.
 159     */
 160     static bool IsMainLoopRunning();
 161
 162     /**
 163         Called in response of an "open-application" Apple event.
 164         Override this to create a new document in your app.
 165
 166         @onlyfor{wxmac}
 167     */
 168     virtual void MacNewFile();
 169
 170     /**
 171         Called in response of an "open-document" Apple event.
 172
 173         You need to override this method in order to open a document file after the
 174         user double clicked on it or if the document file was dropped on either the
 175         running application or the application icon in Finder.
 176
 177         @onlyfor{wxmac}
 178     */
 179     virtual void MacOpenFile(const wxString& fileName);
 180
 181     /**
 182         Called in response of a "get-url" Apple event.
 183
 184         @onlyfor{wxmac}
 185     */
 186     virtual void MacOpenURL(const wxString& url);
 187
 188     /**
 189         Called in response of a "print-document" Apple event.
 190
 191         @onlyfor{wxmac}
 192     */
 193     virtual void MacPrintFile(const wxString& fileName);
 194
 195     /**
 196         Called in response of a "reopen-application" Apple event.
 197
 198         @onlyfor{wxmac}
 199     */
 200     virtual void MacReopenApp();
 201
 202     /**
 203         Called by wxWidgets on creation of the application. Override this if you wish
 204         to provide your own (environment-dependent) main loop.
 205
 206         @return 0 under X, and the wParam of the WM_QUIT message under Windows.
 207     */
 208     virtual int MainLoop();
 209
 210     /**
 211         This function is called when an assert failure occurs, i.e. the condition
 212         specified in wxASSERT() macro evaluated to @false.
 213
 214         It is only called in debug mode (when @c __WXDEBUG__ is defined) as
 215         asserts are not left in the release code at all.
 216         The base class version shows the default assert failure dialog box proposing to
 217         the user to stop the program, continue or ignore all subsequent asserts.
 218
 219         @param file
 220             the name of the source file where the assert occurred
 221         @param line
 222             the line number in this file where the assert occurred
 223         @param func
 224             the name of the function where the assert occurred, may be
 225             empty if the compiler doesn't support C99 __FUNCTION__
 226         @param cond
 227             the condition of the failed assert in text form
 228         @param msg
 229             the message specified as argument to wxASSERT_MSG or wxFAIL_MSG, will
 230             be @NULL if just wxASSERT or wxFAIL was used
 231     */
 232     virtual void OnAssertFailure(const wxChar *file,
 233                                  int line,
 234                                  const wxChar *func,
 235                                  const wxChar *cond,
 236                                  const wxChar *msg);
 237
 238     /**
 239         Called when command line parsing fails (i.e. an incorrect command line option
 240         was specified by the user). The default behaviour is to show the program usage
 241         text and abort the program.
 242
 243         Return @true to continue normal execution or @false to return
 244         @false from OnInit() thus terminating the program.
 245
 246         @see OnInitCmdLine()
 247     */
 248     virtual bool OnCmdLineError(wxCmdLineParser& parser);
 249
 250     /**
 251         Called when the help option (@c --help) was specified on the command line.
 252         The default behaviour is to show the program usage text and abort the program.
 253
 254         Return @true to continue normal execution or @false to return
 255         @false from OnInit() thus terminating the program.
 256
 257         @see OnInitCmdLine()
 258     */
 259     virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
 260
 261     /**
 262         Called after the command line had been successfully parsed. You may override
 263         this method to test for the values of the various parameters which could be
 264         set from the command line.
 265
 266         Don't forget to call the base class version unless you want to suppress
 267         processing of the standard command line options.
 268         Return @true to continue normal execution or @false to return @false from
 269         OnInit() thus terminating the program.
 270
 271         @see OnInitCmdLine()
 272     */
 273     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
 274
 275     /**
 276         This function is called if an unhandled exception occurs inside the main
 277         application event loop. It can return @true to ignore the exception and to
 278         continue running the loop or @false to exit the loop and terminate the
 279         program. In the latter case it can also use C++ @c throw keyword to
 280         rethrow the current exception.
 281
 282         The default behaviour of this function is the latter in all ports except under
 283         Windows where a dialog is shown to the user which allows him to choose between
 284         the different options. You may override this function in your class to do
 285         something more appropriate.
 286
 287         Finally note that if the exception is rethrown from here, it can be caught in
 288         OnUnhandledException().
 289     */
 290     virtual bool OnExceptionInMainLoop();
 291
 292     /**
 293         Override this member function for any processing which needs to be
 294         done as the application is about to exit. OnExit is called after
 295         destroying all application windows and controls, but before
 296         wxWidgets cleanup. Note that it is not called at all if
 297         OnInit() failed.
 298
 299         The return value of this function is currently ignored, return the same
 300         value as returned by the base class method if you override it.
 301     */
 302     virtual int OnExit();
 303
 304     /**
 305         This function may be called if something fatal happens: an unhandled
 306         exception under Win32 or a a fatal signal under Unix, for example. However,
 307         this will not happen by default: you have to explicitly call
 308         wxHandleFatalExceptions() to enable this.
 309
 310         Generally speaking, this function should only show a message to the user and
 311         return. You may attempt to save unsaved data but this is not guaranteed to
 312         work and, in fact, probably won't.
 313
 314         @see wxHandleFatalExceptions()
 315     */
 316     virtual void OnFatalException();
 317
 318     /**
 319         This must be provided by the application, and will usually create the
 320         application's main window, optionally calling SetTopWindow().
 321
 322         You may use OnExit() to clean up anything initialized here, provided
 323         that the function returns @true.
 324
 325         Notice that if you want to to use the command line processing provided by
 326         wxWidgets you have to call the base class version in the derived class
 327         OnInit().
 328
 329         Return @true to continue processing, @false to exit the application
 330         immediately.
 331     */
 332     virtual bool OnInit();
 333
 334     /**
 335         Called from OnInit() and may be used to initialize the parser with the
 336         command line options for this application. The base class versions adds
 337         support for a few standard options only.
 338     */
 339     virtual void OnInitCmdLine(wxCmdLineParser& parser);
 340
 341     /**
 342         This virtual function is where the execution of a program written in wxWidgets
 343         starts. The default implementation just enters the main loop and starts
 344         handling the events until it terminates, either because ExitMainLoop() has
 345         been explicitly called or because the last frame has been deleted and
 346         GetExitOnFrameDelete() flag is @true (this is the default).
 347
 348         The return value of this function becomes the exit code of the program, so it
 349         should return 0 in case of successful termination.
 350     */
 351     virtual int OnRun();
 352
 353     /**
 354         This function is called when an unhandled C++ exception occurs inside
 355         OnRun() (the exceptions which occur during the program startup and shutdown
 356         might not be caught at all). Notice that by now the main event loop has been
 357         terminated and the program will exit, if you want to prevent this from happening
 358         (i.e. continue running after catching an exception) you need to override
 359         OnExceptionInMainLoop().
 360
 361         The default implementation shows information about the exception in debug build
 362         but does nothing in the release build.
 363     */
 364     virtual void OnUnhandledException();
 365
 366     /**
 367         Returns @true if unprocessed events are in the window system event queue.
 368
 369         @see Dispatch()
 370     */
 371     virtual bool Pending();
 372
 373     /**
 374         Set the application name to be used in the user-visible places such as
 375         window titles.
 376
 377         See GetAppDisplayName() for more about the differences between the
 378         display name and name.
 379
 380         Notice that if this function is called, the name is used as is, without
 381         any capitalization as done by default by GetAppDisplayName().
 382     */
 383     void SetAppDisplayName(const wxString& name);
 384
 385     /**
 386         Sets the name of the application. This name should be used for file names,
 387         configuration file entries and other internal strings. For the user-visible
 388         strings, such as the window titles, the application display name set by
 389         SetAppDisplayName() is used instead.
 390
 391         By default the application name is set to the name of its executable file.
 392
 393         @see GetAppName()
 394     */
 395     void SetAppName(const wxString& name);
 396
 397     /**
 398         Sets the class name of the application. This may be used in a platform specific
 399         manner to refer to the application.
 400
 401         @see GetClassName()
 402     */
 403     void SetClassName(const wxString& name);
 404
 405     /**
 406         Allows external code to modify global ::wxTheApp, but you should really
 407         know what you're doing if you call it.
 408
 409         @param app
 410             Replacement for the global application object.
 411
 412         @see GetInstance()
 413     */
 414     static void SetInstance(wxAppConsole* app);
 415
 416     /**
 417         Set the vendor name to be used in the user-visible places.
 418         See GetVendorDisplayName() for more about the differences between the
 419         display name and name.
 420     */
 421     void SetVendorDisplayName(const wxString& name);
 422
 423     /**
 424         Sets the name of application's vendor. The name will be used
 425         in registry access. A default name is set by wxWidgets.
 426
 427         @see GetVendorName()
 428     */
 429     void SetVendorName(const wxString& name);
 430
 431     /**
 432         Yields control to pending messages in the windowing system.
 433
 434         This can be useful, for example, when a time-consuming process writes to a
 435         text window. Without an occasional yield, the text window will not be updated
 436         properly, and on systems with cooperative multitasking, such as Windows 3.1
 437         other processes will not respond.
 438
 439         Caution should be exercised, however, since yielding may allow the
 440         user to perform actions which are not compatible with the current task.
 441         Disabling menu items or whole menus during processing can avoid unwanted
 442         reentrance of code: see ::wxSafeYield for a better function.
 443
 444         Note that Yield() will not flush the message logs. This is intentional as
 445         calling Yield() is usually done to quickly update the screen and popping up
 446         a message box dialog may be undesirable. If you do wish to flush the log
 447         messages immediately (otherwise it will be done during the next idle loop
 448         iteration), call wxLog::FlushActive.
 449
 450         Calling Yield() recursively is normally an error and an assert failure is
 451         raised in debug build if such situation is detected. However if the
 452         @a onlyIfNeeded parameter is @true, the method will just silently
 453         return @false instead.
 454     */
 455     virtual bool Yield(bool onlyIfNeeded = false);
 456
 457     /**
 458         Number of command line arguments (after environment-specific processing).
 459     */
 460     int argc;
 461
 462     /**
 463         Command line arguments (after environment-specific processing).
 464
 465         Under Windows and Linux/Unix, you should parse the command line
 466         arguments and check for files to be opened when starting your
 467         application. Under OS X, you need to override MacOpenFile()
 468         since command line arguments are used differently there.
 469
 470         You may use the wxCmdLineParser to parse command line arguments.
 471     */
 472     wxChar** argv;
 473 };
 474
 475
 476
 477
 478 /**
 479     @class wxApp
 480
 481     The wxApp class represents the application itself. It is used to:
 482
 483     @li set and get application-wide properties;
 484     @li implement the windowing system message or event loop;
 485     @li initiate application processing via wxApp::OnInit;
 486     @li allow default processing of events not handled by other
 487         objects in the application.
 488
 489     You should use the macro IMPLEMENT_APP(appClass) in your application
 490     implementation file to tell wxWidgets how to create an instance of your
 491     application class.
 492
 493     Use DECLARE_APP(appClass) in a header file if you want the wxGetApp function
 494     (which returns a reference to your application object) to be visible to other
 495     files.
 496
 497     @library{wxbase}
 498     @category{appmanagement}
 499
 500     @see @ref overview_app
 501 */
 502 class wxApp : public wxAppConsole
 503 {
 504 public:
 505     /**
 506         Constructor. Called implicitly with a definition of a wxApp object.
 507     */
 508     wxApp();
 509
 510     /**
 511         Destructor. Will be called implicitly on program exit if the wxApp
 512         object is created on the stack.
 513     */
 514     virtual ~wxApp();
 515
 516     /**
 517         Returns @true if the application will exit when the top-level frame is deleted.
 518
 519         @see SetExitOnFrameDelete()
 520     */
 521     bool GetExitOnFrameDelete() const;
 522
 523     /**
 524         Returns @true if the application will use the best visual on systems that support
 525         different visuals, @false otherwise.
 526
 527         @see SetUseBestVisual()
 528     */
 529     bool GetUseBestVisual() const;
 530
 531     /**
 532         Returns a pointer to the top window.
 533
 534         @remarks If the top window hasn't been set using SetTopWindow(),
 535                  this function will find the first top-level window
 536                  (frame or dialog) and return that.
 537
 538         @see SetTopWindow()
 539     */
 540     virtual wxWindow* GetTopWindow() const;
 541
 542     /**
 543         Returns @true if the application is active, i.e. if one of its windows is
 544         currently in the foreground.
 545
 546         If this function returns @false and you need to attract users attention to
 547         the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
 548     */
 549     virtual bool IsActive() const;
 550
 551     /**
 552         Windows-only function for processing a message. This function is called
 553         from the main message loop, checking for windows that may wish to process it.
 554
 555         The function returns @true if the message was processed, @false otherwise.
 556         If you use wxWidgets with another class library with its own message loop,
 557         you should make sure that this function is called to allow wxWidgets to
 558         receive messages. For example, to allow co-existence with the Microsoft
 559         Foundation Classes, override the PreTranslateMessage function:
 560
 561         @code
 562         // Provide wxWidgets message loop compatibility
 563         BOOL CTheApp::PreTranslateMessage(MSG *msg)
 564         {
 565             if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
 566                 return true;
 567             else
 568                 return CWinApp::PreTranslateMessage(msg);
 569         }
 570         @endcode
 571
 572         @onlyfor{wxmsw}
 573     */
 574     bool ProcessMessage(WXMSG* msg);
 575
 576     /**
 577         Sends idle events to a window and its children.
 578         Please note that this function is internal to wxWidgets and shouldn't be used
 579         by user code.
 580
 581         @remarks These functions poll the top-level windows, and their children,
 582                  for idle event processing. If @true is returned, more OnIdle
 583                  processing is requested by one or more window.
 584
 585         @see wxIdleEvent
 586     */
 587     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 588
 589     /**
 590         Allows the programmer to specify whether the application will exit when the
 591         top-level frame is deleted.
 592
 593         @param flag
 594             If @true (the default), the application will exit when the top-level frame
 595             is deleted. If @false, the application will continue to run.
 596
 597         @see GetExitOnFrameDelete(), @ref overview_app_shutdown
 598     */
 599     void SetExitOnFrameDelete(bool flag);
 600
 601     /**
 602         Allows external code to modify global ::wxTheApp, but you should really
 603         know what you're doing if you call it.
 604
 605         @param app
 606             Replacement for the global application object.
 607
 608         @see GetInstance()
 609     */
 610     static void SetInstance(wxAppConsole* app);
 611
 612     /**
 613         Allows runtime switching of the UI environment theme.
 614
 615         Currently implemented for wxGTK2-only.
 616         Return @true if theme was successfully changed.
 617
 618         @param theme
 619             The name of the new theme or an absolute path to a gtkrc-theme-file
 620     */
 621     virtual bool SetNativeTheme(const wxString& theme);
 622
 623     /**
 624         Sets the 'top' window. You can call this from within OnInit() to let wxWidgets
 625         know which is the main window. You don't have to set the top window;
 626         it is only a convenience so that (for example) certain dialogs without parents
 627         can use a specific window as the top window. If no top window is specified by the
 628         application, wxWidgets just uses the first frame or dialog in its top-level window
 629         list, when it needs to use the top window.
 630
 631         @param window
 632             The new top window.
 633
 634         @see GetTopWindow(), OnInit()
 635     */
 636     void SetTopWindow(wxWindow* window);
 637
 638     /**
 639         Allows the programmer to specify whether the application will use the best
 640         visual on systems that support several visual on the same display. This is typically
 641         the case under Solaris and IRIX, where the default visual is only 8-bit whereas
 642         certain applications are supposed to run in TrueColour mode.
 643
 644         Note that this function has to be called in the constructor of the wxApp
 645         instance and won't have any effect when called later on.
 646         This function currently only has effect under GTK.
 647
 648         @param flag
 649             If @true, the app will use the best visual.
 650         @param forceTrueColour
 651             If @true then the application will try to force using a TrueColour
 652             visual and abort the app if none is found.
 653     */
 654     void SetUseBestVisual(bool flag, bool forceTrueColour = false);
 655 };
 656
 657
 658
 659 // ============================================================================
 660 // Global functions/macros
 661 // ============================================================================
 662
 663
 664 /** @ingroup group_funcmacro_rtti */
 665 //@{
 666
 667 /**
 668     This is used in headers to create a forward declaration of the wxGetApp()
 669     function implemented by IMPLEMENT_APP().
 670
 671     It creates the declaration <tt>className& wxGetApp()</tt>.
 672
 673     @header{wx/app.h}
 674
 675     Example:
 676
 677     @code
 678     DECLARE_APP(MyApp)
 679     @endcode
 680 */
 681 #define DECLARE_APP( className )
 682
 683 /**
 684     This is used in the application class implementation file to make the
 685     application class known to wxWidgets for dynamic construction.
 686
 687     @header{wx/app.h}
 688
 689     Example:
 690
 691     @code
 692     IMPLEMENT_APP(MyApp)
 693     @endcode
 694
 695     @see DECLARE_APP().
 696 */
 697 #define IMPLEMENT_APP( className )
 698
 699 //@}
 700
 701
 702
 703 /**
 704     The global pointer to the singleton wxApp object.
 705
 706     @see wxApp::GetInstance()
 707 */
 708 wxApp *wxTheApp;
 709
 710
 711
 712 /** @ingroup group_funcmacro_appinitterm */
 713 //@{
 714
 715 /**
 716     This function doesn't exist in wxWidgets but it is created by using the
 717     IMPLEMENT_APP() macro.
 718
 719     Thus, before using it anywhere but in the same module where this macro is
 720     used, you must make it available using DECLARE_APP().
 721
 722     The advantage of using this function compared to directly using the global
 723     ::wxTheApp pointer is that the latter is of type wxApp* and so wouldn't
 724     allow you to access the functions specific to your application class but
 725     not present in wxApp while wxGetApp() returns the object of the right type.
 726
 727     @header{wx/app.h}
 728 */
 729 wxAppDerivedClass& wxGetApp();
 730
 731 /**
 732     If @a doIt is @true, the fatal exceptions (also known as general protection
 733     faults under Windows or segmentation violations in the Unix world) will be
 734     caught and passed to wxApp::OnFatalException.
 735
 736     By default, i.e. before this function is called, they will be handled in
 737     the normal way which usually just means that the application will be
 738     terminated. Calling wxHandleFatalExceptions() with @a doIt equal to @false
 739     will restore this default behaviour.
 740
 741     Notice that this function is only available if @c wxUSE_ON_FATAL_EXCEPTION
 742     is 1 and under Windows platform this requires a compiler with support for
 743     SEH (structured exception handling) which currently means only Microsoft
 744     Visual C++ or a recent Borland C++ version.
 745
 746     @header{wx/app.h}
 747 */
 748 bool wxHandleFatalExceptions(bool doIt = true);
 749
 750 /**
 751     This function is used in wxBase only and only if you don't create
 752     wxApp object at all. In this case you must call it from your
 753     @c main() function before calling any other wxWidgets functions.
 754
 755     If the function returns @false the initialization could not be performed,
 756     in this case the library cannot be used and wxUninitialize() shouldn't be
 757     called neither.
 758
 759     This function may be called several times but wxUninitialize() must be
 760     called for each successful call to this function.
 761
 762     @header{wx/app.h}
 763 */
 764 bool wxInitialize();
 765
 766 /**
 767     This function is for use in console (wxBase) programs only. It must be called
 768     once for each previous successful call to wxInitialize().
 769
 770     @header{wx/app.h}
 771 */
 772 void wxUninitialize();
 773
 774 /**
 775     This function wakes up the (internal and platform dependent) idle system,
 776     i.e. it will force the system to send an idle event even if the system
 777     currently @e is idle and thus would not send any idle event until after
 778     some other event would get sent. This is also useful for sending events
 779     between two threads and is used by the corresponding functions
 780     wxPostEvent() and wxEvtHandler::AddPendingEvent().
 781
 782     @header{wx/app.h}
 783 */
 784 void wxWakeUpIdle();
 785
 786 /**
 787     Calls wxApp::Yield.
 788
 789     @deprecated
 790     This function is kept only for backwards compatibility. Please use
 791     the wxApp::Yield method instead in any new code.
 792
 793     @header{wx/app.h}
 794 */
 795 bool wxYield();
 796
 797 /**
 798     This function is similar to wxYield, except that it disables the user input to
 799     all program windows before calling wxYield and re-enables it again
 800     afterwards. If @a win is not @NULL, this window will remain enabled,
 801     allowing the implementation of some limited user interaction.
 802     Returns the result of the call to ::wxYield.
 803
 804     @header{wx/app.h}
 805 */
 806 bool wxSafeYield(wxWindow* win = NULL, bool onlyIfNeeded = false);
 807
 808 /**
 809     This function initializes wxWidgets in a platform-dependent way. Use this if you
 810     are not using the default wxWidgets entry code (e.g. main or WinMain).
 811
 812     For example, you can initialize wxWidgets from an Microsoft Foundation Classes
 813     (MFC) application using this function.
 814
 815     @note This overload of wxEntry is available under all platforms.
 816
 817     @see wxEntryStart()
 818
 819     @header{wx/app.h}
 820 */
 821 int wxEntry(int& argc, wxChar** argv);
 822
 823 /**
 824     See wxEntry(int&,wxChar**) for more info about this function.
 825
 826     Notice that under Windows CE platform, and only there, the type of @a pCmdLine
 827     is @c wchar_t *, otherwise it is @c char *, even in Unicode build.
 828
 829     @remarks To clean up wxWidgets, call wxApp::OnExit followed by the static
 830              function wxApp::CleanUp. For example, if exiting from an MFC application
 831              that also uses wxWidgets:
 832              @code
 833              int CTheApp::ExitInstance()
 834              {
 835                 // OnExit isn't called by CleanUp so must be called explicitly.
 836                 wxTheApp->OnExit();
 837                 wxApp::CleanUp();
 838
 839                 return CWinApp::ExitInstance();
 840              }
 841              @endcode
 842
 843     @header{wx/app.h}
 844 */
 845 int wxEntry(HINSTANCE hInstance,
 846             HINSTANCE hPrevInstance = NULL,
 847             char* pCmdLine = NULL,
 848             int nCmdShow = SW_SHOWNORMAL);
 849
 850 //@}
 851
 852
 853
 854 /** @ingroup group_funcmacro_procctrl */
 855 //@{
 856
 857 /**
 858     Exits application after calling wxApp::OnExit.
 859
 860     Should only be used in an emergency: normally the top-level frame
 861     should be deleted (after deleting all other frames) to terminate the
 862     application. See wxCloseEvent and wxApp.
 863
 864     @header{wx/app.h}
 865 */
 866 void wxExit();
 867
 868 //@}
 869