support for simulating focus events since not all controls can be focused

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

diff --git a/include/wx/listbook.h b/include/wx/listbook.h
index fe6b1ba3bb316ee457809256dc9b8ad3dbf7a1ce..8d7651b4ace1f4f41afefe98425071916c384556 100644 (file)
--- a/include/wx/listbook.h
+++ b/include/wx/listbook.h
@@ -5,71 +5,42 @@
 // Modified by:
 // Created:     19.08.03
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     19.08.03
 // RCS-ID:      $Id$

-// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_LISTBOOK_H_
 #define _WX_LISTBOOK_H_
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #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
 
 #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"
 #include "wx/bookctrl.h"

+#include "wx/containr.h"

 
 

-class WXDLLEXPORT wxListView;
-class WXDLLEXPORT wxListEvent;
-
-#if wxUSE_LINE_IN_LISTBOOK
-class WXDLLEXPORT wxStaticLine;
-#endif // wxUSE_LINE_IN_LISTBOOK
-
-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-// wxListbook styles
-enum
-{
-    // default alignment: left everywhere except Mac where it is top
-    wxLB_DEFAULT = 0,
+class WXDLLIMPEXP_FWD_CORE wxListView;
+class WXDLLIMPEXP_FWD_CORE wxListEvent;

 
 

-    // put the list control to the left/right/top/bottom of the page area
-    wxLB_TOP    = 0x1,
-    wxLB_BOTTOM = 0x2,
-    wxLB_LEFT   = 0x4,
-    wxLB_RIGHT  = 0x8,
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED,  wxBookCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, wxBookCtrlEvent );

 
 

-    // the mask which can be used to extract the alignment from the style
-    wxLB_ALIGN_MASK = 0xf
-};
+// 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
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxListbook
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxListbook : public wxBookCtrl
+class WXDLLIMPEXP_CORE wxListbook : public wxNavigationEnabled<wxBookCtrlBase>

 {
 public:
 {
 public:

-    wxListbook()
-    {
-        Init();
-    }
+    wxListbook() { }

 
     wxListbook(wxWindow *parent,
                wxWindowID id,
 
     wxListbook(wxWindow *parent,
                wxWindowID id,


@@ -78,8 +49,6 @@ public:
                long style = 0,
                const wxString& name = wxEmptyString)
     {
                long style = 0,
                const wxString& name = wxEmptyString)
     {

-        Init();
-

         (void)Create(parent, id, pos, size, style, name);
     }
 
         (void)Create(parent, id, pos, size, style, name);
     }
 


@@ -92,51 +61,43 @@ public:
                 const wxString& name = wxEmptyString);
 
 
                 const wxString& name = wxEmptyString);
 
 

-    virtual int GetSelection() const;
+    // overridden base class methods

     virtual bool SetPageText(size_t n, const wxString& strText);
     virtual wxString GetPageText(size_t n) const;
     virtual int GetPageImage(size_t n) const;
     virtual bool SetPageImage(size_t n, int imageId);
     virtual bool SetPageText(size_t n, const wxString& strText);
     virtual wxString GetPageText(size_t n) const;
     virtual int GetPageImage(size_t n) const;
     virtual bool SetPageImage(size_t n, int imageId);

-    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;

     virtual bool InsertPage(size_t n,
                             wxWindow *page,
                             const wxString& text,
                             bool bSelect = false,
     virtual bool InsertPage(size_t n,
                             wxWindow *page,
                             const wxString& text,
                             bool bSelect = false,

-                            int imageId = -1);
-    virtual int SetSelection(size_t n);
+                            int imageId = NO_IMAGE);
+    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);
 
     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() const { return (wxListView*)m_bookctrl; }

 
 protected:
     virtual wxWindow *DoRemovePage(size_t page);
 
 
 protected:
     virtual wxWindow *DoRemovePage(size_t page);
 

-private:
-    // common part of all constructors
-    void Init();
+    void UpdateSelectedPage(size_t newsel);

 
 

-    // get the size which the list control should have
-    wxSize GetListSize() const;
+    wxBookCtrlEvent* CreatePageChangingEvent() const;
+    void MakeChangedEvent(wxBookCtrlEvent &event);

 
 

-    // get the page area
-    wxRect GetPageRect() const;
+    // Get the correct wxListCtrl flags to use depending on our own flags.
+    long GetListCtrlFlags() const;

 
     // event handlers
 
     // event handlers

-    void OnSize(wxSizeEvent& event);

     void OnListSelected(wxListEvent& event);
     void OnListSelected(wxListEvent& event);

+    void OnSize(wxSizeEvent& event);

 
 

-
-    // the list control we use for showing the pages index
-    wxListView *m_list;
-
-#if wxUSE_LINE_IN_LISTBOOK
-    // the line separating it from the page area
-    wxStaticLine *m_line;
-#endif // wxUSE_LINE_IN_LISTBOOK
-
-    // the currently selected page or wxNOT_FOUND if none
-    int m_selection;
+private:
+    // this should be called when we need to be relaid out
+    void UpdateSize();

 
 
     DECLARE_EVENT_TABLE()
 
 
     DECLARE_EVENT_TABLE()


@@ -147,41 +108,18 @@ private:
 // listbook event class and related stuff
 // ----------------------------------------------------------------------------
 
 // listbook event class and related stuff
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxListbookEvent : public wxBookCtrlEvent
-{
-public:
-    wxListbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
-                    int nSel = -1, int nOldSel = -1)
-        : wxBookCtrlEvent(commandType, id, nSel, nOldSel)
-    {
-    }
+// 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)

 
 

-private:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxListbookEvent)
-};
+#define EVT_LISTBOOK_PAGE_CHANGED(winid, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, winid, wxBookCtrlEventHandler(fn))

 
 

-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 EVT_LISTBOOK_PAGE_CHANGED(id, fn)                                   \
-  DECLARE_EVENT_TABLE_ENTRY(                                                \
-    wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED,                                    \
-    id,                                                                     \
-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxListbookEventFunction, &fn ),  \
-    NULL                                                                    \
-  ),
-
-#define EVT_LISTBOOK_PAGE_CHANGING(id, fn)                                  \
-  DECLARE_EVENT_TABLE_ENTRY(                                                \
-    wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING,                                   \
-    id,                                                                     \
-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxListbookEventFunction, &fn ),  \
-    NULL                                                                    \
-  ),
+#define EVT_LISTBOOK_PAGE_CHANGING(winid, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, winid, wxBookCtrlEventHandler(fn))

 
 #endif // wxUSE_LISTBOOK
 
 
 #endif // wxUSE_LISTBOOK