]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/bookctrl.h
Added NSApplicationDelegate's openFiles for wxOSX-Cocoa.
[wxWidgets.git] / interface / wx / bookctrl.h
index 05fe81a3b770a138184d6b77429dbc4fd1cc304f..450cd6d4eb2467769a7e8be8e955fa8d08b39470 100644 (file)
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxBookCtrlBase
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -23,7 +23,7 @@
     This is a pure virtual class so you cannot allocate it directly.
 
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
 
     @see @ref overview_bookctrl
 */
@@ -147,11 +147,10 @@ public:
 
     /**
         Sets the selection for the given page, returning the previous selection.
-        The call to this function generates the page changing events.
 
-        @deprecated
-        This function is deprecated and should not be used in new code.
-        Please use the ChangeSelection() function instead.
+        Notice that the call to this function generates the page changing
+        events, use the ChangeSelection() function if you don't want these
+        events to be generated.
 
         @see GetSelection()
     */
@@ -166,9 +165,10 @@ public:
     /**
         Changes the selection for the given page, returning the previous selection.
 
-        The call to this function does NOT generate the page changing events.
-        This is the only difference with SetSelection().
-        See @ref overview_eventhandling_prog for more infomation.
+        This function behaves as SetSelection() but does @em not generate the
+        page changing events.
+
+        See @ref overview_events_prog for more information.
     */
     virtual int ChangeSelection(size_t page) = 0;
 
@@ -221,6 +221,10 @@ public:
 
     /**
         Adds a new page.
+
+        The page must have the book control itself as the parent and must not
+        have been added to this control previously.
+
         The call to this function may generate the page changing events.
 
         @param page
@@ -363,7 +367,7 @@ public:
     probably unnecessary to process both events at once.
 
     @library{wxcore}
-    @category{events}
+    @category{events,bookctrl}
 
     @see wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook
 */