Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/univ/notebook.h b/include/wx/univ/notebook.h
index 2654e7956e6ebcc99885e1d8b685489e7aa46cd0..bbc4250be93b22ad252dce4559396236db2b7df2 100644 (file)
--- a/include/wx/univ/notebook.h
+++ b/include/wx/univ/notebook.h
@@ -12,26 +12,24 @@
 #ifndef _WX_UNIV_NOTEBOOK_H_
 #define _WX_UNIV_NOTEBOOK_H_
 
 #ifndef _WX_UNIV_NOTEBOOK_H_
 #define _WX_UNIV_NOTEBOOK_H_
 

-#ifdef __GNUG__
-    #pragma interface "univnotebook.h"
-#endif
+#include "wx/arrstr.h"

 
 

-class WXDLLEXPORT wxSpinButton;
+class WXDLLIMPEXP_FWD_CORE wxSpinButton;

 
 // ----------------------------------------------------------------------------
 // the actions supported by this control
 // ----------------------------------------------------------------------------
 
 // change the page: to the next/previous/given one
 
 // ----------------------------------------------------------------------------
 // the actions supported by this control
 // ----------------------------------------------------------------------------
 
 // change the page: to the next/previous/given one

-#define wxACTION_NOTEBOOK_NEXT      _T("nexttab")
-#define wxACTION_NOTEBOOK_PREV      _T("prevtab")
-#define wxACTION_NOTEBOOK_GOTO      _T("gototab")
+#define wxACTION_NOTEBOOK_NEXT      wxT("nexttab")
+#define wxACTION_NOTEBOOK_PREV      wxT("prevtab")
+#define wxACTION_NOTEBOOK_GOTO      wxT("gototab")

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

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

 {
 public:
     // ctors and such
 {
 public:
     // ctors and such


@@ -44,7 +42,7 @@ public:
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,

-               const wxString& name = wxNOTEBOOK_NAME)
+               const wxString& name = wxNotebookNameStr)

     {
         Init();
 
     {
         Init();
 


@@ -57,7 +55,7 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxString& name = wxNOTEBOOK_NAME);
+                const wxString& name = wxNotebookNameStr);

 
     // dtor
     virtual ~wxNotebook();
 
     // dtor
     virtual ~wxNotebook();


@@ -65,48 +63,48 @@ public:
     // implement wxNotebookBase pure virtuals
     // --------------------------------------
 
     // implement wxNotebookBase pure virtuals
     // --------------------------------------
 

-    virtual int SetSelection(int nPage);
-    virtual int GetSelection() const { return m_sel; }
+    virtual int SetSelection(size_t nPage) { return DoSetSelection(nPage, SetSelection_SendEvent); }

 
 

-    virtual bool SetPageText(int nPage, const wxString& strText);
-    virtual wxString GetPageText(int nPage) const;
+    // changes selected page without sending events
+    int ChangeSelection(size_t nPage) { return DoSetSelection(nPage); }

 
 

-    virtual int GetPageImage(int nPage) const;
-    virtual bool SetPageImage(int nPage, int nImage);
+    virtual bool SetPageText(size_t nPage, const wxString& strText);
+    virtual wxString GetPageText(size_t nPage) const;
+
+    virtual int GetPageImage(size_t nPage) const;
+    virtual bool SetPageImage(size_t nPage, int nImage);

 
     virtual void SetPageSize(const wxSize& size);
     virtual void SetPadding(const wxSize& padding);
     virtual void SetTabSize(const wxSize& sz);
 
 
     virtual void SetPageSize(const wxSize& size);
     virtual void SetPadding(const wxSize& padding);
     virtual void SetTabSize(const wxSize& sz);
 

-    virtual wxSize CalcSizeFromPage(const wxSize& sizePage);
+    virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;

 
     virtual bool DeleteAllPages();
 
 
     virtual bool DeleteAllPages();
 

-    virtual bool InsertPage(int nPage,
+    virtual bool InsertPage(size_t nPage,

                             wxNotebookPage *pPage,
                             const wxString& strText,
                             wxNotebookPage *pPage,
                             const wxString& strText,

-                            bool bSelect = FALSE,
-                            int imageId = -1);
+                            bool bSelect = false,
+                            int imageId = NO_IMAGE);

 
     // style tests
     // -----------
 
 
     // style tests
     // -----------
 

-    // return TRUE if all tabs have the same width
-    bool FixedSizeTabs() const
-        { return GetWindowStyle() & wxNB_FIXEDWIDTH != 0; }
+    // return true if all tabs have the same width
+    bool FixedSizeTabs() const { return HasFlag(wxNB_FIXEDWIDTH); }

 
     // return wxTOP/wxBOTTOM/wxRIGHT/wxLEFT
     wxDirection GetTabOrientation() const;
 
 
     // return wxTOP/wxBOTTOM/wxRIGHT/wxLEFT
     wxDirection GetTabOrientation() const;
 

-    // return TRUE if the notebook has tabs at the sidesand not at the top (or
+    // return true if the notebook has tabs at the sidesand not at the top (or

     // bottom) as usual
     bool IsVertical() const;
 
     // hit testing
     // -----------
 
     // bottom) as usual
     bool IsVertical() const;
 
     // hit testing
     // -----------
 

