wxAuiNotebookEvent Class Reference

#include <wx/aui/auibook.h>

Inheritance diagram for wxAuiNotebookEvent:

Detailed Description

This class is used by the events generated by wxAuiNotebook.

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxAuiNotebookEvent& event)

Event macros for events emitted by this class:

• EVT_AUINOTEBOOK_PAGE_CLOSE(id, func):
  A page is about to be closed. Processes a wxEVT_AUINOTEBOOK_PAGE_CLOSE event.
• EVT_AUINOTEBOOK_PAGE_CLOSED(winid, fn):
  A page has been closed. Processes a wxEVT_AUINOTEBOOK_PAGE_CLOSED event.
• EVT_AUINOTEBOOK_PAGE_CHANGED(id, func):
  The page selection was changed. Processes a wxEVT_AUINOTEBOOK_PAGE_CHANGED event.
• EVT_AUINOTEBOOK_PAGE_CHANGING(id, func):
  The page selection is about to be changed. Processes a wxEVT_AUINOTEBOOK_PAGE_CHANGING event. This event can be vetoed.
• EVT_AUINOTEBOOK_BUTTON(id, func):
  The window list button has been pressed. Processes a wxEVT_AUINOTEBOOK_BUTTON event.
• EVT_AUINOTEBOOK_BEGIN_DRAG(id, func):
  Dragging is about to begin. Processes a wxEVT_AUINOTEBOOK_BEGIN_DRAG event.
• EVT_AUINOTEBOOK_END_DRAG(id, func):
  Dragging has ended. Processes a wxEVT_AUINOTEBOOK_END_DRAG event.
• EVT_AUINOTEBOOK_DRAG_MOTION(id, func):
  Emitted during a drag and drop operation. Processes a wxEVT_AUINOTEBOOK_DRAG_MOTION event.
• EVT_AUINOTEBOOK_ALLOW_DND(id, func):
  Whether to allow a tab to be dropped. Processes a wxEVT_AUINOTEBOOK_ALLOW_DND event. This event must be specially allowed.
• EVT_AUINOTEBOOK_DRAG_DONE(winid, fn):
  Notify that the tab has been dragged. Processes a wxEVT_AUINOTEBOOK_DRAG_DONE event.
• EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN(winid, fn):
  The middle mouse button is pressed on a tab. Processes a wxEVT_AUINOTEBOOK_TAB_MIDDLE_DOWN event.
• EVT_AUINOTEBOOK_TAB_MIDDLE_UP(winid, fn):
  The middle mouse button is released on a tab. Processes a wxEVT_AUINOTEBOOK_TAB_MIDDLE_UP event.
• EVT_AUINOTEBOOK_TAB_RIGHT_DOWN(winid, fn):
  The right mouse button is pressed on a tab. Processes a wxEVT_AUINOTEBOOK_TAB_RIGHT_DOWN event.
• EVT_AUINOTEBOOK_TAB_RIGHT_UP(winid, fn):
  The right mouse button is released on a tab. Processes a wxEVT_AUINOTEBOOK_TAB_RIGHT_UP event.
• EVT_AUINOTEBOOK_BG_DCLICK(winid, fn):
  Double clicked on the tabs background area. Processes a wxEVT_AUINOTEBOOK_BG_DCLICK event.

Library:  wxAui

Category:  Events, Book Controls

See Also

wxAuiNotebook, wxBookCtrlEvent

Public Member Functions
	wxAuiNotebookEvent (wxEventType command_type=wxEVT_NULL, int win_id=0)
	Constructor.
wxEvent *	Clone ()
Public Member Functions inherited from wxBookCtrlEvent
	wxBookCtrlEvent (wxEventType eventType=wxEVT_NULL, int id=0, int sel=wxNOT_FOUND, int oldSel=wxNOT_FOUND)
	Constructor (used internally by wxWidgets only).
int	GetOldSelection () const
	Returns the page that was selected before the change, wxNOT_FOUND if none was selected.
int	GetSelection () const
	Returns the currently selected page, or wxNOT_FOUND if none was selected.
void	SetOldSelection (int page)
	Sets the id of the page selected before the change.
void	SetSelection (int page)
	Sets the selection member variable.
