- DECLARE_DYNAMIC_CLASS(wxNotebook)
-
- 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;
- 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 );
- wxPanel *CreatePage( const int page, const wxString& text, const int imageId = -1, void* data = NULL );
- wxPanel *GetPanel( const int page );
-
- // overriden to do nothing
- virtual void AddChild( wxWindow *win );
-
- protected:
+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);
+ // sets the size of the tabs (assumes all tabs are the same size)
+ void SetTabSize(const wxSize& sz);
+
+ // 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();
projects / wxWidgets.git / blobdiff