Correct wxString:Append docs

[wxWidgets.git] / interface / notebook.h

diff --git a/interface/notebook.h b/interface/notebook.h
index 7c0e03bc6ca9a2879810befada6bf8b17e56716a..807e42c1db849b4ad55628abeb0a51bad6b82ee4 100644 (file)
--- a/interface/notebook.h
+++ b/interface/notebook.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        notebook.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        notebook.h

-// Purpose:     documentation for wxNotebookEvent class
+// Purpose:     interface of wxNotebookEvent

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -29,8 +29,7 @@
     @library{wxcore}
     @category{events}
 
     @library{wxcore}
     @category{events}
 

-    @seealso
-    wxNotebook
+    @see wxNotebook

 */
 class wxNotebookEvent : public wxNotifyEvent
 {
 */
 class wxNotebookEvent : public wxNotifyEvent
 {


@@ -49,7 +48,7 @@ public:
 
     /**
         Returns the currently selected page, or -1 if none was selected.
 
     /**
         Returns the currently selected page, or -1 if none was selected.

-        @b NB: under Windows, GetSelection() will return the same value as
+        @note under Windows, GetSelection() will return the same value as

         GetOldSelection() when called from
         @c EVT_NOTEBOOK_PAGE_CHANGING handler and not the page which is going to
         be selected. Also note that the values of selection and old selection returned
         GetOldSelection() when called from
         @c EVT_NOTEBOOK_PAGE_CHANGING handler and not the page which is going to
         be selected. Also note that the values of selection and old selection returned


@@ -73,6 +72,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxNotebook
     @wxheader{notebook.h}
 /**
     @class wxNotebook
     @wxheader{notebook.h}


@@ -89,30 +89,29 @@ public:
     @b wxNotebookPage is a typedef for wxWindow.
 
     @beginStyleTable
     @b wxNotebookPage is a typedef for wxWindow.
 
     @beginStyleTable

-    @style{wxNB_TOP}:
+    @style{wxNB_TOP}

            Place tabs on the top side.
            Place tabs on the top side.

-    @style{wxNB_LEFT}:
+    @style{wxNB_LEFT}

            Place tabs on the left side.
            Place tabs on the left side.

-    @style{wxNB_RIGHT}:
+    @style{wxNB_RIGHT}

            Place tabs on the right side.
            Place tabs on the right side.

-    @style{wxNB_BOTTOM}:
+    @style{wxNB_BOTTOM}

            Place tabs under instead of above the notebook pages.
            Place tabs under instead of above the notebook pages.

-    @style{wxNB_FIXEDWIDTH}:
+    @style{wxNB_FIXEDWIDTH}

            (Windows only) All tabs will have same width.
            (Windows only) All tabs will have same width.

-    @style{wxNB_MULTILINE}:
+    @style{wxNB_MULTILINE}

            (Windows only) There can be several rows of tabs.
            (Windows only) There can be several rows of tabs.

-    @style{wxNB_NOPAGETHEME}:
+    @style{wxNB_NOPAGETHEME}

            (Windows only) Display a solid colour on notebook pages, and not a
            gradient, which can reduce performance.
            (Windows only) Display a solid colour on notebook pages, and not a
            gradient, which can reduce performance.

-    @style{wxNB_FLAT}:
+    @style{wxNB_FLAT}

            (Windows CE only) Show tabs in a flat style.
     @endStyleTable
 
     @library{wxcore}
     @category{miscwnd}
 
            (Windows CE only) Show tabs in a flat style.
     @endStyleTable
 
     @library{wxcore}
     @category{miscwnd}
 

-    @seealso
-    wxBookCtrl, wxNotebookEvent, wxImageList, @ref overview_samplenotebook
+    @see wxBookCtrl(), wxNotebookEvent, wxImageList, @ref overview_samplenotebook

     "notebook sample"
 */
 class wxNotebook : public wxBookCtrl overview
     "notebook sample"
 */
 class wxNotebook : public wxBookCtrl overview


@@ -123,7 +122,7 @@ public:
         Constructs a notebook control.
         Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN
         window style.
         Constructs a notebook control.
         Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN
         window style.

-        
+

         @param parent
             The parent window. Must be non-@NULL.
         @param id
         @param parent
             The parent window. Must be non-@NULL.
         @param id


@@ -148,12 +147,12 @@ public:
     /**
         Destroys the wxNotebook object.
     */
     /**
         Destroys the wxNotebook object.
     */

-    ~wxNotebook();
+    virtual ~wxNotebook();

 
     /**
         Adds a new page.
         The call to this function may generate the page changing events.
 
     /**
         Adds a new page.
         The call to this function may generate the page changing events.

-        
+

         @param page
             Specifies the new page.
         @param text
         @param page
             Specifies the new page.
         @param text


@@ -162,11 +161,11 @@ public:
             Specifies whether the page should be selected.
         @param imageId
             Specifies the optional image index for the new page.
             Specifies whether the page should be selected.
         @param imageId
             Specifies the optional image index for the new page.

-        
-        @returns @true if successful, @false otherwise.
-        
+
+        @return @true if successful, @false otherwise.
+

         @remarks Do not delete the page, it will be deleted by the notebook.
         @remarks Do not delete the page, it will be deleted by the notebook.

-        
+

         @see InsertPage()
     */
     bool AddPage(wxNotebookPage* page, const wxString& text,
         @see InsertPage()
     */
     bool AddPage(wxNotebookPage* page, const wxString& text,


@@ -182,7 +181,7 @@ public:
     /**
         Sets the image list for the page control and takes ownership of
         the list.
     /**
         Sets the image list for the page control and takes ownership of
         the list.

-        
+

         @see wxImageList, SetImageList()
     */
     void AssignImageList(wxImageList* imageList);
         @see wxImageList, SetImageList()
     */
     void AssignImageList(wxImageList* imageList);


@@ -193,7 +192,7 @@ public:
         This is the only difference with SetSelection().
         See @ref overview_progevent "this topic" for more info.
     */
         This is the only difference with SetSelection().
         See @ref overview_progevent "this topic" for more info.
     */

-    int ChangeSelection(size_t page);
+    virtual int ChangeSelection(size_t page);

 
     /**
         Creates a notebook control. See wxNotebook() for a description
 
     /**
         Creates a notebook control. See wxNotebook() for a description


@@ -201,13 +200,14 @@ public:
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,

-                const wxSize& size, long style = 0,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,

                 const wxString& name = wxNotebookNameStr);
 
     /**
         Deletes all pages.
     */
                 const wxString& name = wxNotebookNameStr);
 
     /**
         Deletes all pages.
     */

-    bool DeleteAllPages();
+    virtual bool DeleteAllPages();

 
     /**
         Deletes the specified page, and the associated window.
 
     /**
         Deletes the specified page, and the associated window.


@@ -222,7 +222,7 @@ public:
 
     /**
         Returns the associated image list.
 
     /**
         Returns the associated image list.

-        
+

         @see wxImageList, SetImageList()
     */
     wxImageList* GetImageList() const;
         @see wxImageList, SetImageList()
     */
     wxImageList* GetImageList() const;


@@ -240,17 +240,17 @@ public:
     /**
         Returns the image index for the given page.
     */
     /**
         Returns the image index for the given page.
     */

-    int GetPageImage(size_t nPage) const;
+    virtual int GetPageImage(size_t nPage) const;

 
     /**
         Returns the string for the given page.
     */
 
     /**
         Returns the string for the given page.
     */

-    wxString GetPageText(size_t nPage) const;
+    virtual wxString GetPageText(size_t nPage) const;

 
     /**
         Returns the number of rows in the notebook control.
     */
 
     /**
         Returns the number of rows in the notebook control.
     */

-    int GetRowCount() const;
+    virtual int GetRowCount() const;

 
     /**
         Returns the currently selected page, or -1 if none was selected.
 
     /**
         Returns the currently selected page, or -1 if none was selected.


@@ -260,7 +260,7 @@ public:
         wxNotebookEvent::GetSelection should be
         used instead in this case.
     */
         wxNotebookEvent::GetSelection should be
         used instead in this case.
     */

-    int GetSelection() const;
+    virtual int GetSelection() const;

 
     /**
         If running under Windows and themes are enabled for the application, this
 
     /**
         If running under Windows and themes are enabled for the application, this


@@ -269,84 +269,84 @@ public:
         can be passed
         to @c SetBackgroundColour. Otherwise, an uninitialised colour will be returned.
     */
         can be passed
         to @c SetBackgroundColour. Otherwise, an uninitialised colour will be returned.
     */

-    wxColour GetThemeBackgroundColour() const;
+    virtual wxColour GetThemeBackgroundColour() const;

 
     /**
         Returns the index of the tab at the specified position or @c wxNOT_FOUND
         if none. If @a flags parameter is non-@NULL, the position of the point
         inside the tab is returned as well.
 
     /**
         Returns the index of the tab at the specified position or @c wxNOT_FOUND
         if none. If @a flags parameter is non-@NULL, the position of the point
         inside the tab is returned as well.

-        
+

         @param pt
             Specifies the point for the hit test.
         @param flags
             Return value for detailed information. One of the following values:
         @param pt
             Specifies the point for the hit test.
         @param flags
             Return value for detailed information. One of the following values:

-        
-        
-        
-        
-        
-        
-        
+
+
+
+
+
+
+

             wxBK_HITTEST_NOWHERE
             wxBK_HITTEST_NOWHERE

-        
-        
-        
-        
+
+
+
+

             There was no tab under this point.
             There was no tab under this point.

-        
-        
-        
-        
-        
+
+
+
+
+

             wxBK_HITTEST_ONICON
             wxBK_HITTEST_ONICON

-        
-        
-        
-        
+
+
+
+

             The point was over an icon (currently wxMSW only).
             The point was over an icon (currently wxMSW only).

-        
-        
-        
-        
-        
+
+
+
+
+

             wxBK_HITTEST_ONLABEL
             wxBK_HITTEST_ONLABEL

-        
-        
-        
-        
+
+
+
+

             The point was over a label (currently wxMSW only).
             The point was over a label (currently wxMSW only).

-        
-        
-        
-        
-        
+
+
+
+
+

             wxBK_HITTEST_ONITEM
             wxBK_HITTEST_ONITEM

-        
-        
-        
-        
+
+
+
+

             The point was over an item, but not on the label or icon.
             The point was over an item, but not on the label or icon.

-        
-        
-        
-        
-        
+
+
+
+
+

             wxBK_HITTEST_ONPAGE
             wxBK_HITTEST_ONPAGE

-        
-        
-        
-        
+
+
+
+

             The point was over a currently selected page, not over any tab. Note that
         this flag is present only if wxNOT_FOUND is returned.
             The point was over a currently selected page, not over any tab. Note that
         this flag is present only if wxNOT_FOUND is returned.

-        
-        @returns Returns the zero-based tab index or wxNOT_FOUND if there is no
+
+        @return Returns the zero-based tab index or wxNOT_FOUND if there is no

                  tab is at the specified position.
     */
                  tab is at the specified position.
     */

-    int HitTest(const wxPoint& pt, long flags = NULL);
+    virtual int HitTest(const wxPoint& pt, long* = NULL) const;

 
     /**
         Inserts a new page at the specified position.
 
     /**
         Inserts a new page at the specified position.

-        
+

         @param index
             Specifies the position for the new page.
         @param page
         @param index
             Specifies the position for the new page.
         @param page


@@ -357,11 +357,11 @@ public:
             Specifies whether the page should be selected.
         @param imageId
             Specifies the optional image index for the new page.
             Specifies whether the page should be selected.
         @param imageId
             Specifies the optional image index for the new page.

-        
-        @returns @true if successful, @false otherwise.
-        
+
+        @return @true if successful, @false otherwise.
+

         @remarks Do not delete the page, it will be deleted by the notebook.
         @remarks Do not delete the page, it will be deleted by the notebook.

-        
+

         @see AddPage()
     */
     bool InsertPage(size_t index, wxNotebookPage* page,
         @see AddPage()
     */
     bool InsertPage(size_t index, wxNotebookPage* page,


@@ -371,7 +371,7 @@ public:
 
     /**
         An event handler function, called when the page selection is changed.
 
     /**
         An event handler function, called when the page selection is changed.

-        
+

         @see wxNotebookEvent
     */
     void OnSelChange(wxNotebookEvent& event);
         @see wxNotebookEvent
     */
     void OnSelChange(wxNotebookEvent& event);


@@ -384,14 +384,14 @@ public:
     /**
         Sets the image list for the page control. It does not take
         ownership of the image list, you must delete it yourself.
     /**
         Sets the image list for the page control. It does not take
         ownership of the image list, you must delete it yourself.

-        
+

         @see wxImageList, AssignImageList()
     */
     void SetImageList(wxImageList* imageList);
 
     /**
         Sets the amount of space around each page's icon and label, in pixels.
         @see wxImageList, AssignImageList()
     */
     void SetImageList(wxImageList* imageList);
 
     /**
         Sets the amount of space around each page's icon and label, in pixels.

-        @b NB: The vertical padding cannot be changed in wxGTK.
+        @note The vertical padding cannot be changed in wxGTK.

     */
     void SetPadding(const wxSize& padding);
 
     */
     void SetPadding(const wxSize& padding);
 


@@ -399,26 +399,27 @@ public:
         Sets the image index for the given page. @a image is an index into
         the image list which was set with SetImageList().
     */
         Sets the image index for the given page. @a image is an index into
         the image list which was set with SetImageList().
     */

-    bool SetPageImage(size_t page, int image);
+    virtual bool SetPageImage(size_t page, int image);

 
     /**
         Sets the width and height of the pages.
 
     /**
         Sets the width and height of the pages.

-        @b NB: This method is currently not implemented for wxGTK.
+        @note This method is currently not implemented for wxGTK.

     */
     */

-    void SetPageSize(const wxSize& size);
+    virtual void SetPageSize(const wxSize& size);

 
     /**
         Sets the text for the given page.
     */
 
     /**
         Sets the text for the given page.
     */

-    bool SetPageText(size_t page, const wxString& text);
+    virtual bool SetPageText(size_t page, const wxString& text);

 
     /**
         Sets the selection for the given page, returning the previous selection.
         The call to this function generates the page changing events.
         This function is deprecated and should not be used in new code. Please use the
         ChangeSelection() function instead.
 
     /**
         Sets the selection for the given page, returning the previous selection.
         The call to this function generates the page changing events.
         This function is deprecated and should not be used in new code. Please use the
         ChangeSelection() function instead.

-        
+

         @see GetSelection()
     */
         @see GetSelection()
     */

-    int SetSelection(size_t page);
+    virtual int SetSelection(size_t page);

 };
 };

+