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