/////////////////////////////////////////////////////////////////////////////
-// Name: notebook.h
+// Name: wx/gtk/notebook.h
// Purpose: wxNotebook class
// Author: Robert Roebling
// Modified by:
// RCS-ID: $Id$
// Copyright: (c) Julian Smart and Robert Roebling
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifndef __GTKNOTEBOOKH__
-#define __GTKNOTEBOOKH__
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/control.h"
+#ifndef _WX_GTKNOTEBOOK_H_
+#define _WX_GTKNOTEBOOK_H_
//-----------------------------------------------------------------------------
-// classes
+// internal class
//-----------------------------------------------------------------------------
-class wxImageList;
-class wxNotebook;
-class wxNotebookPage;
-
-// ----------------------------------------------------------------------------
-// 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
+class WXDLLIMPEXP_FWD_CORE wxGtkNotebookPage;
- DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
-};
+#include "wx/list.h"
+WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);
//-----------------------------------------------------------------------------
// wxNotebook
//-----------------------------------------------------------------------------
-class wxNotebook : public wxControl
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
{
public:
- // ctors
- // -----
- // default for dynamic class
- wxNotebook();
- // the same arguments as for wxControl (@@@ any special styles?)
- wxNotebook(wxWindow *parent,
+ // default for dynamic class
+ wxNotebook();
+ // the same arguments as for wxControl
+ 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,
+ const wxString& name = wxNotebookNameStr);
+ // 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();
+ const wxString& name = wxNotebookNameStr);
+ // dtor
+ virtual ~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)
+ // selected one (or wxNOT_FOUND 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);
+ int SetSelection(size_t nPage) { return DoSetSelection(nPage, SetSelection_SendEvent); }
// get the currently selected page
int GetSelection() const;
+ // changes selected page without sending events
+ int ChangeSelection(size_t nPage) { return DoSetSelection(nPage); }
+
// 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; }
+ bool SetPageText(size_t nPage, const wxString& strText);
+ wxString GetPageText(size_t nPage) const;
// 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;
+ int GetPageImage(size_t nPage) const;
+ bool SetPageImage(size_t nPage, int nImage);
// control the appearance of the notebook pages
// set the size (the same for all pages)
// sets the size of the tabs (assumes all tabs are the same size)
void SetTabSize(const wxSize& sz);
+ virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
+
// 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,
+
+ // adds a new page to the notebook (it will be deleted by the notebook,
// don't delete it yourself). If bSelect, this page becomes active.
- bool AddPage( wxWindow *win,
- const wxString& strText,
- bool select = FALSE,
- int imageId = -1 );
// the same as AddPage(), but adds it at the specified position
- bool InsertPage( int position,
- wxWindow *win,
- const wxString& strText,
- bool bSelect = FALSE,
- int imageId = -1 );
+ bool InsertPage( size_t position,
+ wxNotebookPage *win,
+ const wxString& strText,
+ bool bSelect = false,
+ int imageId = -1 );
- // get the panel which represents the given page
- wxWindow *GetPage(int nPage) const;
+ // handler for tab navigation
+ // --------------------------
+ void OnNavigationKey(wxNavigationKeyEvent& event);
- void OnNavigationKey(wxNavigationKeyEvent& event);
- // implementation
+ static wxVisualAttributes
+ GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
- void SetConstraintSizes(bool recurse);
- bool DoPhase(int phase);
- void ApplyWidgetStyle();
+ // implementation
+ // --------------
- // report if window belongs to notebook
- bool IsOwnGtkWindow( GdkWindow *window );
+#if wxUSE_CONSTRAINTS
+ void SetConstraintSizes(bool recurse);
+ bool DoPhase(int phase);
+#endif
- // common part of all ctors
- void Init();
+ // common part of all ctors
+ void Init();
- // helper function
- wxNotebookPage* GetNotebookPage(int page) const;
+ // Called by GTK event handler when the current page is definitely changed.
+ void GTKOnPageChanged();
- wxImageList* m_imageList;
- wxList m_pages;
+ // helper function
+ wxGtkNotebookPage* GetNotebookPage(int page) const;
- DECLARE_DYNAMIC_CLASS(wxNotebook)
- DECLARE_EVENT_TABLE()
-};
+ // the additional page data (the pages themselves are in m_pages array)
+ wxGtkNotebookPagesList m_pagesData;
-// ----------------------------------------------------------------------------
-// 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 \
- },
+ // we need to store the old selection since there
+ // is no other way to know about it at the time
+ // of the change selection event
+ int m_oldSelection;
-#endif
- // __GTKNOTEBOOKH__
+protected:
+ // set all page's attributes
+ virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+ virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
+
+ // remove one page from the notebook but do not destroy it
+ virtual wxNotebookPage *DoRemovePage(size_t nPage);
+
+ int DoSetSelection(size_t nPage, int flags = 0);
+
+private:
+ // the padding set by SetPadding()
+ int m_padding;
+
+ virtual void AddChildGTK(wxWindowGTK* child);
+
+ DECLARE_DYNAMIC_CLASS(wxNotebook)
+ DECLARE_EVENT_TABLE()
+};
+
+#endif // _WX_GTKNOTEBOOK_H_
projects / wxWidgets.git / blobdiff