include/wx/gtk/notebook.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        notebook.h
   3 // Purpose:     wxNotebook class
   4 // Author:      Robert Roebling
   5 // Modified by:
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Julian Smart and Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef __GTKNOTEBOOKH__
  12 #define __GTKNOTEBOOKH__
  13
  14 //-----------------------------------------------------------------------------
  15 // internal class
  16 //-----------------------------------------------------------------------------
  17
  18 class WXDLLIMPEXP_CORE wxGtkNotebookPage;
  19
  20 #include "wx/list.h"
  21 WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);
  22
  23 //-----------------------------------------------------------------------------
  24 // wxNotebook
  25 //-----------------------------------------------------------------------------
  26
  27 class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
  28 {
  29 public:
  30       // default for dynamic class
  31     wxNotebook();
  32       // the same arguments as for wxControl
  33     wxNotebook(wxWindow *parent,
  34              wxWindowID id,
  35              const wxPoint& pos = wxDefaultPosition,
  36              const wxSize& size = wxDefaultSize,
  37              long style = 0,
  38              const wxString& name = wxNotebookNameStr);
  39       // Create() function
  40     bool Create(wxWindow *parent,
  41               wxWindowID id,
  42               const wxPoint& pos = wxDefaultPosition,
  43               const wxSize& size = wxDefaultSize,
  44               long style = 0,
  45               const wxString& name = wxNotebookNameStr);
  46       // dtor
  47     virtual ~wxNotebook();
  48
  49   // accessors
  50   // ---------
  51
  52     // set the currently selected page, return the index of the previously
  53     // selected one (or -1 on error)
  54     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
  55   int SetSelection(size_t nPage);
  56     // get the currently selected page
  57   int GetSelection() const;
  58
  59     // set/get the title of a page
  60   bool SetPageText(size_t nPage, const wxString& strText);
  61   wxString GetPageText(size_t nPage) const;
  62
  63     // sets/returns item's image index in the current image list
  64   int  GetPageImage(size_t nPage) const;
  65   bool SetPageImage(size_t nPage, int nImage);
  66
  67   // control the appearance of the notebook pages
  68     // set the size (the same for all pages)
  69   void SetPageSize(const wxSize& size);
  70     // set the padding between tabs (in pixels)
  71   void SetPadding(const wxSize& padding);
  72     // sets the size of the tabs (assumes all tabs are the same size)
  73   void SetTabSize(const wxSize& sz);
  74
  75   virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
  76
  77   // operations
  78   // ----------
  79     // remove all pages
  80   bool DeleteAllPages();
  81
  82     // adds a new page to the notebook (it will be deleted by the notebook,
  83     // don't delete it yourself). If bSelect, this page becomes active.
  84     // the same as AddPage(), but adds it at the specified position
  85     bool InsertPage( size_t position,
  86                      wxNotebookPage *win,
  87                      const wxString& strText,
  88                      bool bSelect = false,
  89                      int imageId = -1 );
  90
  91     // handler for tab navigation
  92     // --------------------------
  93     void OnNavigationKey(wxNavigationKeyEvent& event);
  94
  95
  96     static wxVisualAttributes
  97     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  98
  99     // implementation
 100     // --------------
 101
 102 #if wxUSE_CONSTRAINTS
 103     void SetConstraintSizes(bool recurse);
 104     bool DoPhase(int phase);
 105 #endif
 106
 107     // set all page's attributes
 108     void DoApplyWidgetStyle(GtkRcStyle *style);
 109
 110     // report if window belongs to notebook
 111     bool IsOwnGtkWindow( GdkWindow *window );
 112
 113     // common part of all ctors
 114     void Init();
 115
 116     // helper function
 117     wxGtkNotebookPage* GetNotebookPage(int page) const;
 118
 119     // the additional page data (the pages themselves are in m_pages array)
 120     wxGtkNotebookPagesList m_pagesData;
 121
 122     // for reasons explained in gtk/notebook.cpp we store the current
 123     // selection internally instead of querying the notebook for it
 124     int m_selection;
 125
 126     // flag set to true while we're inside "switch_page" callback
 127     bool m_inSwitchPage;
 128
 129 protected:
 130     // remove one page from the notebook but do not destroy it
 131     virtual wxNotebookPage *DoRemovePage(size_t nPage);
 132
 133 private:
 134     // the padding set by SetPadding()
 135     int m_padding;
 136
 137     DECLARE_DYNAMIC_CLASS(wxNotebook)
 138     DECLARE_EVENT_TABLE()
 139 };
 140
 141 #endif
 142     // __GTKNOTEBOOKH__