Add wxTextEntry::AutoCompleteDirectories().

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

diff --git a/interface/wx/bookctrl.h b/interface/wx/bookctrl.h
index 2039da442d8a322d248a2bd3a1337c4054b306b9..06092c4eaf60e5a5aeef9c65c52b7562690b642c 100644 (file)
--- a/interface/wx/bookctrl.h
+++ b/interface/wx/bookctrl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxBookCtrlBase
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -23,13 +23,19 @@
     This is a pure virtual class so you cannot allocate it directly.
 
     @library{wxcore}
-    @category{miscwnd}
+    @category{bookctrl}
 
     @see @ref overview_bookctrl
 */
 class wxBookCtrlBase : public wxControl
 {
 public:
+    enum
+    {
+        /// Symbolic constant indicating that no image should be used.
+        NO_IMAGE = -1
+    };
+
     /**
         Default ctor.
     */
@@ -168,7 +174,7 @@ public:
         This function behaves as SetSelection() but does @em not generate the
         page changing events.
 
-        See @ref overview_eventhandling_prog for more information.
+        See @ref overview_events_prog for more information.
     */
     virtual int ChangeSelection(size_t page) = 0;
 
@@ -221,6 +227,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
@@ -239,7 +249,7 @@ public:
         @see InsertPage()
     */
     virtual bool AddPage(wxWindow* page, const wxString& text,
-                         bool select = false, int imageId = wxNOT_FOUND);
+                         bool select = false, int imageId = NO_IMAGE);
 
     /**
         Deletes all pages.
@@ -276,7 +286,7 @@ public:
                             wxWindow* page,
                             const wxString& text,
                             bool select = false,
-                            int imageId = wxNOT_FOUND) = 0;
+                            int imageId = NO_IMAGE) = 0;
 
     /**
         Deletes the specified page, without deleting the associated window.
@@ -363,7 +373,7 @@ public:
     probably unnecessary to process both events at once.
 
     @library{wxcore}
-    @category{events}
+    @category{events,bookctrl}
 
     @see wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook
 */