-    // return the tab at this position or -1 if none
-    int HitTest(const wxPoint& pt) const;
+    virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;

 
     // input handling
     // --------------
 
     // input handling
     // --------------


@@ -115,23 +113,30 @@ public:
                                long numArg = 0l,
                                const wxString& strArg = wxEmptyString);
 
                                long numArg = 0l,
                                const wxString& strArg = wxEmptyString);
 

+    static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
+    virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
+    {
+        return GetStdInputHandler(handlerDef);
+    }
+

     // refresh the currently selected tab
     void RefreshCurrent();
 
 protected:
     // refresh the currently selected tab
     void RefreshCurrent();
 
 protected:

-    virtual wxNotebookPage *DoRemovePage(int nPage);
+    virtual wxNotebookPage *DoRemovePage(size_t nPage);

 
     // drawing
     virtual void DoDraw(wxControlRenderer *renderer);
     void DoDrawTab(wxDC& dc, const wxRect& rect, size_t n);
 
     // resizing
 
     // drawing
     virtual void DoDraw(wxControlRenderer *renderer);
     void DoDrawTab(wxDC& dc, const wxRect& rect, size_t n);
 
     // resizing

-    virtual wxSize DoGetBestClientSize() const;

     virtual void DoMoveWindow(int x, int y, int width, int height);
     virtual void DoSetSize(int x, int y,
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO);
 
     virtual void DoMoveWindow(int x, int y, int width, int height);
     virtual void DoSetSize(int x, int y,
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO);
 

+    int DoSetSelection(size_t nPage, int flags = 0);
+

     // common part of all ctors
     void Init();
 
     // common part of all ctors
     void Init();
 


@@ -155,7 +160,7 @@ protected:
     void PositionSpinBtn();
 
     // refresh the given tab only
     void PositionSpinBtn();
 
     // refresh the given tab only

-    void RefreshTab(int page);
+    void RefreshTab(int page, bool forceSelected = false);

 
     // refresh all tabs
     void RefreshAllTabs();
 
     // refresh all tabs
     void RefreshAllTabs();


@@ -180,9 +185,9 @@ protected:
     wxCoord GetTabWidth(int page) const
         { return FixedSizeTabs() ? m_widthMax : m_widths[page]; }
 
     wxCoord GetTabWidth(int page) const
         { return FixedSizeTabs() ? m_widthMax : m_widths[page]; }
 

-    // return TRUE if the tab has an associated image
+    // return true if the tab has an associated image

     bool HasImage(int page) const
     bool HasImage(int page) const

-        { return m_imageList && m_images[page] != -1; }
+        { return HasImageList() && m_images[page] != -1; }

 
     // get the part of the notebook reserved for the pages (slightly larger
     // than GetPageRect() as we draw a border and leave marginin between)
 
     // get the part of the notebook reserved for the pages (slightly larger
     // than GetPageRect() as we draw a border and leave marginin between)


@@ -194,21 +199,15 @@ protected:
     // get our client size from the page size
     wxSize GetSizeForPage(const wxSize& size) const;
 
     // get our client size from the page size
     wxSize GetSizeForPage(const wxSize& size) const;
 

-    // change thep age and send events about it (can be vetoed by user code)
-    void ChangePage(int nPage);
-

     // scroll the tabs so that the first page shown becomes the given one
     // scroll the tabs so that the first page shown becomes the given one

-    void ScrollTo(int page);
+    void ScrollTo(size_t page);

 
     // scroll the tabs so that the first page shown becomes the given one
 
     // scroll the tabs so that the first page shown becomes the given one

-    void ScrollLastTo(int page);
+    void ScrollLastTo(size_t page);

 
     // the pages titles
     wxArrayString m_titles;
 
 
     // the pages titles
     wxArrayString m_titles;
 

-    // the current selection
-    size_t m_sel;
-

     // the spin button to change the pages
     wxSpinButton *m_spinbtn;
 
     // the spin button to change the pages
     wxSpinButton *m_spinbtn;
 


@@ -249,28 +248,5 @@ protected:
     DECLARE_DYNAMIC_CLASS(wxNotebook)
 };
 
     DECLARE_DYNAMIC_CLASS(wxNotebook)
 };
 

-// ----------------------------------------------------------------------------
-// wxStdNotebookInputHandler: translates SPACE and ENTER keys and the left mouse
-// click into button press/release actions
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxStdNotebookInputHandler : public wxStdInputHandler
-{
-public:
-    wxStdNotebookInputHandler(wxInputHandler *inphand);
-
-    virtual bool HandleKey(wxControl *control,
-                           const wxKeyEvent& event,
-                           bool pressed);
-    virtual bool HandleMouse(wxControl *control,
-                             const wxMouseEvent& event);
-    virtual bool HandleMouseMove(wxControl *control, const wxMouseEvent& event);
-    virtual bool HandleFocus(wxControl *control, const wxFocusEvent& event);
-    virtual bool HandleActivation(wxControl *control, bool activated);
-
-protected:
-    void HandleFocusChange(wxControl *control);
-};
-

 #endif // _WX_UNIV_NOTEBOOK_H_
 
 #endif // _WX_UNIV_NOTEBOOK_H_