Added wxPGProperty::Enable() for conveniency. Refactored related code and improved...

[wxWidgets.git] / interface / wx / app.h

diff --git a/interface/wx/app.h b/interface/wx/app.h
index 893ee20c6c16e3684e12121dae6fd4f7a87b47c2..f0f2e61adea829bf90f8fac6b0c39bfc8d45edc8 100644 (file)
--- a/interface/wx/app.h
+++ b/interface/wx/app.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxApp
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxApp
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -24,11 +24,11 @@
         objects in the application (see wxAppConsole::FilterEvent)
     @li implement Apple-specific event handlers (see wxAppConsole::MacXXX functions)
 
         objects in the application (see wxAppConsole::FilterEvent)
     @li implement Apple-specific event handlers (see wxAppConsole::MacXXX functions)
 

-    You should use the macro IMPLEMENT_APP(appClass) in your application
+    You should use the macro wxIMPLEMENT_APP(appClass) in your application

     implementation file to tell wxWidgets how to create an instance of your
     application class.
 
     implementation file to tell wxWidgets how to create an instance of your
     application class.
 

-    Use DECLARE_APP(appClass) in a header file if you want the ::wxGetApp() function
+    Use wxDECLARE_APP(appClass) in a header file if you want the ::wxGetApp() function

     (which returns a reference to your application object) to be visible to other
     files.
 
     (which returns a reference to your application object) to be visible to other
     files.
 


@@ -57,31 +57,26 @@ public:
 
     /**
         @name Event-handling
 
     /**
         @name Event-handling

+
+        Note that you should look at wxEvtLoopBase for more event-processing
+        documentation.

     */
     //@{
 
     /**
     */
     //@{
 
     /**

-        Dispatches the next event in the windowing system event queue.
-        Blocks until an event appears if there are none currently
-        (use Pending() if this is not wanted).
-
-        This can be used for programming event loops, e.g.
-
-        @code
-        while (app.Pending())
-            Dispatch();
-        @endcode
-
-        @return @false if the event loop should stop and @true otherwise.
+        Called by wxWidgets on creation of the application. Override this if you wish
+        to provide your own (environment-dependent) main loop.

 
 

-        @see Pending(), wxEventLoopBase
+        @return 0 under X, and the wParam of the WM_QUIT message under Windows.

     */
     */

-    virtual bool Dispatch();
+    virtual int MainLoop();

 
     /**
         Call this to explicitly exit the main message (event) loop.
         You should normally exit the main loop (and the application) by deleting
         the top window.
 
     /**
         Call this to explicitly exit the main message (event) loop.
         You should normally exit the main loop (and the application) by deleting
         the top window.

+
+        This function simply calls wxEvtLoopBase::Exit() on the active loop.

     */
     virtual void ExitMainLoop();
 
     */
     virtual void ExitMainLoop();
 


@@ -96,6 +91,14 @@ public:
     */
     virtual int FilterEvent(wxEvent& event);
 
     */
     virtual int FilterEvent(wxEvent& event);
 

+    /**
+        Returns the main event loop instance, i.e. the event loop which is started
+        by OnRun() and which dispatches all events sent from the native toolkit
+        to the application (except when new event loops are temporarily set-up).
+        The returned value maybe @NULL. Put initialization code which needs a
+        non-@NULL main event loop into OnEventLoopEnter().
+    */
+    wxEventLoopBase* GetMainLoop() const;

 
     /**
         This function simply invokes the given method @a func of the specified
 
     /**
         This function simply invokes the given method @a func of the specified


@@ -109,60 +112,111 @@ public:
                              wxEvent& event) const;
 
     /**
                              wxEvent& event) const;
 
     /**

-        Returns @true if called from inside Yield().
+        Returns @true if the application is using an event loop.
+
+        This function always returns @true for the GUI applications which
+        must use an event loop but by default only returns @true for the
+        console programs if an event loop is already running as it can't know
+        whether one will be created in the future.
+
+        Thus, it only makes sense to override it in console applications which
+        do use an event loop, to return @true instead of checking if there is a
+        currently active event loop.
+     */
+    virtual bool UsesEventLoop() const;
+
+    //@}
+
+
+    /**
+        @name Pending events
+
+        Pending events are handled by wxAppConsole rather than wxEventLoopBase
+        to allow queuing of events even when there's no event loop
+        (e.g. in wxAppConsole::OnInit).

     */
     */

