document various enumerations defined in defs.h; give a name to the anonymous enum...

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

diff --git a/include/wx/window.h b/include/wx/window.h
index 04b443a1a46bb4c71f39b116bc51d1aea6172c18..3454055f9a5796ff730b4a0bb3262d1b3fb4856a 100644 (file)
--- a/include/wx/window.h
+++ b/include/wx/window.h
@@ -792,7 +792,7 @@ public:
 
         // replace the event handler (allows to completely subclass the
         // window)
 
         // replace the event handler (allows to completely subclass the
         // window)

-    void SetEventHandler( wxEvtHandler *handler ) { m_eventHandler = handler; }
+    void SetEventHandler( wxEvtHandler *handler );

 
         // push/pop event handler: allows to chain a custom event handler to
         // alreasy existing ones
 
         // push/pop event handler: allows to chain a custom event handler to
         // alreasy existing ones


@@ -806,13 +806,37 @@ public:
         // be there)
     bool RemoveEventHandler(wxEvtHandler *handler);
 
         // be there)
     bool RemoveEventHandler(wxEvtHandler *handler);
 

-    // Process an event by calling GetEventHandler()->ProcessEvent() and
-    // handling any exceptions thrown by event handlers. It's mostly useful
-    // when processing wx events when called from C code (e.g. in GTK+
-    // callback) when the exception wouldn't correctly propagate to
-    // wxEventLoop.
+        // Process an event by calling GetEventHandler()->ProcessEvent() and
+        // handling any exceptions thrown by event handlers. It's mostly useful
+        // when processing wx events when called from C code (e.g. in GTK+
+        // callback) when the exception wouldn't correctly propagate to
+        // wxEventLoop.

     bool HandleWindowEvent(wxEvent& event) const;
 
     bool HandleWindowEvent(wxEvent& event) const;
 

+        // disable wxEvtHandler double-linked list mechanism:
+    virtual void SetNextHandler(wxEvtHandler *handler);
+    virtual void SetPreviousHandler(wxEvtHandler *handler);
+
+protected:
+
+    // NOTE: we change the access specifier of the following wxEvtHandler functions
+    //       so that the user won't be able to call them directly.
+    //       Calling wxWindow::ProcessEvent in fact only works when there are NO
+    //       event handlers pushed on the window.
+    //       To ensure correct operation, instead of wxWindow::ProcessEvent
+    //       you must always call wxWindow::GetEventHandler()->ProcessEvent()
+    //       or HandleWindowEvent().
+    //       The same holds for all other wxEvtHandler functions.
+
+    using wxEvtHandler::ProcessEvent;
+    using wxEvtHandler::ProcessThreadEvent;
+    using wxEvtHandler::SafelyProcessEvent;
+    using wxEvtHandler::ProcessPendingEvents;
+    using wxEvtHandler::AddPendingEvent;
+    using wxEvtHandler::QueueEvent;
+
+public:
+

     // validators
     // ----------
 
     // validators
     // ----------
 


@@ -1402,7 +1426,8 @@ protected:
     void SatisfyConstraints();
 #endif // wxUSE_CONSTRAINTS
 
     void SatisfyConstraints();
 #endif // wxUSE_CONSTRAINTS
 

-    // Send the wxWindowDestroyEvent
+    // Send the wxWindowDestroyEvent if not done yet and sets m_isBeingDeleted
+    // to true

     void SendDestroyEvent();
 
     // returns the main window of composite control; this is the window
     void SendDestroyEvent();
 
     // returns the main window of composite control; this is the window