document wxProgressDialog::Update(maximumValue) behaviour and warn the user that...

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

diff --git a/interface/wx/app.h b/interface/wx/app.h
index f664be76f9a942d1c0ebeb6757f420c86bdf09b1..9d358c7473d131a69679b6dc12a19b17bf780ae8 100644 (file)
--- a/interface/wx/app.h
+++ b/interface/wx/app.h
@@ -114,6 +114,45 @@ public:
     //@}
 
 
+    /**
+        @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).
+    */
+    //@{
+
+    /**
+        Process all pending events; it is necessary to call this function to
+        process posted events.
+
+        This happens during each event loop iteration in GUI mode but
+        it may be also called directly.
+    */
+    virtual void ProcessPendingEvents();
+
+    /**
+        Returns @true if there are pending events on the internal pending event list.
+    */
+    bool HasPendingEvents() const;
+
+    /**
+        Temporary suspends processing of the pending events.
+
+        @see ResumeProcessingOfPendingEvents()
+    */
+    void SuspendProcessingOfPendingEvents();
+
+    /**
+        Resume processing of the pending events previously stopped because of a
+        call to SuspendProcessingOfPendingEvents().
+    */
+    void ResumeProcessingOfPendingEvents();
+
+    //@}
+
+
     /**
         Allows external code to modify global ::wxTheApp, but you should really
         know what you're doing if you call it.
@@ -269,12 +308,16 @@ public:
         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);