-    virtual bool IsYielding() const;
+    //@{

 
     /**
         Process all pending events; it is necessary to call this function to
 
     /**
         Process all pending events; it is necessary to call this function to

-        process posted events.
+        process events posted with wxEvtHandler::QueueEvent or wxEvtHandler::AddPendingEvent.
+
+        This happens during each event loop iteration (see wxEventLoopBase) in GUI mode but
+        it may be also called directly.
+
+        Note that this function does not only process the pending events for the wxApp object
+        itself (which derives from wxEvtHandler) but also the pending events for @e any
+        event handler of this application.

 
 

-        This happens during each event loop iteration in GUI mode but if there is
-        no main loop, it may be also called directly.
+        This function will immediately return and do nothing if SuspendProcessingOfPendingEvents()
+        was called.

     */
     virtual void ProcessPendingEvents();
 
     /**
     */
     virtual void ProcessPendingEvents();
 
     /**

-        Called by wxWidgets on creation of the application. Override this if you wish
-        to provide your own (environment-dependent) main loop.
+        Deletes the pending events of all wxEvtHandlers of this application.

 
 

-        @return 0 under X, and the wParam of the WM_QUIT message under Windows.
+        See wxEvtHandler::DeletePendingEvents() for warnings about deleting the pending
+        events.

     */
     */

-    virtual int MainLoop();
+    void DeletePendingEvents();

 
     /**
 
     /**

-        Returns @true if unprocessed events are in the window system event queue.
+        Returns @true if there are pending events on the internal pending event list.

 
 

-        @see Dispatch()
+        Whenever wxEvtHandler::QueueEvent or wxEvtHandler::AddPendingEvent() are
+        called (not only for wxApp itself, but for any event handler of the application!),
+        the internal wxApp's list of handlers with pending events is updated and this
+        function will return true.

     */
     */

-    virtual bool Pending();
+    bool HasPendingEvents() const;

 
     /**
 
     /**

-        Yields control to pending messages in the windowing system.
+        Temporary suspends processing of the pending events.

 
 

-        This can be useful, for example, when a time-consuming process writes to a
-        text window. Without an occasional yield, the text window will not be updated
-        properly, and on systems with cooperative multitasking, such as Windows 3.1
-        other processes will not respond.
+        @see ResumeProcessingOfPendingEvents()
+    */
+    void SuspendProcessingOfPendingEvents();

 
 

-        Caution should be exercised, however, since yielding may allow the
-        user to perform actions which are not compatible with the current task.
-        Disabling menu items or whole menus during processing can avoid unwanted
-        reentrance of code: see ::wxSafeYield for a better function.
-        You can avoid unwanted reentrancies also using IsYielding().
+    /**
+        Resume processing of the pending events previously stopped because of a
+        call to SuspendProcessingOfPendingEvents().
+    */
+    void ResumeProcessingOfPendingEvents();

 
 

-        Note that Yield() will not flush the message logs. This is intentional as
-        calling Yield() is usually done to quickly update the screen and popping up
-        a message box dialog may be undesirable. If you do wish to flush the log
-        messages immediately (otherwise it will be done during the next idle loop
-        iteration), call wxLog::FlushActive.
+    //@}

 
 

-        Calling Yield() recursively is normally an error and an assert failure is
-        raised in debug build if such situation is detected. However if the
-        @a onlyIfNeeded parameter is @true, the method will just silently
-        return @false instead.
-    */
-    virtual bool Yield(bool onlyIfNeeded = false);
+    /**
+        Delayed objects destruction.
+
+        In applications using events it may be unsafe for an event handler to
+        delete the object which generated the event because more events may be
+        still pending for the same object. In this case the handler may call
+        ScheduleForDestruction() instead.
+     */
+    //@{
+
+    /**
+        Schedule the object for destruction in the near future.
+
+        Notice that if the application is not using an event loop, i.e. if
+        UsesEventLoop() returns @false, this method will simply delete the
+        object immediately.
+
+        Examples of using this function inside wxWidgets itself include
+        deleting the top level windows when they are closed and sockets when
+        they are disconnected.
+     */
+    void ScheduleForDestruction(wxObject *object);
+
+    /**
+        Check if the object had been scheduled for destruction with
+        ScheduleForDestruction().
+
+        This function may be useful as an optimization to avoid doing something
+        with an object which will be soon destroyed in any case.
+     */
+    bool IsScheduledForDestruction(wxObject *object) const;

 
     //@}
 
 
     //@}
 