Public Member Functions inherited from wxNotifyEvent
	wxNotifyEvent (wxEventType eventType=wxEVT_NULL, int id=0)
	Constructor (used internally by wxWidgets only).
void	Allow ()
	This is the opposite of Veto(): it explicitly allows the event to be processed.
bool	IsAllowed () const
	Returns true if the change is allowed (Veto() hasn't been called) or false otherwise (if it was).
void	Veto ()
	Prevents the change announced by this event from happening.
Public Member Functions inherited from wxCommandEvent
	wxCommandEvent (wxEventType commandEventType=wxEVT_NULL, int id=0)
	Constructor.
void *	GetClientData () const
	Returns client data pointer for a listbox or choice selection event (not valid for a deselection).
wxClientData *	GetClientObject () const
	Returns client object pointer for a listbox or choice selection event (not valid for a deselection).
long	GetExtraLong () const
	Returns extra information dependent on the event objects type.
int	GetInt () const
	Returns the integer identifier corresponding to a listbox, choice or radiobox selection (only if the event was a selection, not a deselection), or a boolean value representing the value of a checkbox.
int	GetSelection () const
	Returns item index for a listbox or choice selection event (not valid for a deselection).
wxString	GetString () const
	Returns item string for a listbox or choice selection event.
bool	IsChecked () const
	This method can be used with checkbox and menu events: for the checkboxes, the method returns true for a selection event and false for a deselection one.
bool	IsSelection () const
	For a listbox or similar event, returns true if it is a selection, false if it is a deselection.
void	SetClientData (void *clientData)
	Sets the client data for this event.
void	SetClientObject (wxClientData *clientObject)
	Sets the client object for this event.
void	SetExtraLong (long extraLong)
	Sets the m_extraLong member.
void	SetInt (int intCommand)
	Sets the m_commandInt member.
void	SetString (const wxString &string)
	Sets the m_commandString member.
Public Member Functions inherited from wxEvent
	wxEvent (int id=0, wxEventType eventType=wxEVT_NULL)
	Constructor.
virtual wxEvent *	Clone () const =0
	Returns a copy of the event.
wxObject *	GetEventObject () const
	Returns the object (usually a window) associated with the event, if any.
wxEventType	GetEventType () const
	Returns the identifier of the given event type, such as wxEVT_BUTTON.
virtual wxEventCategory	GetEventCategory () const
	Returns a generic category for this event.
int	GetId () const
	Returns the identifier associated with this event, such as a button command id.
wxObject *	GetEventUserData () const
	Return the user data associated with a dynamically connected event handler.
bool	GetSkipped () const
	Returns true if the event handler should be skipped, false otherwise.
long	GetTimestamp () const
	Gets the timestamp for the event.
bool	IsCommandEvent () const
	Returns true if the event is or is derived from wxCommandEvent else it returns false.
void	ResumePropagation (int propagationLevel)
	Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation).
void	SetEventObject (wxObject *object)
	Sets the originating object.
void	SetEventType (wxEventType type)
	Sets the event type.
void	SetId (int id)
	Sets the identifier associated with this event, such as a button command id.
void	SetTimestamp (long timeStamp=0)
	Sets the timestamp for the event.
bool	ShouldPropagate () const
	Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.
void	Skip (bool skip=true)
	This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns.
int	StopPropagation ()
	Stop the event from propagating to its parent window.
Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data.
	wxObject (const wxObject &other)
	Copy ctor.
virtual	~wxObject ()
	Destructor.
virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.
bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.
void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.
void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.
void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.
void	UnShare ()
	This is the same of AllocExclusive() but this method is public.
void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.
void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.

Additional Inherited Members
Protected Member Functions inherited from wxObject
void	AllocExclusive ()
	Ensure that this object's data is not shared with any other object.
virtual wxObjectRefData *	CreateRefData () const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.
virtual wxObjectRefData *	CloneRefData (const wxObjectRefData *data) const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.
Protected Attributes inherited from wxEvent
int	m_propagationLevel
	Indicates how many levels the event can propagate.

Constructor & Destructor Documentation

wxAuiNotebookEvent::wxAuiNotebookEvent	(	wxEventType	command_type = wxEVT_NULL,
		int	win_id = 0
	)

Constructor.

Member Function Documentation

wxEvent* wxAuiNotebookEvent::Clone

(

)