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 e63b172a3bd5143b71701cf78eff2a39e8bb60c4..bbc4250be93b22ad252dce4559396236db2b7df2 100644 (file)
--- a/include/wx/univ/notebook.h
+++ b/include/wx/univ/notebook.h
@@ -6,34 +6,30 @@
 // Created:     01.02.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 SciTech Software, Inc. (www.scitechsoft.com)
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_UNIV_NOTEBOOK_H_
 #define _WX_UNIV_NOTEBOOK_H_
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #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
-#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
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxNotebook : public wxNotebookBase
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
 {
 public:
     // ctors and such
@@ -46,7 +42,7 @@ public:
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
-               const wxString& name = wxNOTEBOOK_NAME)
+               const wxString& name = wxNotebookNameStr)
     {
         Init();
 
@@ -59,7 +55,7 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
-                const wxString& name = wxNOTEBOOK_NAME);
+                const wxString& name = wxNotebookNameStr);
 
     // dtor
     virtual ~wxNotebook();
@@ -67,8 +63,10 @@ public:
     // implement wxNotebookBase pure virtuals
     // --------------------------------------
 
-    virtual int SetSelection(size_t nPage);
-    virtual int GetSelection() const { return m_sel; }
+    virtual int SetSelection(size_t nPage) { return DoSetSelection(nPage, SetSelection_SendEvent); }
+
+    // changes selected page without sending events
+    int ChangeSelection(size_t nPage) { return DoSetSelection(nPage); }
 
     virtual bool SetPageText(size_t nPage, const wxString& strText);
     virtual wxString GetPageText(size_t nPage) const;
@@ -87,19 +85,19 @@ public:
     virtual bool InsertPage(size_t nPage,
                             wxNotebookPage *pPage,
                             const wxString& strText,
-                            bool bSelect = FALSE,
-                            int imageId = -1);
+                            bool bSelect = false,
+                            int imageId = NO_IMAGE);
 
     // style tests
     // -----------
 
-    // return TRUE if all tabs have the same width
+    // 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 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;
 
@@ -115,6 +113,12 @@ public:
                                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();
 
@@ -126,12 +130,13 @@ protected:
     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);
 
+    int DoSetSelection(size_t nPage, int flags = 0);
+
     // common part of all ctors
     void Init();
 
@@ -155,7 +160,7 @@ protected:
     void PositionSpinBtn();
 
     // refresh the given tab only
-    void RefreshTab(int page, bool forceSelected = FALSE);
+    void RefreshTab(int page, bool forceSelected = false);
 
     // refresh all tabs
     void RefreshAllTabs();
@@ -180,9 +185,9 @@ protected:
     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
-        { 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)
@@ -195,17 +200,14 @@ protected:
     wxSize GetSizeForPage(const wxSize& size) const;
 
     // 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
-    void ScrollLastTo(int page);
+    void ScrollLastTo(size_t page);
 
     // the pages titles
     wxArrayString m_titles;
 
-    // the current selection
-    size_t m_sel;
-
     // the spin button to change the pages
     wxSpinButton *m_spinbtn;
 
@@ -246,28 +248,5 @@ protected:
     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(wxInputConsumer *consumer,
-                           const wxKeyEvent& event,
-                           bool pressed);
-    virtual bool HandleMouse(wxInputConsumer *consumer,
-                             const wxMouseEvent& event);
-    virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
-    virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
-    virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
-
-protected:
-    void HandleFocusChange(wxInputConsumer *consumer);
-};
-
 #endif // _WX_UNIV_NOTEBOOK_H_