@@ -180,7 +234,7 @@ public:
 
     /**
         Returns the one and only global application object.
 
     /**
         Returns the one and only global application object.

-        Usually wxTheApp is used instead.
+        Usually ::wxTheApp is used instead.

 
         @see SetInstance()
     */
 
         @see SetInstance()
     */


@@ -206,7 +260,7 @@ public:
         Called in response of an "open-application" Apple event.
         Override this to create a new document in your app.
 
         Called in response of an "open-application" Apple event.
         Override this to create a new document in your app.
 

-        @onlyfor{wxmac}
+        @onlyfor{wxosx}

     */
     virtual void MacNewFile();
 
     */
     virtual void MacNewFile();
 


@@ -217,28 +271,28 @@ public:
         user double clicked on it or if the document file was dropped on either the
         running application or the application icon in Finder.
 
         user double clicked on it or if the document file was dropped on either the
         running application or the application icon in Finder.
 

-        @onlyfor{wxmac}
+        @onlyfor{wxosx}

     */
     virtual void MacOpenFile(const wxString& fileName);
 
     /**
         Called in response of a "get-url" Apple event.
 
     */
     virtual void MacOpenFile(const wxString& fileName);
 
     /**
         Called in response of a "get-url" Apple event.
 

-        @onlyfor{wxmac}
+        @onlyfor{wxosx}

     */
     virtual void MacOpenURL(const wxString& url);
 
     /**
         Called in response of a "print-document" Apple event.
 
     */
     virtual void MacOpenURL(const wxString& url);
 
     /**
         Called in response of a "print-document" Apple event.
 

-        @onlyfor{wxmac}
+        @onlyfor{wxosx}

     */
     virtual void MacPrintFile(const wxString& fileName);
 
     /**
         Called in response of a "reopen-application" Apple event.
 
     */
     virtual void MacPrintFile(const wxString& fileName);
 
     /**
         Called in response of a "reopen-application" Apple event.
 

-        @onlyfor{wxmac}
+        @onlyfor{wxosx}

     */
     virtual void MacReopenApp();
 
     */
     virtual void MacReopenApp();
 


@@ -315,6 +369,26 @@ public:
     */
     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
 
     */
     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
 

+    /**
+        Called by wxEventLoopBase::SetActive(): you can override this function
+        and put here the code which needs an active event loop.
+
+        Note that this function is called whenever an event loop is activated;
+        you may want to use wxEventLoopBase::IsMain() to perform initialization
+        specific for the app's main event loop.
+
+        @see OnEventLoopExit()
+    */
+    virtual void OnEventLoopEnter(wxEventLoopBase* loop);
+
+    /**
+        Called by wxEventLoopBase::OnExit() for each event loop which
+        is exited.
+
+        @see OnEventLoopEnter()
+    */
+    virtual void OnEventLoopExit(wxEventLoopBase* loop);
+

     /**
         This function is called if an unhandled exception occurs inside the main
         application event loop. It can return @true to ignore the exception and to
     /**
         This function is called if an unhandled exception occurs inside the main
         application event loop. It can return @true to ignore the exception and to


@@ -421,8 +495,13 @@ public:
         is that this one is meant to be shown to the user and so should be used
         for the window titles, page headers and so on while the other one
         should be only used internally, e.g. for the file names or
         is that this one is meant to be shown to the user and so should be used
         for the window titles, page headers and so on while the other one
         should be only used internally, e.g. for the file names or

-        configuration file keys. By default, returns the application name as
-        returned by GetAppName() capitalized using wxString::Capitalize().
+        configuration file keys.
+
+        If the application name for display had been previously set by
+        SetAppDisplayName(), it will be returned by this function. Otherwise,
+        if SetAppName() had been called its value will be returned; also as is.
+        Finally if none was called, this function returns the program name
+        capitalized using wxString::Capitalize().

 
         @since 2.9.0
     */
 
         @since 2.9.0
     */


