]> git.saurik.com Git - wxWidgets.git/commitdiff
Add event descriptions to wxAuiNotebook.
authorSteve Lamerton <steve.lamerton@gmail.com>
Sat, 1 Oct 2011 19:40:20 +0000 (19:40 +0000)
committerSteve Lamerton <steve.lamerton@gmail.com>
Sat, 1 Oct 2011 19:40:20 +0000 (19:40 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69267 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/aui/auibook.h

index b96cf4eb5be0026b9e5cce8b708a0d46584336b1..2ed82e3eddecb21a4ce496254b6dc926fd03e879 100644 (file)
            With this style, tabs are drawn along the bottom of the notebook.
     @endStyleTable
 
-
     @beginEventEmissionTable{wxAuiNotebookEvent}
     @event{EVT_AUINOTEBOOK_PAGE_CLOSE(id, func)}
-        Provide description.
+        A page is about to be closed. Processes a @c wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE event.
     @event{EVT_AUINOTEBOOK_PAGE_CHANGED(id, func)}
-        Provide description.
+        The page selection was changed. Processes a @c wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED event.
     @event{EVT_AUINOTEBOOK_PAGE_CHANGING(id, func)}
-        Provide description.
+        The page selection is about to be changed. Processes a  @c wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING event. This event can be vetoed.
     @event{EVT_AUINOTEBOOK_BUTTON(id, func)}
-        Provide description.
+        The window list button has been pressed. Processes a @c wxEVT_COMMAND_AUINOTEBOOK_BUTTON event.
     @event{EVT_AUINOTEBOOK_BEGIN_DRAG(id, func)}
-        Provide description.
+        Dragging is about to begin. Processes a @c wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG event.
     @event{EVT_AUINOTEBOOK_END_DRAG(id, func)}
-        Provide description.
+        Dragging has ended. Processes a @c wxEVT_COMMAND_AUINOTEBOOK_END_DRAG event.
     @event{EVT_AUINOTEBOOK_DRAG_MOTION(id, func)}
-        Provide description.
+        Emitted during a drag and drop operation. Processes a @c wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION event.
     @event{EVT_AUINOTEBOOK_ALLOW_DND(id, func)}
-        Provide description.
+        Whether to allow a tab to be dropped. Processes a @c wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND event. This event must be specially allowed.
     @endEventTable
 
-    @todo provide description for the events above.
-
     @library{wxaui}
     @category{aui}
 */