interface/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     @wxheader{app.h}
  13
  14     This class is essential for writing console-only or hybrid apps without
  15     having to define wxUSE_GUI=0.
  16
  17     @todo MORE INFO
  18
  19     @library{wxbase}
  20     @category{appmanagement}
  21
  22     @see @ref overview_app
  23 */
  24 class wxAppConsole : public wxEvtHandler
  25 {
  26 protected:
  27     /**
  28         Creates the wxAppTraits object when GetTraits() needs it for the first time.
  29
  30         @see wxAppTraits
  31     */
  32     virtual wxAppTraits* CreateTraits();
  33
  34 public:
  35
  36     /**
  37         Destructor.
  38     */
  39     virtual ~wxAppConsole();
  40
  41     /**
  42         Dispatches the next event in the windowing system event queue.
  43         Blocks until an event appears if there are none currently
  44         (use Pending() if this is not wanted).
  45
  46         This can be used for programming event loops, e.g.
  47
  48         @code
  49         while (app.Pending())
  50             Dispatch();
  51         @endcode
  52
  53         @return @false if the event loop should stop and @true otherwise.
  54
  55         @see Pending()
  56     */
  57     virtual bool Dispatch();
  58
  59     /**
  60         Call this to explicitly exit the main message (event) loop.
  61         You should normally exit the main loop (and the application) by deleting
  62         the top window.
  63     */
  64     virtual void ExitMainLoop();
  65
  66     /**
  67         This function is called before processing any event and allows the application
  68         to preempt the processing of some events.
  69
  70         If this method returns -1 the event is processed normally, otherwise either
  71         @true or @false should be returned and the event processing stops immediately
  72         considering that the event had been already processed (for the former return
  73         value) or that it is not going to be processed at all (for the latter one).
  74     */
  75     virtual int FilterEvent(wxEvent& event);
  76
  77     /**
  78         Returns the user-readable application name.
  79
  80         The difference between this string and the one returned by GetAppName() is that
  81         this one is meant to be shown to the user and so should be used for the window
  82         titles, page headers and so on while the other one should be only used internally,
  83         e.g. for the file names or configuration file keys.
  84         By default, returns the same string as GetAppName().
  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 usead 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 window
 375         titles. See GetAppDisplayName() for more about the differences between the
 376         display name and name.
 377     */
 378     void SetAppDisplayName(const wxString& name);
 379
 380     /**
 381         Sets the name of the application. This name should be used for file names,
 382         configuration file entries and other internal strings. For the user-visible
 383         strings, such as the window titles, the application display name set by
 384         SetAppDisplayName() is used instead.
 385
 386         By default the application name is set to the name of its executable file.
 387
 388         @see GetAppName()
 389     */
 390     void SetAppName(const wxString& name);
 391
 392     /**
 393         Sets the class name of the application. This may be used in a platform specific
 394         manner to refer to the application.
 395
 396         @see GetClassName()
 397     */
 398     void SetClassName(const wxString& name);
 399
 400     /**
 401         Allows external code to modify global ::wxTheApp, but you should really
 402         know what you're doing if you call it.
 403
 404         @param app
 405             Replacement for the global application object.
 406
 407         @see GetInstance()
 408     */
 409     static void SetInstance(wxAppConsole* app);
 410
 411     /**
 412         Set the vendor name to be used in the user-visible places.
 413         See GetVendorDisplayName() for more about the differences between the
 414         display name and name.
 415     */
 416     void SetVendorDisplayName(const wxString& name);
 417
 418     /**
 419         Sets the name of application's vendor. The name will be used
 420         in registry access. A default name is set by wxWidgets.
 421
 422         @see GetVendorName()
 423     */
 424     void SetVendorName(const wxString& name);
 425
 426     /**
 427         Yields control to pending messages in the windowing system.
 428
 429         This can be useful, for example, when a time-consuming process writes to a
 430         text window. Without an occasional yield, the text window will not be updated
 431         properly, and on systems with cooperative multitasking, such as Windows 3.1
 432         other processes will not respond.
 433
 434         Caution should be exercised, however, since yielding may allow the
 435         user to perform actions which are not compatible with the current task.
 436         Disabling menu items or whole menus during processing can avoid unwanted
 437         reentrance of code: see ::wxSafeYield for a better function.
 438
 439         Note that Yield() will not flush the message logs. This is intentional as
 440         calling Yield() is usually done to quickly update the screen and popping up
 441         a message box dialog may be undesirable. If you do wish to flush the log
 442         messages immediately (otherwise it will be done during the next idle loop
 443         iteration), call wxLog::FlushActive.
 444
 445         Calling Yield() recursively is normally an error and an assert failure is
 446         raised in debug build if such situation is detected. However if the
 447         @a onlyIfNeeded parameter is @true, the method will just silently
 448         return @false instead.
 449     */
 450     virtual bool Yield(bool onlyIfNeeded = false);
 451
 452     /**
 453         Number of command line arguments (after environment-specific processing).
 454     */
 455     int argc;
 456
 457     /**
 458         Command line arguments (after environment-specific processing).
 459
 460         Under Windows and Linux/Unix, you should parse the command line
 461         arguments and check for files to be opened when starting your
 462         application. Under OS X, you need to override MacOpenFile()
 463         since command line arguments are used differently there.
 464
 465         You may use the wxCmdLineParser to parse command line arguments.
 466     */
 467     wxChar** argv;
 468 };
 469
 470
 471
 472
 473 /**
 474     @class wxApp
 475     @wxheader{app.h}
 476
 477     The wxApp class represents the application itself. It is used to:
 478
 479     @li set and get application-wide properties;
 480     @li implement the windowing system message or event loop;
 481     @li initiate application processing via wxApp::OnInit;
 482     @li allow default processing of events not handled by other
 483         objects in the application.
 484
 485     You should use the macro IMPLEMENT_APP(appClass) in your application
 486     implementation file to tell wxWidgets how to create an instance of your
 487     application class.
 488
 489     Use DECLARE_APP(appClass) in a header file if you want the wxGetApp function
 490     (which returns a reference to your application object) to be visible to other
 491     files.
 492
 493     @library{wxbase}
 494     @category{appmanagement}
 495
 496     @see @ref overview_app
 497 */
 498 class wxApp : public wxAppConsole
 499 {
 500 public:
 501     /**
 502         Constructor. Called implicitly with a definition of a wxApp object.
 503     */
 504     wxApp();
 505
 506     /**
 507         Destructor. Will be called implicitly on program exit if the wxApp
 508         object is created on the stack.
 509     */
 510     virtual ~wxApp();
 511
 512     /**
 513         Returns @true if the application will exit when the top-level frame is deleted.
 514
 515         @see SetExitOnFrameDelete()
 516     */
 517     bool GetExitOnFrameDelete() const;
 518
 519     /**
 520         Returns @true if the application will use the best visual on systems that support
 521         different visuals, @false otherwise.
 522
 523         @see SetUseBestVisual()
 524     */
 525     bool GetUseBestVisual() const;
 526
 527     /**
 528         Returns a pointer to the top window.
 529
 530         @remarks If the top window hasn't been set using SetTopWindow(),
 531                  this function will find the first top-level window
 532                  (frame or dialog) and return that.
 533
 534         @see SetTopWindow()
 535     */
 536     virtual wxWindow* GetTopWindow() const;
 537
 538     /**
 539         Returns @true if the application is active, i.e. if one of its windows is
 540         currently in the foreground.
 541
 542         If this function returns @false and you need to attract users attention to
 543         the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
 544     */
 545     virtual bool IsActive() const;
 546
 547     /**
 548         Windows-only function for processing a message. This function is called
 549         from the main message loop, checking for windows that may wish to process it.
 550
 551         The function returns @true if the message was processed, @false otherwise.
 552         If you use wxWidgets with another class library with its own message loop,
 553         you should make sure that this function is called to allow wxWidgets to
 554         receive messages. For example, to allow co-existence with the Microsoft
 555         Foundation Classes, override the PreTranslateMessage function:
 556
 557         @code
 558         // Provide wxWidgets message loop compatibility
 559         BOOL CTheApp::PreTranslateMessage(MSG *msg)
 560         {
 561             if (wxTheApp && wxTheApp->ProcessMessage((WXMSW *)msg))
 562                 return true;
 563             else
 564                 return CWinApp::PreTranslateMessage(msg);
 565         }
 566         @endcode
 567
 568         @onlyfor{wxmsw}
 569     */
 570     bool ProcessMessage(WXMSG* msg);
 571
 572     /**
 573         Sends idle events to a window and its children.
 574         Please note that this function is internal to wxWidgets and shouldn't be used
 575         by user code.
 576
 577         @remarks These functions poll the top-level windows, and their children,
 578                  for idle event processing. If @true is returned, more OnIdle
 579                  processing is requested by one or more window.
 580
 581         @see wxIdleEvent
 582     */
 583     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 584
 585     /**
 586         Allows the programmer to specify whether the application will exit when the
 587         top-level frame is deleted.
 588
 589         @param flag
 590             If @true (the default), the application will exit when the top-level frame
 591             is deleted. If @false, the application will continue to run.
 592
 593         @see GetExitOnFrameDelete(), @ref overview_app_shutdown
 594     */
 595     void SetExitOnFrameDelete(bool flag);
 596
 597     /**
 598         Allows external code to modify global ::wxTheApp, but you should really
 599         know what you're doing if you call it.
 600
 601         @param app
 602             Replacement for the global application object.
 603
 604         @see GetInstance()
 605     */
 606     static void SetInstance(wxAppConsole* app);
 607
 608     /**
 609         Allows runtime switching of the UI environment theme.
 610
 611         Currently implemented for wxGTK2-only.
 612         Return @true if theme was successfully changed.
 613
 614         @param theme
 615             The name of the new theme or an absolute path to a gtkrc-theme-file
 616     */
 617     virtual bool SetNativeTheme(const wxString& theme);
 618
 619     /**
 620         Sets the 'top' window. You can call this from within OnInit() to let wxWidgets
 621         know which is the main window. You don't have to set the top window;
 622         it is only a convenience so that (for example) certain dialogs without parents
 623         can use a specific window as the top window. If no top window is specified by the
 624         application, wxWidgets just uses the first frame or dialog in its top-level window
 625         list, when it needs to use the top window.
 626
 627         @param window
 628             The new top window.
 629
 630         @see GetTopWindow(), OnInit()
 631     */
 632     void SetTopWindow(wxWindow* window);
 633
 634     /**
 635         Allows the programmer to specify whether the application will use the best
 636         visual on systems that support several visual on the same display. This is typically
 637         the case under Solaris and IRIX, where the default visual is only 8-bit whereas
 638         certain applications are supposed to run in TrueColour mode.
 639
 640         Note that this function has to be called in the constructor of the wxApp
 641         instance and won't have any effect when called later on.
 642         This function currently only has effect under GTK.
 643
 644         @param flag
 645             If @true, the app will use the best visual.
 646         @param forceTrueColour
 647             If @true then the application will try to force using a TrueColour
 648             visual and abort the app if none is found.
 649     */
 650     void SetUseBestVisual(bool flag, bool forceTrueColour = false);
 651 };
 652
 653
 654
 655 // ============================================================================
 656 // Global functions/macros
 657 // ============================================================================
 658
 659
 660 /** @ingroup group_funcmacro_rtti */
 661 //@{
 662
 663 /**
 664     This is used in headers to create a forward declaration of the wxGetApp()
 665     function implemented by IMPLEMENT_APP().
 666
 667     It creates the declaration <tt>className& wxGetApp()</tt>.
 668
 669     @header{wx/app.h}
 670
 671     Example:
 672
 673     @code
 674     DECLARE_APP(MyApp)
 675     @endcode
 676 */
 677 #define DECLARE_APP( className )
 678
 679 /**
 680     This is used in the application class implementation file to make the
 681     application class known to wxWidgets for dynamic construction.
 682
 683     @header{wx/app.h}
 684
 685     Example:
 686
 687     @code
 688     IMPLEMENT_APP(MyApp)
 689     @endcode
 690
 691     @see DECLARE_APP().
 692 */
 693 #define IMPLEMENT_APP( className )
 694
 695 //@}
 696
 697
 698
 699 /**
 700     The global pointer to the singleton wxApp object.
 701
 702     @see wxApp::GetInstance()
 703 */
 704 wxApp *wxTheApp;
 705
 706
 707
 708 /** @ingroup group_funcmacro_appinitterm */
 709 //@{
 710
 711 /**
 712     This function doesn't exist in wxWidgets but it is created by using the
 713     IMPLEMENT_APP() macro.
 714
 715     Thus, before using it anywhere but in the same module where this macro is
 716     used, you must make it available using DECLARE_APP().
 717
 718     The advantage of using this function compared to directly using the global
 719     ::wxTheApp pointer is that the latter is of type wxApp* and so wouldn't
 720     allow you to access the functions specific to your application class but
 721     not present in wxApp while wxGetApp() returns the object of the right type.
 722
 723     @header{wx/app.h}
 724 */
 725 wxAppDerivedClass& wxGetApp();
 726
 727 /**
 728     If @a doIt is @true, the fatal exceptions (also known as general protection
 729     faults under Windows or segmentation violations in the Unix world) will be
 730     caught and passed to wxApp::OnFatalException.
 731
 732     By default, i.e. before this function is called, they will be handled in
 733     the normal way which usually just means that the application will be
 734     terminated. Calling wxHandleFatalExceptions() with @a doIt equal to @false
 735     will restore this default behaviour.
 736
 737     Notice that this function is only available if @c wxUSE_ON_FATAL_EXCEPTION
 738     is 1 and under Windows platform this requires a compiler with support for
 739     SEH (structured exception handling) which currently means only Microsoft
 740     Visual C++ or a recent Borland C++ version.
 741
 742     @header{wx/app.h}
 743 */
 744 bool wxHandleFatalExceptions(bool doIt = true);
 745
 746 /**
 747     This function is used in wxBase only and only if you don't create
 748     wxApp object at all. In this case you must call it from your
 749     @c main() function before calling any other wxWidgets functions.
 750
 751     If the function returns @false the initialization could not be performed,
 752     in this case the library cannot be used and wxUninitialize() shouldn't be
 753     called neither.
 754
 755     This function may be called several times but wxUninitialize() must be
 756     called for each successful call to this function.
 757
 758     @header{wx/app.h}
 759 */
 760 bool wxInitialize();
 761
 762 /**
 763     This function is for use in console (wxBase) programs only. It must be called
 764     once for each previous successful call to wxInitialize().
 765
 766     @header{wx/app.h}
 767 */
 768 void wxUninitialize();
 769
 770 /**
 771     This function wakes up the (internal and platform dependent) idle system,
 772     i.e. it will force the system to send an idle event even if the system
 773     currently @e is idle and thus would not send any idle event until after
 774     some other event would get sent. This is also useful for sending events
 775     between two threads and is used by the corresponding functions
 776     wxPostEvent() and wxEvtHandler::AddPendingEvent().
 777
 778     @header{wx/app.h}
 779 */
 780 void wxWakeUpIdle();
 781
 782 /**
 783     Calls wxApp::Yield.
 784
 785     @deprecated
 786     This function is kept only for backwards compatibility. Please use
 787     the wxApp::Yield method instead in any new code.
 788
 789     @header{wx/app.h}
 790 */
 791 bool wxYield();
 792
 793 /**
 794     This function is similar to wxYield, except that it disables the user input to
 795     all program windows before calling wxYield and re-enables it again
 796     afterwards. If @a win is not @NULL, this window will remain enabled,
 797     allowing the implementation of some limited user interaction.
 798     Returns the result of the call to ::wxYield.
 799
 800     @header{wx/app.h}
 801 */
 802 bool wxSafeYield(wxWindow* win = NULL, bool onlyIfNeeded = false);
 803
 804 /**
 805     This function initializes wxWidgets in a platform-dependent way. Use this if you
 806     are not using the default wxWidgets entry code (e.g. main or WinMain).
 807
 808     For example, you can initialize wxWidgets from an Microsoft Foundation Classes
 809     (MFC) application using this function.
 810
 811     @note This overload of wxEntry is available under all platforms.
 812
 813     @see wxEntryStart()
 814
 815     @header{wx/app.h}
 816 */
 817 int wxEntry(int& argc, wxChar** argv);
 818
 819 /**
 820     See wxEntry(int&,wxChar**) for more info about this function.
 821
 822     Notice that under Windows CE platform, and only there, the type of @a pCmdLine
 823     is @c wchar_t *, otherwise it is @c char *, even in Unicode build.
 824
 825     @remarks To clean up wxWidgets, call wxApp::OnExit followed by the static
 826              function wxApp::CleanUp. For example, if exiting from an MFC application
 827              that also uses wxWidgets:
 828              @code
 829              int CTheApp::ExitInstance()
 830              {
 831                 // OnExit isn't called by CleanUp so must be called explicitly.
 832                 wxTheApp->OnExit();
 833                 wxApp::CleanUp();
 834
 835                 return CWinApp::ExitInstance();
 836              }
 837              @endcode
 838
 839     @header{wx/app.h}
 840 */
 841 int wxEntry(HINSTANCE hInstance,
 842             HINSTANCE hPrevInstance = NULL,
 843             char* pCmdLine = NULL,
 844             int nCmdShow = SW_SHOWNORMAL);
 845
 846 //@}
 847
 848
 849
 850 /** @ingroup group_funcmacro_procctrl */
 851 //@{
 852
 853 /**
 854     Exits application after calling wxApp::OnExit.
 855
 856     Should only be used in an emergency: normally the top-level frame
 857     should be deleted (after deleting all other frames) to terminate the
 858     application. See wxCloseEvent and wxApp.
 859
 860     @header{wx/app.h}
 861 */
 862 void wxExit();
 863
 864 //@}
 865