No changes, just removed hard tabs and trailing white space.

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

diff --git a/include/wx/app.h b/include/wx/app.h
index d61b3b56137866ad9b19dd30df00d844b4f250c3..87642e3ecba82c75d53698d506df2c9a7e75dc13 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -32,6 +32,7 @@ class WXDLLIMPEXP_FWD_BASE wxMessageOutput;
 
 #if wxUSE_GUI
     struct WXDLLIMPEXP_FWD_CORE wxVideoMode;
 
 #if wxUSE_GUI
     struct WXDLLIMPEXP_FWD_CORE wxVideoMode;

+    class WXDLLIMPEXP_FWD_CORE wxWindow;

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -51,6 +52,15 @@ enum
     wxPRINT_POSTSCRIPT = 2
 };
 
     wxPRINT_POSTSCRIPT = 2
 };
 

+// ----------------------------------------------------------------------------
+// global variables
+// ----------------------------------------------------------------------------
+
+// use of this list is strongly deprecated, use wxApp ScheduleForDestruction()
+// and IsScheduledForDestruction()  methods instead of this list directly, it
+// is here for compatibility purposes only
+extern WXDLLIMPEXP_DATA_BASE(wxList) wxPendingDelete;
+

 // ----------------------------------------------------------------------------
 // wxAppConsoleBase: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxAppConsoleBase: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------


@@ -82,17 +92,25 @@ public:
     // class OnInit() to do it.
     virtual bool OnInit();
 
     // class OnInit() to do it.
     virtual bool OnInit();
 

-    // this is here only temporary hopefully (FIXME)
-    virtual bool OnInitGui() { return true; }
-

     // This is the replacement for the normal main(): all program work should
     // be done here. When OnRun() returns, the programs starts shutting down.
     virtual int OnRun();
 
     // This is the replacement for the normal main(): all program work should
     // be done here. When OnRun() returns, the programs starts shutting down.
     virtual int OnRun();
 

+    // This is called by wxEventLoopBase::SetActive(): you should put the code
+    // which needs an active event loop here.
+    // 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.
+    virtual void OnEventLoopEnter(wxEventLoopBase* WXUNUSED(loop)) {}
+

     // This is only called if OnInit() returned true so it's a good place to do
     // any cleanup matching the initializations done there.
     virtual int OnExit();
 
     // This is only called if OnInit() returned true so it's a good place to do
     // any cleanup matching the initializations done there.
     virtual int OnExit();
 

+    // This is called by wxEventLoopBase::OnExit() for each event loop which
+    // is exited.
+    virtual void OnEventLoopExit(wxEventLoopBase* WXUNUSED(loop)) {}
+

     // This is the very last function called on wxApp object before it is
     // destroyed. If you override it (instead of overriding OnExit() as usual)
     // do not forget to call the base class version!
     // This is the very last function called on wxApp object before it is
     // destroyed. If you override it (instead of overriding OnExit() as usual)
     // do not forget to call the base class version!


@@ -208,6 +226,15 @@ public:
     // for it
     static wxAppTraits *GetTraitsIfExists();
 
     // for it
     static wxAppTraits *GetTraitsIfExists();
 

+    // 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
+        { return m_mainLoop; }
+
+

     // event processing functions
     // --------------------------
 
     // event processing functions
     // --------------------------
 


@@ -220,7 +247,21 @@ public:
     // had been already processed or won't be processed at all, respectively
     virtual int FilterEvent(wxEvent& event);
 
     // had been already processed or won't be processed at all, respectively
     virtual int FilterEvent(wxEvent& event);
 

+    // return true if we're running event loop, i.e. if the events can
+    // (already) be dispatched
+    static bool IsMainLoopRunning();
+

 #if wxUSE_EXCEPTIONS
 #if wxUSE_EXCEPTIONS

+    // execute the functor to handle the given event
+    //
+    // this is a generalization of HandleEvent() below and the base class
+    // implementation of CallEventHandler() still calls HandleEvent() for
+    // compatibility for functors which are just wxEventFunctions (i.e. methods
+    // of wxEvtHandler)
+    virtual void CallEventHandler(wxEvtHandler *handler,
+                                  wxEventFunctor& functor,
+                                  wxEvent& event) const;
+

     // call the specified handler on the given object with the given event
     //
     // this method only exists to allow catching the exceptions thrown by any
     // call the specified handler on the given object with the given event
     //
     // this method only exists to allow catching the exceptions thrown by any