@@ -431,8 +510,9 @@ public:
     /**
         Returns the application name.
 
     /**
         Returns the application name.
 

-        @remarks wxWidgets sets this to a reasonable default before calling
-                 OnInit(), but the application can reset it at will.
+        If SetAppName() had been called, returns the string passed to it.
+        Otherwise returns the program name, i.e. the value of @c argv[0] passed
+        to the @c main() function.

 
         @see GetAppDisplayName()
     */
 
         @see GetAppDisplayName()
     */


@@ -554,6 +634,25 @@ public:
     In general, application-wide settings for GUI-only apps are accessible
     from wxApp (or from wxSystemSettings or wxSystemOptions classes).
 
     In general, application-wide settings for GUI-only apps are accessible
     from wxApp (or from wxSystemSettings or wxSystemOptions classes).
 

+    @beginEventEmissionTable
+    @event{EVT_QUERY_END_SESSION(func)}
+        Process a query end session event, supplying the member function.
+        See wxCloseEvent.
+    @event{EVT_END_SESSION(func)}
+        Process an end session event, supplying the member function.
+        See wxCloseEvent.
+    @event{EVT_ACTIVATE_APP(func)}
+        Process a @c wxEVT_ACTIVATE_APP event. See wxActivateEvent.
+    @event{EVT_HIBERNATE(func)}
+        Process a hibernate event. See wxActivateEvent.
+    @event{EVT_DIALUP_CONNECTED(func)}
+        A connection with the network was established. See wxDialUpEvent.
+    @event{EVT_DIALUP_DISCONNECTED(func)}
+        The connection with the network was lost. See wxDialUpEvent.
+    @event{EVT_IDLE(func)}
+        Process a @c wxEVT_IDLE event. See wxIdleEvent.
+    @endEventTable
+

     @library{wxbase}
     @category{appmanagement}
 
     @library{wxbase}
     @category{appmanagement}
 


@@ -575,7 +674,7 @@ public:
 
     /**
         Get display mode that is used use. This is only used in framebuffer
 
     /**
         Get display mode that is used use. This is only used in framebuffer

-        wxWin ports (such as wxMGL or wxDFB).
+        wxWidgets ports (such as wxMGL or wxDFB).

     */
     virtual wxVideoMode GetDisplayMode() const;
 
     */
     virtual wxVideoMode GetDisplayMode() const;
 


@@ -621,6 +720,25 @@ public:
     */
     virtual bool IsActive() const;
 
     */
     virtual bool IsActive() const;
 

+    /**
+        This function is similar to wxYield(), except that it disables the user
+        input to all program windows before calling wxAppConsole::Yield and re-enables it
+        again afterwards. If @a win is not @NULL, this window will remain enabled,
+        allowing the implementation of some limited user interaction.
+        Returns the result of the call to wxAppConsole::Yield.
+
+        @see wxSafeYield
+    */
+    virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded);
+
+    /**
+        Works like SafeYield() with @e onlyIfNeeded == @true except that
+        it allows the caller to specify a mask of events to be processed.
+
+        See wxAppConsole::YieldFor for more info.
+    */
+    virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);
+

     /**
         Windows-only function for processing a message. This function is called
         from the main message loop, checking for windows that may wish to process it.
     /**
         Windows-only function for processing a message. This function is called
         from the main message loop, checking for windows that may wish to process it.


@@ -660,9 +778,8 @@ public:
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 
     /**
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 
     /**

-        Set display mode to use. This is only used in framebuffer wxWin
-        ports (such as wxMGL or wxDFB). This method should be called from
-        wxApp::OnInitGui.
+        Set display mode to use. This is only used in framebuffer wxWidgets
+        ports (such as wxMGL or wxDFB).

     */
     virtual bool SetDisplayMode(const wxVideoMode& info);
 
     */
     virtual bool SetDisplayMode(const wxVideoMode& info);
 


@@ -739,35 +856,37 @@ public:
 
 /**
     This is used in headers to create a forward declaration of the ::wxGetApp()
 
 /**
     This is used in headers to create a forward declaration of the ::wxGetApp()

-    function implemented by IMPLEMENT_APP().
+    function implemented by wxIMPLEMENT_APP().

 
 

-    It creates the declaration <tt>className& wxGetApp()</tt>.
+    It creates the declaration <tt>className& wxGetApp()</tt>
+    (requires a final semicolon).

 
     @header{wx/app.h}
 
     Example:
 
     @code
 
     @header{wx/app.h}
 
     Example:
 
     @code

-    DECLARE_APP(MyApp)
+    wxDECLARE_APP(MyApp);

     @endcode
 */
     @endcode
 */

