adjusted indentation with astyle; added Id keyword
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
@@ -9,26 +9,26 @@
|
||||
/**
|
||||
@class wxNotebookEvent
|
||||
@wxheader{notebook.h}
|
||||
|
||||
|
||||
This class represents the events generated by a notebook control: currently,
|
||||
there are two of them. The PAGE_CHANGING event is sent before the current
|
||||
page is changed. It allows the program to examine the current page (which
|
||||
can be retrieved with
|
||||
can be retrieved with
|
||||
wxNotebookEvent::GetOldSelection) and to veto the page
|
||||
change by calling wxNotifyEvent::Veto if, for example, the
|
||||
current values in the controls of the old page are invalid.
|
||||
|
||||
|
||||
The second event - PAGE_CHANGED - is sent after the page has been changed and
|
||||
the program cannot veto it any more, it just informs it about the page change.
|
||||
|
||||
|
||||
To summarize, if the program is interested in validating the page values
|
||||
before allowing the user to change it, it should process the PAGE_CHANGING
|
||||
event, otherwise PAGE_CHANGED is probably enough. In any case, it is probably
|
||||
unnecessary to process both events at once.
|
||||
|
||||
|
||||
@library{wxcore}
|
||||
@category{events}
|
||||
|
||||
|
||||
@seealso
|
||||
wxNotebook
|
||||
*/
|
||||
@@ -54,7 +54,7 @@ public:
|
||||
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
|
||||
for an event generated in response to a call to
|
||||
for an event generated in response to a call to
|
||||
wxNotebook::SetSelection shouldn't be trusted
|
||||
as they are currently inconsistent under different platforms (but in this case
|
||||
you presumably don't need them anyhow as you already have the corresponding
|
||||
@@ -77,18 +77,18 @@ public:
|
||||
/**
|
||||
@class wxNotebook
|
||||
@wxheader{notebook.h}
|
||||
|
||||
|
||||
This class represents a notebook control, which manages multiple windows with
|
||||
associated tabs.
|
||||
|
||||
|
||||
To use the class, create a wxNotebook object and call wxNotebook::AddPage or
|
||||
wxNotebook::InsertPage,
|
||||
passing a window to be used as the page. Do not explicitly delete the window
|
||||
for a page that is currently
|
||||
managed by wxNotebook.
|
||||
|
||||
|
||||
@b wxNotebookPage is a typedef for wxWindow.
|
||||
|
||||
|
||||
@beginStyleTable
|
||||
@style{wxNB_TOP}:
|
||||
Place tabs on the top side.
|
||||
@@ -108,10 +108,10 @@ public:
|
||||
@style{wxNB_FLAT}:
|
||||
(Windows CE only) Show tabs in a flat style.
|
||||
@endStyleTable
|
||||
|
||||
|
||||
@library{wxcore}
|
||||
@category{miscwnd}
|
||||
|
||||
|
||||
@seealso
|
||||
wxBookCtrl, wxNotebookEvent, wxImageList, @ref overview_samplenotebook
|
||||
"notebook sample"
|
||||
@@ -126,30 +126,30 @@ public:
|
||||
Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN
|
||||
window style.
|
||||
|
||||
@param parent
|
||||
@param parent
|
||||
The parent window. Must be non-@NULL.
|
||||
|
||||
@param id
|
||||
@param id
|
||||
The window identifier.
|
||||
|
||||
@param pos
|
||||
@param pos
|
||||
The window position.
|
||||
|
||||
@param size
|
||||
@param size
|
||||
The window size.
|
||||
|
||||
@param style
|
||||
@param style
|
||||
The window style. See wxNotebook.
|
||||
|
||||
@param name
|
||||
@param name
|
||||
The name of the control (used only under Motif).
|
||||
*/
|
||||
wxNotebook();
|
||||
wxNotebook(wxWindow* parent, wxWindowID id,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = 0,
|
||||
const wxString& name = wxNotebookNameStr);
|
||||
wxNotebook(wxWindow* parent, wxWindowID id,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = 0,
|
||||
const wxString& name = wxNotebookNameStr);
|
||||
//@}
|
||||
|
||||
/**
|
||||
@@ -162,16 +162,16 @@ public:
|
||||
|
||||
The call to this function may generate the page changing events.
|
||||
|
||||
@param page
|
||||
@param page
|
||||
Specifies the new page.
|
||||
|
||||
@param text
|
||||
@param text
|
||||
Specifies the text for the new page.
|
||||
|
||||
@param select
|
||||
@param select
|
||||
Specifies whether the page should be selected.
|
||||
|
||||
@param imageId
|
||||
@param imageId
|
||||
Specifies the optional image index for the new page.
|
||||
|
||||
@returns @true if successful, @false otherwise.
|
||||
@@ -291,10 +291,10 @@ public:
|
||||
if none. If @e flags parameter is non-@NULL, the position of the point
|
||||
inside the tab is returned as well.
|
||||
|
||||
@param pt
|
||||
@param pt
|
||||
Specifies the point for the hit test.
|
||||
|
||||
@param flags
|
||||
@param flags
|
||||
Return value for detailed information. One of the following values:
|
||||
|
||||
wxBK_HITTEST_NOWHERE
|
||||
@@ -331,19 +331,19 @@ public:
|
||||
/**
|
||||
Inserts a new page at the specified position.
|
||||
|
||||
@param index
|
||||
@param index
|
||||
Specifies the position for the new page.
|
||||
|
||||
@param page
|
||||
@param page
|
||||
Specifies the new page.
|
||||
|
||||
@param text
|
||||
@param text
|
||||
Specifies the text for the new page.
|
||||
|
||||
@param select
|
||||
@param select
|
||||
Specifies whether the page should be selected.
|
||||
|
||||
@param imageId
|
||||
@param imageId
|
||||
Specifies the optional image index for the new page.
|
||||
|
||||
@returns @true if successful, @false otherwise.
|
||||
|
||||
Reference in New Issue
Block a user