Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / gtk / notebook.h

diff --git a/include/wx/gtk/notebook.h b/include/wx/gtk/notebook.h
index eebf0ba9ecc2af9178a0d5cba78089f4be2dbdbc..878bbc4dd33fd39c13ad3f0585311f50dfba8a42 100644 (file)
--- a/include/wx/gtk/notebook.h
+++ b/include/wx/gtk/notebook.h
@@ -1,106 +1,145 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        tabctrl.h
-// Purpose:     wxTabCtrl class
+// Name:        wx/gtk/notebook.h
+// Purpose:     wxNotebook class

 // Author:      Robert Roebling
 // Modified by:
 // RCS-ID:      $Id$
 // 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 licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __TABCTRLH__
-#define __TABCTRLH__
-
-#ifdef __GNUG__
-#pragma interface "notebook.h"
-#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;
-
-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+class WXDLLIMPEXP_FWD_CORE wxGtkNotebookPage;

 
 

+#include "wx/list.h"
+WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);

 
 //-----------------------------------------------------------------------------
 // wxNotebook
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxNotebook
 //-----------------------------------------------------------------------------
 

-class wxNotebook: public wxControl
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase

 {
 {

-  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;
-    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;
-    
-    // overriden to do nothing
-    virtual void AddChild( wxWindow *win );
-    
-  protected:
-  
-    wxImageList*    m_imageList;
-    wxList          m_pages;
-
-  DECLARE_EVENT_TABLE()
-};
+public:
+      // 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 = wxNotebookNameStr);
+      // Create() function
+    bool Create(wxWindow *parent,
+              wxWindowID id,
+              const wxPoint& pos = wxDefaultPosition,
+              const wxSize& size = wxDefaultSize,
+              long style = 0,
+              const wxString& name = wxNotebookNameStr);
+      // dtor
+    virtual ~wxNotebook();
+
+  // accessors
+  // ---------
+
+    // set the currently selected page, return the index of the previously
+    // selected one (or wxNOT_FOUND on error)
+    // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
+    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(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(size_t nPage) const;
+  bool SetPageImage(size_t nPage, int nImage);
+
+  // control the appearance of the notebook pages
+    // 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);
+
+  // geometry
+  virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
+  virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
+
+  // operations
+  // ----------
+    // remove all pages
+  bool DeleteAllPages();
+
+    // 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.
+    // the same as AddPage(), but adds it at the specified position
+    bool InsertPage( size_t position,
+                     wxNotebookPage *win,
+                     const wxString& strText,
+                     bool bSelect = false,
+                     int imageId = NO_IMAGE );
+
+    // handler for tab navigation
+    // --------------------------
+    void OnNavigationKey(wxNavigationKeyEvent& event);
+
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+    // implementation
+    // --------------
+
+#if wxUSE_CONSTRAINTS
+    void SetConstraintSizes(bool recurse);
+    bool DoPhase(int phase);
+#endif

 
 

-//-----------------------------------------------------------------------------
-// wxTabEvent
-//-----------------------------------------------------------------------------
+    // Called by GTK event handler when the current page is definitely changed.
+    void GTKOnPageChanged();

 
 

-class wxTabEvent: public wxCommandEvent
-{
-  DECLARE_DYNAMIC_CLASS(wxTabEvent)
+    // helper function
+    wxGtkNotebookPage* GetNotebookPage(int page) const;

 
 

- public:
- 
-  wxTabEvent( WXTYPE commandType = 0, int id = 0 );
-};
+    // the additional page data (the pages themselves are in m_pages array)
+    wxGtkNotebookPagesList m_pagesData;

 
 

-typedef void (wxEvtHandler::*wxTabEventFunction)(wxTabEvent&);
+    // 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;

 
 

-#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 },
+protected:
+    // set all page's attributes
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+    virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;

 
 

-#endif
-    // __TABCTRLH__
+    // 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;
+
+    void Init();
+    virtual void AddChildGTK(wxWindowGTK* child);
+
+    DECLARE_DYNAMIC_CLASS(wxNotebook)
+    DECLARE_EVENT_TABLE()
+};
+
+#endif // _WX_GTKNOTEBOOK_H_