wxNotebookEvent Class Reference
[Events]

#include <wx/notebook.h>

Inheritance diagram for wxNotebookEvent:

List of all members.

---

Detailed Description

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 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

See also:

wxNotebook

Public Member Functions
	wxNotebookEvent (wxEventType eventType=wxEVT_NULL, int id=0, int sel=-1, int oldSel=-1)
int	GetOldSelection () const
int	GetSelection () const
void	SetOldSelection (int page)
void	SetSelection (int page)

---

Constructor & Destructor Documentation

wxNotebookEvent::wxNotebookEvent	(	wxEventType	eventType = wxEVT_NULL,
		int	id = 0,
		int	sel = -1,
		int	oldSel = -1
	)

Constructor (used internally by wxWidgets only).

---

Member Function Documentation

int wxNotebookEvent::GetOldSelection

(

)

const

Returns the page that was selected before the change, -1 if none was selected.

int wxNotebookEvent::GetSelection

(

)

const

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

Note:

under Windows, GetSelection() will return the same value as GetOldSelection() when called from 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 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 information).

Reimplemented from wxCommandEvent.

void wxNotebookEvent::SetOldSelection

(

int

page

)

Sets the id of the page selected before the change.

void wxNotebookEvent::SetSelection

(

int

page

)

Sets the selection member variable.