AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Ticket #9689 (new defect)

Browse Source 
Opened 33 hours ago
Documentation Corrections for \interface\wx\notebook.h

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54483 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling 2008-07-04 08:02:33 +00:00
parent 6ad68ad8c8
commit 90ae878ffc
1 changed files with 26 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
interface/wx/notebook.h
View File

@ -109,13 +109,18 @@ public:
@library{wxcore} @library{wxcore}
@category{miscwnd} @category{miscwnd}
@see wxBookCtrl(), wxNotebookEvent, wxImageList, @ref overview_samplenotebook @see wxBookCtrl(), wxNotebookEvent, wxImageList,
"notebook sample" @ref page_samples_notebook "Notebook Sample"
*/ */
class wxNotebook : public wxBookCtrl overview class wxNotebook : public wxBookCtrl overview
{ {
public: public:
//@{
/**
Constructs a notebook control.
*/
wxNotebook();
/** /**
Constructs a notebook control. Constructs a notebook control.
Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN
@ -134,13 +139,11 @@ public:
@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(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition, const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, const wxSize& size = wxDefaultSize,
long style = 0, long style = 0,
const wxString& name = wxNotebookNameStr); const wxString& name = wxNotebookNameStr);
//@}
/** /**
Destroys the wxNotebook object. Destroys the wxNotebook object.
@ -187,8 +190,9 @@ public:
/** /**
Changes the selection for the given page, returning the previous selection. Changes the selection for the given page, returning the previous selection.
The call to this function does not generate the page changing events. The call to this function does not generate the page changing events.
This is the only difference with SetSelection(). This is the only difference with SetSelection(). See
See @ref overview_progevent "this topic" for more info. @ref overview_eventhandling_prog "User Generated Events"
for more infomation.
*/ */
virtual int ChangeSelection(size_t page); virtual int ChangeSelection(size_t page);
@ -278,69 +282,22 @@ public:
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:
<TABLE><TR><TD>wxBK_HITTEST_NOWHERE</TD>
<TD>There was no tab under this point.</TD></TR>
<TR><TD>wxBK_HITTEST_ONICON</TD>
<TD>The point was over an icon (currently wxMSW only).</TD></TR>
<TR><TD>wxBK_HITTEST_ONLABEL</TD>
<TD>The point was over a label (currently wxMSW only).</TD></TR>
<TR><TD>wxBK_HITTEST_ONITEM</TD>
wxBK_HITTEST_NOWHERE <TD>The point was over an item, but not on the label or icon.</TD></TR>
<TR><TD>wxBK_HITTEST_ONPAGE</TD>
<TD>The point was over a currently selected page, not over any tab.
Note that this flag is present only if wxNOT_FOUND is returned.</TD></TR>
</TABLE>
There was no tab under this point. @return Returns the zero-based tab index or wxNOT_FOUND if there is no
tab at the specified position.
wxBK_HITTEST_ONICON
The point was over an icon (currently wxMSW only).
wxBK_HITTEST_ONLABEL
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.
@return Returns the zero-based tab index or wxNOT_FOUND if there is no
tab is at the specified position.
*/ */
virtual int HitTest(const wxPoint& pt, long* = NULL) const; virtual int HitTest(const wxPoint& pt, long* flags = NULL) const;
/** /**
Inserts a new page at the specified position. Inserts a new page at the specified position.