@@ -235,16 +276,26 @@ public:
     // exit, if you need to really handle the exceptions you need to override
     // OnExceptionInMainLoop()
     virtual void OnUnhandledException();
     // exit, if you need to really handle the exceptions you need to override
     // OnExceptionInMainLoop()
     virtual void OnUnhandledException();

+
+    // Function called if an uncaught exception is caught inside the main
+    // event loop: it may return true to continue running the event loop or
+    // false to stop it (in the latter case it may rethrow the exception as
+    // well)
+    virtual bool OnExceptionInMainLoop();
+

 #endif // wxUSE_EXCEPTIONS
 
 #endif // wxUSE_EXCEPTIONS
 

-    // event processing functions
-    // --------------------------

 
 

-    // return true if we're running event loop, i.e. if the events can
-    // (already) be dispatched
-    static bool IsMainLoopRunning();
+    // pending events
+    // --------------

 
 

-    // process all events in the wxHandlersWithPendingEvents list -- it is necessary
+    // IMPORTANT: all these methods conceptually belong to wxEventLoopBase
+    //            but for many reasons we need to allow queuing of events
+    //            even when there's no event loop (e.g. in wxApp::OnInit);
+    //            this feature is used e.g. to queue events on secondary threads
+    //            or in wxPython to use wx.CallAfter before the GUI is initialized
+
+    // process all events in the m_handlersWithPendingEvents list -- it is necessary

     // to call this function to process posted events. This happens during each
     // event loop iteration in GUI mode but if there is no main loop, it may be
     // also called directly.
     // to call this function to process posted events. This happens during each
     // event loop iteration in GUI mode but if there is no main loop, it may be
     // also called directly.


@@ -253,47 +304,80 @@ public:
     // check if there are pending events on global pending event list
     bool HasPendingEvents() const;
 
     // check if there are pending events on global pending event list
     bool HasPendingEvents() const;
 

-    // doesn't do anything in this class, just a hook for GUI wxApp
-    virtual bool Yield(bool WXUNUSED(onlyIfNeeded) = false) { return true; }
+    // temporary suspends processing of the pending events
+    void SuspendProcessingOfPendingEvents();

 
 

-    // make sure that idle events are sent again
-    virtual void WakeUpIdle();
+    // resume processing of the pending events previously stopped because of a
+    // call to SuspendProcessingOfPendingEvents()
+    void ResumeProcessingOfPendingEvents();

 
 

-        // execute the main GUI loop, the function returns when the loop ends
-    virtual int MainLoop();
+    // called by ~wxEvtHandler to (eventually) remove the handler from the list of
+    // the handlers with pending events
+    void RemovePendingEventHandler(wxEvtHandler* toRemove);

 
 

-        // exit the main GUI loop during the next iteration (i.e. it does not
-        // stop the program immediately!)
-    virtual void ExitMainLoop();
+    // adds an event handler to the list of the handlers with pending events
+    void AppendPendingEventHandler(wxEvtHandler* toAppend);

 
 

-        // returns true if there are unprocessed events in the event queue
-    virtual bool Pending();
+    // moves the event handler from the list of the handlers with pending events
+    //to the list of the handlers with _delayed_ pending events
+    void DelayPendingEventHandler(wxEvtHandler* toDelay);

 
 

-        // process the first event in the event queue (blocks until an event
-        // appears if there are none currently, use Pending() if this is not
-        // wanted), returns false if the event loop should stop and true
-        // otherwise
+    // deletes the current pending events
+    void DeletePendingEvents();
+
+
+    // delayed destruction
+    // -------------------
+
+    // If an object may have pending events for it, it shouldn't be deleted
+    // immediately as this would result in a crash when trying to handle these
+    // events: instead, it should be scheduled for destruction and really
+    // destroyed only after processing all pending events.
+    //
+    // Notice that this is only possible if we have a running event loop,
+    // otherwise the object is just deleted directly by ScheduleForDestruction()
+    // and IsScheduledForDestruction() always returns false.
+
+    // schedule the object for destruction in the near future
+    void ScheduleForDestruction(wxObject *object);
+
+    // return true if the object is scheduled for destruction
+    bool IsScheduledForDestruction(wxObject *object) const;
+
+
+    // wxEventLoop-related methods
+    // ---------------------------
+
+    // all these functions are forwarded to the corresponding methods of the
+    // currently active event loop -- and do nothing if there is none
+    virtual bool Pending();

     virtual bool Dispatch();
 
     virtual bool Dispatch();
 

