/////////////////////////////////////////////////////////////////////////////
-// Name: tabctrl.h
-// Purpose: wxTabCtrl class
+// Name: notebook.h
+// Purpose: wxNotebook class
// Author: Robert Roebling
// Modified by:
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart and Robert Roebling
+// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-#ifndef __TABCTRLH__
-#define __TABCTRLH__
+#ifndef __GTKNOTEBOOKH__
+#define __GTKNOTEBOOKH__
#ifdef __GNUG__
-#pragma interface "notebook.h"
+#pragma interface
#endif
#include "wx/defs.h"
class wxNotebook;
class wxNotebookPage;
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// notebook events
+// ----------------------------------------------------------------------------
+class wxNotebookEvent : public wxNotifyEvent
+{
+public:
+ wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+ int nSel = -1, int nOldSel = -1)
+ : wxNotifyEvent(commandType, id)
+ {
+ m_bAllow = TRUE;
+ m_nSel = nSel;
+ m_nOldSel = nOldSel;
+ }
+
+ // accessors
+ int GetSelection() const { return m_nSel; }
+ int GetOldSelection() const { return m_nOldSel; }
+
+ // for wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING event this method may be called
+ // to disallow the page change
+ void Veto() { m_bAllow = FALSE; }
+
+ // implementation: for wxNotebook usage only
+ bool Allowed() const { return m_bAllow; }
+
+private:
+ bool m_bAllow;
+
+ int m_nSel, // currently selected page
+ m_nOldSel; // previously selected page
+
+ DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
+};
//-----------------------------------------------------------------------------
// wxNotebook
//-----------------------------------------------------------------------------
-class wxNotebook: public wxControl
+class wxNotebook : public wxControl
{
- DECLARE_DYNAMIC_CLASS(wxNotebook)
+public:
+ // ctors
+ // -----
+ // default for dynamic class
+ wxNotebook();
+ // the same arguments as for wxControl (@@@ any special styles?)
+ wxNotebook(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = "notebook");
+ // Create() function
+ bool Create(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = "notebook");
+ // dtor
+ ~wxNotebook();
+
+ // accessors
+ // ---------
+ // get number of pages in the dialog
+ int GetPageCount() const;
+
+ // set the currently selected page, return the index of the previously
+ // selected one (or -1 on error)
+ // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
+ int SetSelection(int nPage);
+ // cycle thru the tabs
+ void AdvanceSelection(bool bForward = TRUE);
+ // get the currently selected page
+ int GetSelection() const;
+
+ // set/get the title of a page
+ bool SetPageText(int nPage, const wxString& strText);
+ wxString GetPageText(int nPage) const;
+
+ // image list stuff: each page may have an image associated with it. All
+ // the images belong to an image list, so you have to
+ // 1) create an image list
+ // 2) associate it with the notebook
+ // 3) set for each page it's image
+ // associate image list with a control
+ void SetImageList(wxImageList* imageList);
+ // get pointer (may be NULL) to the associated image list
+ wxImageList* GetImageList() const { return m_imageList; }
+
+ // sets/returns item's image index in the current image list
+ int GetPageImage(int nPage) const;
+ bool SetPageImage(int nPage, int nImage);
+
+ // currently it's always 1 because wxGTK doesn't support multi-row
+ // tab controls
+ int GetRowCount() const;
+
+ // control the appearance of the notebook pages
+ // set the size (the same for all pages)
+ void SetPageSize(const wxSize& size);
+ // set the padding between tabs (in pixels)
+ void SetPadding(const wxSize& padding);
+
+ // operations
+ // ----------
+ // remove one page from the notebook but do not destroy it
+ bool RemovePage(int nPage);
+ // remove one page from the notebook
+ bool DeletePage(int nPage);
+ // remove all pages
+ bool DeleteAllPages();
+ // adds a new page to the notebook (it will be deleted ny the notebook,
+ // don't delete it yourself). If bSelect, this page becomes active.
+ bool AddPage(wxWindow *pPage,
+ const wxString& strText,
+ bool select = FALSE,
+ int imageId = -1);
+ // @@@@ VZ: I don't know how to implement InsertPage()
+
+ // get the panel which represents the given page
+ wxWindow *GetPage(int nPage) const;
+
+ void OnNavigationKey(wxNavigationKeyEvent& event);
+
+ // implementation
- public:
-
- wxNotebook(void);
- wxNotebook( wxWindow *parent, const wxWindowID id,
- const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- const long style = 0, const wxString& name = "notebook" );
- ~wxNotebook(void);
- bool Create(wxWindow *parent, const wxWindowID id,
- const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- const long style = 0, const wxString& name = "notebook" );
- int GetSelection(void) const;
- wxImageList* GetImageList(void) const;
- int GetPageCount(void) const;
- int GetRowCount(void) const;
- wxString GetPageText( const int page ) const;
- int GetPageImage( const int page ) const;
- void* GetPageData( const int page ) const;
- wxNotebookPage* GetNotebookPage(int page) const;
- int SetSelection( const int page );
- void SetImageList( wxImageList* imageList );
- bool SetPageText( const int page, const wxString& text );
- bool SetPageImage( const int oage, const int image );
- bool SetPageData( const int page, void* data );
- void SetPageSize( const wxSize& size );
- void SetPadding( const wxSize& padding );
- bool DeleteAllPages(void);
- bool DeletePage( const int page );
- bool AddPage(wxWindow* win, const wxString& text, const int imageId = -1, void* data = NULL );
- wxWindow *GetPageWindow( const int page ) const;
- virtual void AddChild( wxWindow *win );
-
- protected:
- // wxWin callbacks
- void OnSize(wxSizeEvent& event);
-
- wxImageList* m_imageList;
- wxList m_pages;
+ void SetConstraintSizes(bool recurse);
+ bool DoPhase(int phase);
+ void ApplyWidgetStyle();
- DECLARE_EVENT_TABLE()
-};
+ // common part of all ctors
+ void Init();
-//-----------------------------------------------------------------------------
-// wxTabEvent
-//-----------------------------------------------------------------------------
+ // helper function
+ wxNotebookPage* GetNotebookPage(int page) const;
-class wxTabEvent: public wxCommandEvent
-{
- DECLARE_DYNAMIC_CLASS(wxTabEvent)
+ wxImageList* m_imageList;
+ wxList m_pages;
+ size_t m_idHandler; // the change page handler id
- public:
-
- wxTabEvent( WXTYPE commandType = 0, int id = 0 );
+ DECLARE_DYNAMIC_CLASS(wxNotebook)
+ DECLARE_EVENT_TABLE()
};
-typedef void (wxEvtHandler::*wxTabEventFunction)(wxTabEvent&);
-
-#define EVT_TAB_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TAB_SEL_CHANGED, \
- id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTabEventFunction) & fn, NULL },
-#define EVT_TAB_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TAB_SEL_CHANGING, \
- id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTabEventFunction) & fn, NULL },
+// ----------------------------------------------------------------------------
+// event macros
+// ----------------------------------------------------------------------------
+typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
+
+#define EVT_NOTEBOOK_PAGE_CHANGED(id, fn) \
+ { \
+ wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, \
+ id, \
+ -1, \
+ (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
+ NULL \
+ },
+
+#define EVT_NOTEBOOK_PAGE_CHANGING(id, fn) \
+ { \
+ wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \
+ id, \
+ -1, \
+ (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
+ NULL \
+ },
#endif
- // __TABCTRLH__
+ // __GTKNOTEBOOKH__
projects / wxWidgets.git / blobdiff