Add OSX prefix, and be clear that this is OS X only API to avoid any expectation...

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

diff --git a/include/wx/listbook.h b/include/wx/listbook.h
index 9414943190298dc7520727a00127f5ba16641992..a021dee95e677b5c73f05e8dae58b90ca7b1ba6b 100644 (file)
--- a/include/wx/listbook.h
+++ b/include/wx/listbook.h
@@ -12,38 +12,31 @@
 #ifndef _WX_LISTBOOK_H_
 #define _WX_LISTBOOK_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "listbook.h"
-#endif
-
 #include "wx/defs.h"
 
 #if wxUSE_LISTBOOK
 
-// this can be defined to put a static line as separator between the list
-// control and the page area; but I think it finally looks better without it so
-// it is not enabled by default
-//#define wxUSE_LINE_IN_LISTBOOK 1
-
-#if !wxUSE_STATLINE
-    #undef wxUSE_LINE_IN_LISTBOOK
-    #define wxUSE_LINE_IN_LISTBOOK 0
-#endif
-
 #include "wx/bookctrl.h"
 
-class WXDLLEXPORT wxListView;
-class WXDLLEXPORT wxListEvent;
+class WXDLLIMPEXP_FWD_CORE wxListView;
+class WXDLLIMPEXP_FWD_CORE wxListEvent;
 
-#if wxUSE_LINE_IN_LISTBOOK
-class WXDLLEXPORT wxStaticLine;
-#endif // wxUSE_LINE_IN_LISTBOOK
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED,  wxBookCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, wxBookCtrlEvent );
+
+// 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
 
 // ----------------------------------------------------------------------------
 // wxListbook
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxListbook : public wxBookCtrlBase
+class WXDLLIMPEXP_CORE wxListbook : public wxBookCtrlBase
 {
 public:
     wxListbook()
@@ -72,6 +65,7 @@ public:
                 const wxString& name = wxEmptyString);
 
 
+    // overridden base class methods
     virtual int GetSelection() const;
     virtual bool SetPageText(size_t n, const wxString& strText);
     virtual wxString GetPageText(size_t n) const;
@@ -83,36 +77,33 @@ public:
                             const wxString& text,
                             bool bSelect = false,
                             int imageId = -1);
-    virtual int SetSelection(size_t n);
+    virtual int SetSelection(size_t n) { return DoSetSelection(n, SetSelection_SendEvent); }
+    virtual int ChangeSelection(size_t n) { return DoSetSelection(n); }
+    virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
     virtual void SetImageList(wxImageList *imageList);
 
-    // returns true if we have wxLB_TOP or wxLB_BOTTOM style
-    bool IsVertical() const { return HasFlag(wxLB_BOTTOM | wxLB_TOP); }
-
     virtual bool DeleteAllPages();
 
-    wxListView* GetListView() { return m_list; }
+    wxListView* GetListView() const { return (wxListView*)m_bookctrl; }
 
 protected:
     virtual wxWindow *DoRemovePage(size_t page);
 
     // get the size which the list control should have
-    wxSize GetListSize() const;
+    virtual wxSize GetControllerSize() const;
 
-    // get the page area
-    wxRect GetPageRect() const;
+    void UpdateSelectedPage(size_t newsel);
 
-    // event handlers
-    void OnSize(wxSizeEvent& event);
-    void OnListSelected(wxListEvent& event);
+    wxBookCtrlEvent* CreatePageChangingEvent() const;
+    void MakeChangedEvent(wxBookCtrlEvent &event);
 
-    // the list control we use for showing the pages index
-    wxListView *m_list;
+    // get flags for different list control modes
+    long GetListCtrlIconViewFlags() const;
+    long GetListCtrlReportViewFlags() const;
 
-#if wxUSE_LINE_IN_LISTBOOK
-    // the line separating it from the page area
-    wxStaticLine *m_line;
-#endif // wxUSE_LINE_IN_LISTBOOK
+    // event handlers
+    void OnListSelected(wxListEvent& event);
+    void OnSize(wxSizeEvent& event);
 
     // the currently selected page or wxNOT_FOUND if none
     int m_selection;
@@ -121,6 +112,10 @@ private:
     // common part of all constructors
     void Init();
 
+    // this should be called when we need to be relaid out
+    void UpdateSize();
+
+
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxListbook)
 };
@@ -129,32 +124,18 @@ private:
 // listbook event class and related stuff
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxListbookEvent : public wxBookCtrlBaseEvent
-{
-public:
-    wxListbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
-                    int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND)
-        : wxBookCtrlBaseEvent(commandType, id, nSel, nOldSel)
-    {
-    }
-
-private:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxListbookEvent)
-};
-
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING;
-
-typedef void (wxEvtHandler::*wxListbookEventFunction)(wxListbookEvent&);
-
-#define wxListbookEventHandler(func) \
-    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxListbookEventFunction, &func)
+// wxListbookEvent is obsolete and defined for compatibility only (notice that
+// we use #define and not typedef to also keep compatibility with the existing
+// code which forward declares it)
+#define wxListbookEvent wxBookCtrlEvent
+typedef wxBookCtrlEventFunction wxListbookEventFunction;
+#define wxListbookEventHandler(func) wxBookCtrlEventHandler(func)
 
 #define EVT_LISTBOOK_PAGE_CHANGED(winid, fn) \
-    wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, winid, wxListbookEventHandler(fn))
+    wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, winid, wxBookCtrlEventHandler(fn))
 
 #define EVT_LISTBOOK_PAGE_CHANGING(winid, fn) \
-    wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, winid, wxListbookEventHandler(fn))
+    wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, winid, wxBookCtrlEventHandler(fn))
 
 #endif // wxUSE_LISTBOOK