Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/listbook.h b/interface/wx/listbook.h
index 28855b7ef39b74cdb3693edbfc69940d5e1e009e..2561f3931fd480be47b45f58210126c54fde36ee 100644 (file)
--- a/interface/wx/listbook.h
+++ b/interface/wx/listbook.h
@@ -2,26 +2,32 @@
 // Name:        listbook.h
 // Purpose:     interface of wxListbook
 // Author:      wxWidgets team
 // Name:        listbook.h
 // Purpose:     interface of wxListbook
 // Author:      wxWidgets team

-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+// wxListbook flags
+#define wxLB_DEFAULT          wxBK_DEFAULT
+#define wxLB_TOP              wxBK_TOP
+#define wxLB_BOTTOM           wxBK_BOTTOM
+#define wxLB_LEFT             wxBK_LEFT
+#define wxLB_RIGHT            wxBK_RIGHT
+#define wxLB_ALIGN_MASK       wxBK_ALIGN_MASK
+
+wxEventType wxEVT_LISTBOOK_PAGE_CHANGED;
+wxEventType wxEVT_LISTBOOK_PAGE_CHANGING;
+

 /**
     @class wxListbook
 /**
     @class wxListbook

-    @wxheader{listbook.h}

 
 

-    wxListbook is a class similar to wxNotebook but which
-    uses a wxListCtrl to show the labels instead of the
-    tabs.
+    wxListbook is a class similar to wxNotebook but which uses a wxListCtrl
+    to show the labels instead of the tabs.

 
     The underlying wxListCtrl displays page labels in a one-column report view
 
     The underlying wxListCtrl displays page labels in a one-column report view

-    by default.  Calling wxListbook::SetImageList will implicitly switch the
+    by default. Calling wxBookCtrl::SetImageList will implicitly switch the

     control to use an icon view.
 
     control to use an icon view.
 

-    There is no documentation for this class yet but its usage is
-    identical to wxNotebook (except for the features clearly related to tabs
-    only), so please refer to that class documentation for now. You can also
-    use the @ref overview_samplenotebook "notebook sample" to see wxListbook in
+    For usage documentation of this class, please refer to the base abstract class
+    wxBookCtrl. You can also use the @ref page_samples_notebook to see wxListbook in

     action.
 
     @beginStyleTable
     action.
 
     @beginStyleTable


@@ -38,24 +44,53 @@
            Place labels below the page area.
     @endStyleTable
 
            Place labels below the page area.
     @endStyleTable
 

+    @beginEventEmissionTable{wxBookCtrlEvent}
+    @event{EVT_LISTBOOK_PAGE_CHANGED(id, func)}
+        The page selection was changed.
+        Processes a @c wxEVT_LISTBOOK_PAGE_CHANGED event.
+    @event{EVT_LISTBOOK_PAGE_CHANGING(id, func)}
+        The page selection is about to be changed.
+        Processes a @c wxEVT_LISTBOOK_PAGE_CHANGING event.
+        This event can be vetoed.
+    @endEventTable
+

     @library{wxcore}
     @library{wxcore}

-    @category{miscwnd}
+    @category{bookctrl}
+    @appearance{listbook}

 
 

-    @see wxBookCtrl(), wxNotebook, @ref overview_samplenotebook "notebook sample"
+    @see wxBookCtrl, wxNotebook, @ref page_samples_notebook

 */
 */

-class wxListbook : public wxBookCtrl overview
+class wxListbook : public wxBookCtrlBase

 {
 public:
 {
 public:

-    //@{

     /**
     /**

-        Constructs a listbook control.
+        Default ctor.

     */
     wxListbook();
     */
     wxListbook();

+
+    /**
+        Constructs a listbook control.
+    */

     wxListbook(wxWindow* parent, wxWindowID id,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
     wxListbook(wxWindow* parent, wxWindowID id,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,

-               const wxString& name = wxEmptyStr);
-    //@}
+               const wxString& name = wxEmptyString);
+
+    /**
+       Create the list book control that has already been constructed with
+       the default constructor.
+    */
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxString& name = wxEmptyString);
+
+    /**
+        Returns the wxListView associated with the control.
+    */
+    wxListView* GetListView() const;

 };
 
 };