-        // this virtual function is called  when the application
-        // becomes idle and normally just sends wxIdleEvent to all interested
-        // parties
-        //
-        // it should return true if more idle events are needed, false if not
+    virtual int MainLoop();
+    virtual void ExitMainLoop();
+
+    bool Yield(bool onlyIfNeeded = false);
+
+    virtual void WakeUpIdle();
+
+    // this method is called by the active event loop when there are no events
+    // to process
+    //
+    // by default it generates the idle events and if you override it in your
+    // derived class you should call the base class version to ensure that idle
+    // events are still sent out

     virtual bool ProcessIdle();
 
     virtual bool ProcessIdle();
 

-#if wxUSE_EXCEPTIONS
-    // Function called if an uncaught exception is caught inside the main
-    // event loop: it may return true to continue running the event loop or
-    // false to stop it (in the latter case it may rethrow the exception as
-    // well)
-    virtual bool OnExceptionInMainLoop();
-#endif // wxUSE_EXCEPTIONS
+    // this virtual function is overridden in GUI wxApp to always return true
+    // as GUI applications always have an event loop -- but console ones may
+    // have it or not, so it simply returns true if already have an event loop
+    // running but false otherwise
+    virtual bool UsesEventLoop() const;
+

 
     // debugging support
     // -----------------
 
 
     // debugging support
     // -----------------
 

-#ifdef __WXDEBUG__

     // this function is called when an assert failure occurs, the base class
     // version does the normal processing (i.e. shows the usual assert failure
     // dialog box)
     // this function is called when an assert failure occurs, the base class
     // version does the normal processing (i.e. shows the usual assert failure
     // dialog box)


@@ -313,7 +397,6 @@ public:
                           int line,
                           const wxChar *cond,
                           const wxChar *msg);
                           int line,
                           const wxChar *cond,
                           const wxChar *msg);

-#endif // __WXDEBUG__

 
     // check that the wxBuildOptions object (constructed in the application
     // itself, usually the one from IMPLEMENT_APP() macro) matches the build
 
     // check that the wxBuildOptions object (constructed in the application
     // itself, usually the one from IMPLEMENT_APP() macro) matches the build


@@ -352,11 +435,15 @@ public:
 #endif
 
 protected:
 #endif
 
 protected:

+    // delete all objects in wxPendingDelete list
+    //
+    // called from ProcessPendingEvents()
+    void DeletePendingObjects();
+

     // the function which creates the traits object when GetTraits() needs it
     // for the first time
     virtual wxAppTraits *CreateTraits();
 
     // the function which creates the traits object when GetTraits() needs it
     // for the first time
     virtual wxAppTraits *CreateTraits();
 

-

     // function used for dynamic wxApp creation
     static wxAppInitializerFunction ms_appInitFn;
 
     // function used for dynamic wxApp creation
     static wxAppInitializerFunction ms_appInitFn;
 


@@ -382,9 +469,32 @@ protected:
     // been started yet or has already terminated)
     wxEventLoopBase *m_mainLoop;
 
     // been started yet or has already terminated)
     wxEventLoopBase *m_mainLoop;
 

+
+    // pending events management vars:
+
+    // the array of the handlers with pending events which needs to be processed
+    // inside ProcessPendingEvents()
+    wxEvtHandlerArray m_handlersWithPendingEvents;
+
+    // helper array used by ProcessPendingEvents() to store the event handlers
+    // which have pending events but of these events none can be processed right now
+    // (because of a call to wxEventLoop::YieldFor() which asked to selectively process
+    // pending events)
+    wxEvtHandlerArray m_handlersWithPendingDelayedEvents;
+
+#if wxUSE_THREADS
+    // this critical section protects both the lists above
+    wxCriticalSection m_handlersWithPendingEventsLocker;
+#endif
+
+    // flag modified by Suspend/ResumeProcessingOfPendingEvents()
+    bool m_bDoPendingEventProcessing;
+
+    friend class WXDLLIMPEXP_FWD_BASE wxEvtHandler;
+

     // the application object is a singleton anyhow, there is no sense in
     // copying it
     // the application object is a singleton anyhow, there is no sense in
     // copying it