-#define DECLARE_APP( className )
+#define wxDECLARE_APP( className )

 
 /**
     This is used in the application class implementation file to make the
     application class known to wxWidgets for dynamic construction.
 
 /**
     This is used in the application class implementation file to make the
     application class known to wxWidgets for dynamic construction.

+    Note that this macro requires a final semicolon.

 
     @header{wx/app.h}
 
     Example:
 
     @code
 
     @header{wx/app.h}
 
     Example:
 
     @code

-    IMPLEMENT_APP(MyApp)
+    wxIMPLEMENT_APP(MyApp);

     @endcode
 
     @endcode
 

-    @see DECLARE_APP().
+    @see wxDECLARE_APP()

 */
 */

-#define IMPLEMENT_APP( className )
+#define wxIMPLEMENT_APP( className )

 
 //@}
 
 
 //@}
 


@@ -787,10 +906,10 @@ wxApp *wxTheApp;
 
 /**
     This function doesn't exist in wxWidgets but it is created by using the
 
 /**
     This function doesn't exist in wxWidgets but it is created by using the

-    IMPLEMENT_APP() macro.
+    wxIMPLEMENT_APP() macro.

 
     Thus, before using it anywhere but in the same module where this macro is
 
     Thus, before using it anywhere but in the same module where this macro is

-    used, you must make it available using DECLARE_APP().
+    used, you must make it available using wxDECLARE_APP().

 
     The advantage of using this function compared to directly using the global
     ::wxTheApp pointer is that the latter is of type wxApp* and so wouldn't
 
     The advantage of using this function compared to directly using the global
     ::wxTheApp pointer is that the latter is of type wxApp* and so wouldn't


@@ -857,22 +976,18 @@ void wxUninitialize();
 void wxWakeUpIdle();
 
 /**
 void wxWakeUpIdle();
 
 /**

-    Calls wxApp::Yield.
+    Calls wxAppConsole::Yield.

 
     @deprecated
     This function is kept only for backwards compatibility. Please use
 
     @deprecated
     This function is kept only for backwards compatibility. Please use

-    the wxApp::Yield method instead in any new code.
+    the wxAppConsole::Yield method instead in any new code.

 
     @header{wx/app.h}
 */
 bool wxYield();
 
 /**
 
     @header{wx/app.h}
 */
 bool wxYield();
 
 /**

-    This function is similar to wxYield(), except that it disables the user
-    input to all program windows before calling wxYield() and re-enables it
-    again afterwards. If @a win is not @NULL, this window will remain enabled,
-    allowing the implementation of some limited user interaction.
-    Returns the result of the call to ::wxYield.
+    Calls wxApp::SafeYield.

 
     @header{wx/app.h}
 */
 
     @header{wx/app.h}
 */


@@ -940,3 +1055,37 @@ void wxExit();
 
 //@}
 
 
 //@}
 

+/** @addtogroup group_funcmacro_debug */
+//@{
+
+/**
+    @def wxDISABLE_DEBUG_SUPPORT()
+
+    Use this macro to disable all debugging code in release build when not
+    using wxIMPLEMENT_APP().
+
+    Currently this macro disables assert checking and debug and trace level
+    logging messages in release build (i.e. when @c NDEBUG is defined). It is
+    used by wxIMPLEMENT_APP() macro so you only need to use it explicitly if you
+    don't use this macro but initialize wxWidgets directly (e.g. calls
+    wxEntry() or wxEntryStart() itself).
+
+    If you do not want to disable debugging code even in release build of your
+    application, you can use wxSetDefaultAssertHandler() and
+    wxLog::SetLogLevel() with @c wxLOG_Max parameter to enable assertions and
+    debug logging respectively.
+
+    @see wxDISABLE_ASSERTS_IN_RELEASE_BUILD(),
+         wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD(),
+         @ref overview_debugging
+
+    @since 2.9.1
+
+    @header{wx/app.h}
+ */
+#define wxDISABLE_DEBUG_SUPPORT() \
+    wxDISABLE_ASSERTS_IN_RELEASE_BUILD(); \
+    wxDISABLE_DEBUG_LOGGING_IN_RELEASE_BUILD()
+
+//@}
+