Removed docs for old clipboard functions, and reviewed/fixed atomic ops, file & direc...

[wxWidgets.git] / interface / notebook.h

diff --git a/interface/notebook.h b/interface/notebook.h
index a83726c0c034043c1a3ea10667b73b4e32b0d2d6..e9e5f480c7d7d6c98ae9a56d5c07349d5102d4b7 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
 {


@@ -38,18 +37,17 @@ public:
     /**
         Constructor (used internally by wxWidgets only).
     */
     /**
         Constructor (used internally by wxWidgets only).
     */

-    wxNotebookEvent(wxEventType eventType = wxEVT_@NULL, int id = 0,
+    wxNotebookEvent(wxEventType eventType = wxEVT_NULL, int id = 0,

                     int sel = -1,
                     int oldSel = -1);
 
     /**
         Returns the page that was selected before the change, -1 if none was selected.
     */
                     int sel = -1,
                     int oldSel = -1);
 
     /**
         Returns the page that was selected before the change, -1 if none was selected.
     */

-    int GetOldSelection();
+    int GetOldSelection() const;

 
     /**
         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
         GetOldSelection() when called from
         @c EVT_NOTEBOOK_PAGE_CHANGING handler and not the page which is going to
         @b NB: 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


@@ -60,7 +58,7 @@ public:
         you presumably don't need them anyhow as you already have the corresponding
         information).
     */
         you presumably don't need them anyhow as you already have the corresponding
         information).
     */

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

 
     /**
         Sets the id of the page selected before the change.
 
     /**
         Sets the id of the page selected before the change.


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

+

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


@@ -112,8 +111,7 @@ public:
     @library{wxcore}
     @category{miscwnd}
 
     @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


@@ -122,27 +120,21 @@ public:
     //@{
     /**
         Constructs a notebook control.
     //@{
     /**
         Constructs a notebook control.

-        

         Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN
         window style.
         
         @param parent
         Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN
         window style.
         
         @param parent

-        The parent window. Must be non-@NULL.
-        
+            The parent window. Must be non-@NULL.

         @param id
         @param id

-        The window identifier.
-        
+            The window identifier.

         @param pos
         @param pos

-        The window position.
-        
+            The window position.

         @param size
         @param size

-        The window size.
-        
+            The window size.

         @param style
         @param style

-        The window style. See wxNotebook.
-        
+            The window style. See wxNotebook.

         @param name
         @param name

-        The name of the control (used only under Motif).
+            The name of the control (used only under Motif).

     */
     wxNotebook();
     wxNotebook(wxWindow* parent, wxWindowID id,
     */
     wxNotebook();
     wxNotebook(wxWindow* parent, wxWindowID id,


@@ -159,49 +151,43 @@ public:
 
     /**
         Adds a new page.
 
     /**
         Adds a new page.

-        

         The call to this function may generate the page changing events.
         
         @param page
         The call to this function may generate the page changing events.
         
         @param page

-        Specifies the new page.
-        
+            Specifies the new page.

         @param text
         @param text

-        Specifies the text for the new page.
-        
+            Specifies the text for the new page.

         @param select
         @param select

-        Specifies whether the page should be selected.
-        
+            Specifies whether the page should be selected.

         @param imageId
         @param imageId

-        Specifies the optional image index for the new page.
+            Specifies the optional image index for the new page.

         
         @returns @true if successful, @false otherwise.
         
         @remarks Do not delete the page, it will be deleted by the notebook.
         
         
         @returns @true if successful, @false otherwise.
         
         @remarks Do not delete the page, it will be deleted by the notebook.
         

-        @sa InsertPage()
+        @see InsertPage()

     */
     bool AddPage(wxNotebookPage* page, const wxString& text,
     */
     bool AddPage(wxNotebookPage* page, const wxString& text,

-                 bool select = @false,
+                 bool select = false,

                  int imageId = -1);
 
     /**
         Cycles through the tabs.
                  int imageId = -1);
 
     /**
         Cycles through the tabs.

-        

         The call to this function generates the page changing events.
     */
         The call to this function generates the page changing events.
     */

-    void AdvanceSelection(bool forward = @true);
+    void AdvanceSelection(bool forward = true);

 
     /**
         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.
         

-        @sa wxImageList, SetImageList()
+        @see wxImageList, SetImageList()

     */
     void AssignImageList(wxImageList* imageList);
 
     /**
         Changes the selection for the given page, returning the previous selection.
     */
     void AssignImageList(wxImageList* imageList);
 
     /**
         Changes the selection for the given page, returning the previous selection.

-        

         The call to this function does not generate the page changing events.
         This is the only difference with SetSelection().
         See @ref overview_progevent "this topic" for more info.
         The call to this function does not generate the page changing events.
         This is the only difference with SetSelection().
         See @ref overview_progevent "this topic" for more info.


@@ -224,7 +210,6 @@ public:
 
     /**
         Deletes the specified page, and the associated window.
 
     /**
         Deletes the specified page, and the associated window.

-        

         The call to this function generates the page changing events.
     */
     bool DeletePage(size_t page);
         The call to this function generates the page changing events.
     */
     bool DeletePage(size_t page);


@@ -232,14 +217,14 @@ public:
     /**
         Returns the currently selected notebook page or @NULL.
     */
     /**
         Returns the currently selected notebook page or @NULL.
     */

-    wxWindow * GetCurrentPage();
+    wxWindow* GetCurrentPage() const;

 
     /**
         Returns the associated image list.
         
 
     /**
         Returns the associated image list.
         

-        @sa wxImageList, SetImageList()
+        @see wxImageList, SetImageList()

     */
     */

-    wxImageList* GetImageList();
+    wxImageList* GetImageList() const;

 
     /**
         Returns the window at the given page position.
 
     /**
         Returns the window at the given page position.


@@ -249,33 +234,32 @@ public:
     /**
         Returns the number of pages in the notebook control.
     */
     /**
         Returns the number of pages in the notebook control.
     */

-    size_t GetPageCount();
+    size_t GetPageCount() const;

 
     /**
         Returns the image index for the given page.
     */
 
     /**
         Returns the image index for the given page.
     */

-    int GetPageImage(size_t nPage);
+    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);
+    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();
+    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.

-        

         Note that this method may return either the previously or newly selected page
         when called from the @c EVT_NOTEBOOK_PAGE_CHANGED handler depending on
         the platform and so
         wxNotebookEvent::GetSelection should be
         used instead in this case.
     */
         Note that this method may return either the previously or newly selected page
         when called from the @c EVT_NOTEBOOK_PAGE_CHANGED handler depending on
         the platform and so
         wxNotebookEvent::GetSelection should be
         used instead in this case.
     */

-    int GetSelection();
+    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


@@ -284,83 +268,110 @@ 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();
+    wxColour GetThemeBackgroundColour() const;

 
     /**
         Returns the index of the tab at the specified position or @c wxNOT_FOUND
 
     /**
         Returns the index of the tab at the specified position or @c wxNOT_FOUND

-        if none. If @e flags parameter is non-@NULL, the position of the point
+        if none. If @a flags parameter is non-@NULL, the position of the point

         inside the tab is returned as well.
         
         @param pt
         inside the tab is returned as well.
         
         @param pt

-        Specifies the point for the hit test.
-        
+            Specifies the point for the hit test.

         @param flags
         @param flags

-        Return value for detailed information. One of the following values:
+            Return value for detailed information. One of the following values:
+        
+        
+        
+        
+        
+        
+        
+            wxBK_HITTEST_NOWHERE
+        
+        
+        
+        
+            There was no tab under this point.
+        

         
         

-        wxBK_HITTEST_NOWHERE

         
         
         
         

-        There was no tab under this point.

         
         

-        wxBK_HITTEST_ONICON
+            wxBK_HITTEST_ONICON

         
         
         
         

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

         
         

-        wxBK_HITTEST_ONLABEL

         
         

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

         
         

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

         
         

-        wxBK_HITTEST_ONITEM

         
         
         
         

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

         
         

-        wxBK_HITTEST_ONPAGE
+            wxBK_HITTEST_ONLABEL

         
         
         
         

-        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 label (currently wxMSW only).
+        
+        
+        
+        
+        
+            wxBK_HITTEST_ONITEM
+        
+        
+        
+        
+            The point was over an item, but not on the label or icon.
+        
+        
+        
+        
+        
+            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.

         
         @returns Returns the zero-based tab index or wxNOT_FOUND if there is no
         
         @returns 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);
+    int HitTest(const wxPoint& pt, long flags = NULL);

 
     /**
         Inserts a new page at the specified position.
         
         @param index
 
     /**
         Inserts a new page at the specified position.
         
         @param index

-        Specifies the position for the new page.
-        
+            Specifies the position for the new page.

         @param page
         @param page

-        Specifies the new page.
-        
+            Specifies the new page.

         @param text
         @param text

-        Specifies the text for the new page.
-        
+            Specifies the text for the new page.

         @param select
         @param select

-        Specifies whether the page should be selected.
-        
+            Specifies whether the page should be selected.

         @param imageId
         @param imageId

-        Specifies the optional image index for the new page.
+            Specifies the optional image index for the new page.

         
         @returns @true if successful, @false otherwise.
         
         @remarks Do not delete the page, it will be deleted by the notebook.
         
         
         @returns @true if successful, @false otherwise.
         
         @remarks Do not delete the page, it will be deleted by the notebook.
         

-        @sa AddPage()
+        @see AddPage()

     */
     bool InsertPage(size_t index, wxNotebookPage* page,
                     const wxString& text,
     */
     bool InsertPage(size_t index, wxNotebookPage* page,
                     const wxString& text,

-                    bool select = @false,
+                    bool select = false,

                     int imageId = -1);
 
     /**
         An event handler function, called when the page selection is changed.
         
                     int imageId = -1);
 
     /**
         An event handler function, called when the page selection is changed.
         

-        @sa wxNotebookEvent
+        @see wxNotebookEvent

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


@@ -373,26 +384,24 @@ 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.
         

-        @sa wxImageList, AssignImageList()
+        @see wxImageList, AssignImageList()

     */
     void SetImageList(wxImageList* imageList);
 
     /**
         Sets the amount of space around each page's icon and label, in pixels.
     */
     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.
     */
     void SetPadding(const wxSize& padding);
 
     /**
         @b NB: The vertical padding cannot be changed in wxGTK.
     */
     void SetPadding(const wxSize& padding);
 
     /**

-        Sets the image index for the given page. @e image is an index into
+        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);
 
     /**
         Sets the width and height of the pages.
         the image list which was set with SetImageList().
     */
     bool SetPageImage(size_t page, int image);
 
     /**
         Sets the width and height of the pages.

-        

         @b NB: This method is currently not implemented for wxGTK.
     */
     void SetPageSize(const wxSize& size);
         @b NB: This method is currently not implemented for wxGTK.
     */
     void SetPageSize(const wxSize& size);


@@ -404,13 +413,12 @@ public:
 
     /**
         Sets the selection for the given page, returning the previous selection.
 
     /**
         Sets the selection for the given page, returning the previous selection.

-        

         The call to this function generates the page changing events.
         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.
         
         This function is deprecated and should not be used in new code. Please use the
         ChangeSelection() function instead.
         

-        @sa GetSelection()
+        @see GetSelection()

     */
     int SetSelection(size_t page);
 };
     */
     int SetSelection(size_t page);
 };

+