-    DECLARE_NO_COPY_CLASS(wxAppConsoleBase)
+    wxDECLARE_NO_COPY_CLASS(wxAppConsoleBase);

 };
 
 #if defined(__UNIX__)
 };
 
 #if defined(__UNIX__)


@@ -441,18 +551,9 @@ public:
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 

-
-
-        // process all currently pending events right now
-        //
-        // it is an error to call Yield() recursively unless the value of
-        // onlyIfNeeded is true
-        //
-        // WARNING: this function is dangerous as it can lead to unexpected
-        //          reentrancies (i.e. when called from an event handler it
-        //          may result in calling the same event handler again), use
-        //          with _extreme_ care or, better, don't use at all!
-    virtual bool Yield(bool onlyIfNeeded = false) = 0;
+        // safer alternatives to Yield(), using wxWindowDisabler
+    virtual bool SafeYield(wxWindow *win, bool onlyIfNeeded);
+    virtual bool SafeYieldFor(wxWindow *win, long eventsToProcess);

 
         // this virtual function is called in the GUI mode when the application
         // becomes idle and normally just sends wxIdleEvent to all interested
 
         // this virtual function is called in the GUI mode when the application
         // becomes idle and normally just sends wxIdleEvent to all interested


@@ -465,6 +566,9 @@ public:
         // Returns true if more idle time is requested.
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 
         // Returns true if more idle time is requested.
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 

+        // override base class version: GUI apps always use an event loop
+    virtual bool UsesEventLoop() const { return true; }
+

 
     // top level window functions
     // --------------------------
 
     // top level window functions
     // --------------------------


@@ -546,9 +650,6 @@ public:
 #endif // WXWIN_COMPATIBILITY_2_6
 
 protected:
 #endif // WXWIN_COMPATIBILITY_2_6
 
 protected:

-    // delete all objects in wxPendingDelete list
-    void DeletePendingObjects();
-

     // override base class method to use GUI traits
     virtual wxAppTraits *CreateTraits();
 
     // override base class method to use GUI traits
     virtual wxAppTraits *CreateTraits();
 


@@ -576,8 +677,7 @@ protected:
     // does any of our windows have focus?
     bool m_isActive;
 
     // does any of our windows have focus?
     bool m_isActive;
 

-
-    DECLARE_NO_COPY_CLASS(wxAppBase)
+    wxDECLARE_NO_COPY_CLASS(wxAppBase);

 };
 
 #if WXWIN_COMPATIBILITY_2_6
 };
 
 #if WXWIN_COMPATIBILITY_2_6


@@ -643,20 +743,20 @@ protected:
 // ------------------------------------------------------
 
 // Force an exit from main loop
 // ------------------------------------------------------
 
 // Force an exit from main loop

-extern void WXDLLIMPEXP_BASE wxExit();
+WXDLLIMPEXP_BASE void wxExit();

 
 

-// avoid redeclaring this function here if it had been already declated by
+// avoid redeclaring this function here if it had been already declared by

 // wx/utils.h, this results in warnings from g++ with -Wredundant-decls
 #ifndef wx_YIELD_DECLARED
 #define wx_YIELD_DECLARED
 
 // Yield to other apps/messages
 // wx/utils.h, this results in warnings from g++ with -Wredundant-decls
 #ifndef wx_YIELD_DECLARED
 #define wx_YIELD_DECLARED
 
 // Yield to other apps/messages

-extern bool WXDLLIMPEXP_BASE wxYield();
+WXDLLIMPEXP_CORE bool wxYield();

 
 #endif // wx_YIELD_DECLARED
 
 // Yield to other apps/messages
 
 #endif // wx_YIELD_DECLARED
 
 // Yield to other apps/messages

-extern void WXDLLIMPEXP_BASE wxWakeUpIdle();
+WXDLLIMPEXP_BASE void wxWakeUpIdle();

 
 // ----------------------------------------------------------------------------
 // macros for dynamic creation of the application object
 
 // ----------------------------------------------------------------------------
 // macros for dynamic creation of the application object