#include <wx/aui/auibook.h>

Inheritance diagram for wxAuiNotebook:

Detailed Description

wxAuiNotebook is part of the wxAUI class framework, which represents a notebook control, managing multiple windows with associated tabs.

Styles

This class supports the following styles:

wxAUI_NB_DEFAULT_STYLE:
Defined as wxAUI_NB_TOP | wxAUI_NB_TAB_SPLIT | wxAUI_NB_TAB_MOVE | wxAUI_NB_SCROLL_BUTTONS | wxAUI_NB_CLOSE_ON_ACTIVE_TAB | wxAUI_NB_MIDDLE_CLICK_CLOSE.
wxAUI_NB_TAB_SPLIT:
Allows the tab control to be split by dragging a tab.
wxAUI_NB_TAB_MOVE:
Allows a tab to be moved horizontally by dragging.
wxAUI_NB_TAB_EXTERNAL_MOVE:
Allows a tab to be moved to another tab control.
wxAUI_NB_TAB_FIXED_WIDTH:
With this style, all tabs have the same width.
wxAUI_NB_SCROLL_BUTTONS:
With this style, left and right scroll buttons are displayed.
wxAUI_NB_WINDOWLIST_BUTTON:
With this style, a drop-down list of windows is available.
wxAUI_NB_CLOSE_BUTTON:
With this style, a close button is available on the tab bar.
wxAUI_NB_CLOSE_ON_ACTIVE_TAB:
With this style, the close button is visible on the active tab.
wxAUI_NB_CLOSE_ON_ALL_TABS:
With this style, the close button is visible on all tabs.
wxAUI_NB_MIDDLE_CLICK_CLOSE:
With this style, middle click on a tab closes the tab.
wxAUI_NB_TOP:
With this style, tabs are drawn along the top of the notebook.
wxAUI_NB_BOTTOM:
With this style, tabs are drawn along the bottom of the notebook.

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: Window Docking (wxAUI)

Public Member Functions
	wxAuiNotebook ()
	Default ctor.

	wxAuiNotebook (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxAUI_NB_DEFAULT_STYLE)
	Constructor.

bool	AddPage (wxWindow *page, const wxString &caption, bool select=false, const wxBitmap &bitmap=wxNullBitmap)
	Adds a page.

virtual bool	AddPage (wxWindow *page, const wxString &text, bool select, int imageId)
	Adds a new page.

void	AdvanceSelection (bool forward=true)
	Sets the selection to the next or previous page.

virtual int	ChangeSelection (size_t n)
	Changes the selection for the given page, returning the previous selection.

bool	Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0)
	Creates the notebook window.

virtual bool	DeleteAllPages ()
	Deletes all pages.

bool	DeletePage (size_t page)
	Deletes a page at the given index.

wxAuiTabArt *	GetArtProvider () const
	Returns the associated art provider.

wxWindow *	GetCurrentPage () const
	Returns the currently selected page or NULL.

int	GetHeightForPageHeight (int pageHeight)
	Returns the desired height of the notebook for the given page height.

wxWindow *	GetPage (size_t page_idx) const
	Returns the page specified by the given index.

wxBitmap	GetPageBitmap (size_t page) const
	Returns the tab bitmap for the page.

size_t	GetPageCount () const
	Returns the number of pages in the notebook.

int	GetPageIndex (wxWindow *page_wnd) const
	Returns the page index for the specified window.

wxString	GetPageText (size_t page) const
	Returns the tab label for the page.

wxString	GetPageToolTip (size_t pageIdx) const
	Returns the tooltip for the tab label of the page.

int	GetSelection () const
	Returns the currently selected page.

int	GetTabCtrlHeight () const
	Returns the height of the tab control.

bool	InsertPage (size_t page_idx, wxWindow *page, const wxString &caption, bool select=false, const wxBitmap &bitmap=wxNullBitmap)
	InsertPage() is similar to AddPage, but allows the ability to specify the insert location.

virtual bool	InsertPage (size_t index, wxWindow *page, const wxString &text, bool select=false, int imageId=NO_IMAGE)
	Inserts a new page at the specified position.

bool	RemovePage (size_t page)
	Removes a page, without deleting the window pointer.

void	SetArtProvider (wxAuiTabArt *art)
	Sets the art provider to be used by the notebook.

virtual bool	SetFont (const wxFont &font)
	Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.

void	SetMeasuringFont (const wxFont &font)
	Sets the font for measuring tab labels.

void	SetNormalFont (const wxFont &font)
	Sets the font for drawing unselected tab labels.

bool	SetPageBitmap (size_t page, const wxBitmap &bitmap)
	Sets the bitmap for the page.

virtual bool	SetPageImage (size_t n, int imageId)
	Sets the image index for the given page.

bool	SetPageText (size_t page, const wxString &text)
	Sets the tab label for the page.

bool	SetPageToolTip (size_t page, const wxString &text)
	Sets the tooltip displayed when hovering over the tab label of the page.

void	SetSelectedFont (const wxFont &font)
	Sets the font for drawing selected tab labels.

size_t	SetSelection (size_t new_page)
	Sets the page selection.

virtual void	SetTabCtrlHeight (int height)
	Sets the tab height.

bool	ShowWindowMenu ()
	Shows the window menu for the active tab control associated with this notebook, and returns true if a selection was made.


virtual void	SetUniformBitmapSize (const wxSize &size)
	Split performs a split operation programmatically.

virtual void	Split (size_t page, int direction)
	Split performs a split operation programmatically.

Public Member Functions inherited from wxBookCtrlBase
	wxBookCtrlBase ()
	Default ctor.

	wxBookCtrlBase (wxWindow *parent, wxWindowID winid, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxEmptyString)
	Constructs the book control with the given parameters.

bool	Create (wxWindow *parent, wxWindowID winid, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxEmptyString)
	Constructs the book control with the given parameters.

virtual void	SetPageSize (const wxSize &size)
	Sets the width and height of the pages.

virtual int	HitTest (const wxPoint &pt, long *flags=NULL) const
	Returns the index of the tab at the specified position or `wxNOT_FOUND` if none.

virtual int	GetPageImage (size_t nPage) const =0
	Returns the image index for the given page.

wxWindow *	GetCurrentPage () const
	Returns the currently selected page or NULL.

void	AdvanceSelection (bool forward=true)
	Cycles through the tabs.

int	FindPage (const wxWindow *page) const
	Returns the index of the specified tab window or `wxNOT_FOUND` if not found.

wxWindow *	GetPage (size_t page) const
	Returns the window at the given page position.

Public Member Functions inherited from wxControl
	wxControl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)
	Constructs a control.

	wxControl ()
	Default constructor to allow 2-phase creation.

bool	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr)

virtual void	Command (wxCommandEvent &event)
	Simulates the effect of the user issuing a command to the item.

wxString	GetLabel () const
	Returns the control's label, as it was passed to SetLabel().

wxString	GetLabelText () const
	Returns the control's label without mnemonics.

wxSize	GetSizeFromTextSize (int xlen, int ylen=-1) const
	Determine the size needed by the control to leave the given area for its text.

wxSize	GetSizeFromTextSize (const wxSize &tsize) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetLabel (const wxString &label)
	Sets the control's label.

void	SetLabelText (const wxString &text)
	Sets the control's label to exactly the given string.

bool	SetLabelMarkup (const wxString &markup)
	Sets the controls label to a string using markup.

Public Member Functions inherited from wxWindow
	wxWindow ()
	Default constructor.

	wxWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)
	Constructs a window, which can be a child of a frame, dialog or any other non-control window.

virtual	~wxWindow ()
	Destructor.

bool	Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr)

virtual bool	AcceptsFocus () const
	This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. wxStaticText) and so doesn't need focus.

virtual bool	AcceptsFocusFromKeyboard () const
	This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard.

virtual bool	AcceptsFocusRecursively () const
	Overridden to indicate whether this window or one of its children accepts focus.

bool	IsFocusable () const
	Can this window itself have focus?

bool	CanAcceptFocus () const
	Can this window have focus right now?

bool	CanAcceptFocusFromKeyboard () const
	Can this window be assigned focus from keyboard right now?

virtual bool	HasFocus () const
	Returns true if the window (or in case of composite controls, its main child window) has focus.

virtual void	SetCanFocus (bool canFocus)
	This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).

virtual void	SetFocus ()
	This sets the window to receive keyboard input.

virtual void	SetFocusFromKbd ()
	This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g.

virtual void	AddChild (wxWindow *child)
	Adds a child window.

bool	DestroyChildren ()
	Destroys all children of a window.

wxWindow *	FindWindow (long id) const
	Find a child of this window, by id.

wxWindow *	FindWindow (const wxString &name) const
	Find a child of this window, by name.

wxWindowList &	GetChildren ()
	Returns a reference to the list of the window's children.

const wxWindowList &	GetChildren () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual void	RemoveChild (wxWindow *child)
	Removes a child window.

wxWindow *	GetGrandParent () const
	Returns the grandparent of a window, or NULL if there isn't one.

wxWindow *	GetNextSibling () const
	Returns the next window after this one among the parent's children or NULL if this window is the last child.

wxWindow *	GetParent () const
	Returns the parent of the window, or NULL if there is no parent.

wxWindow *	GetPrevSibling () const
	Returns the previous window before this one among the parent's children or NULL if this window is the first child.

bool	IsDescendant (wxWindowBase *win) const
	Check if the specified window is a descendant of this one.

virtual bool	Reparent (wxWindow *newParent)
	Reparents the window, i.e. the window will be removed from its current parent window (e.g.

virtual void	AlwaysShowScrollbars (bool hflag=true, bool vflag=true)
	Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

virtual int	GetScrollPos (int orientation) const
	Returns the built-in scrollbar position.

virtual int	GetScrollRange (int orientation) const
	Returns the built-in scrollbar range.

virtual int	GetScrollThumb (int orientation) const
	Returns the built-in scrollbar thumb size.

bool	CanScroll (int orient) const
	Returns true if this window can have a scroll bar in this orientation.

bool	HasScrollbar (int orient) const
	Returns true if this window currently has a scroll bar for this orientation.

virtual bool	IsScrollbarAlwaysShown (int orient) const
	Return whether a scrollbar is always shown.

virtual bool	ScrollLines (int lines)
	Scrolls the window by the given number of lines down (if lines is positive) or up.

virtual bool	ScrollPages (int pages)
	Scrolls the window by the given number of pages down (if pages is positive) or up.

virtual void	ScrollWindow (int dx, int dy, const wxRect *rect=NULL)
	Physically scrolls the pixels in the window and move child windows accordingly.

bool	LineUp ()
	Same as ScrollLines (-1).

bool	LineDown ()
	Same as ScrollLines (1).

bool	PageUp ()
	Same as ScrollPages (-1).

bool	PageDown ()
	Same as ScrollPages (1).

virtual void	SetScrollPos (int orientation, int pos, bool refresh=true)
	Sets the position of one of the built-in scrollbars.

virtual void	SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true)
	Sets the scrollbar properties of a built-in scrollbar.

bool	BeginRepositioningChildren ()
	Prepare for changing positions of multiple child windows.

void	EndRepositioningChildren ()
	Fix child window positions after setting all of them at once.

void	CacheBestSize (const wxSize &size) const
	Sets the cached best size value.

virtual wxSize	ClientToWindowSize (const wxSize &size) const
	Converts client area size size to corresponding window size.

virtual wxSize	WindowToClientSize (const wxSize &size) const
	Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

virtual void	Fit ()
	Sizes the window so that it fits around its subwindows.

virtual void	FitInside ()
	Similar to Fit(), but sizes the interior (virtual) size of a window.

wxSize	GetBestSize () const
	This functions returns the best acceptable minimal size for the window.

int	GetBestHeight (int width) const
	Returns the best height needed by this window if it had the given width.

int	GetBestWidth (int height) const
	Returns the best width needed by this window if it had the given height.

void	GetClientSize (int width, int height) const
	Returns the size of the window 'client area' in pixels.

wxSize	GetClientSize () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual wxSize	GetEffectiveMinSize () const
	Merges the window's best size into the min size and returns the result.

virtual wxSize	GetMaxClientSize () const
	Returns the maximum size of window's client area.

virtual wxSize	GetMaxSize () const
	Returns the maximum size of the window.

virtual wxSize	GetMinClientSize () const
	Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

virtual wxSize	GetMinSize () const
	Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

int	GetMinWidth () const
	Returns the horizontal component of window minimal size.

int	GetMinHeight () const
	Returns the vertical component of window minimal size.

int	GetMaxWidth () const
	Returns the horizontal component of window maximal size.

int	GetMaxHeight () const
	Returns the vertical component of window maximal size.

void	GetSize (int width, int height) const
	Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

wxSize	GetSize () const
	See the GetSize(int,int) overload for more info.

wxSize	GetVirtualSize () const
	This gets the virtual size of the window in pixels.

void	GetVirtualSize (int width, int height) const
	Like the other GetVirtualSize() overload but uses pointers instead.

virtual wxSize	GetBestVirtualSize () const
	Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

virtual double	GetContentScaleFactor () const
	Returns the magnification of the backing store of this window, eg 2.0 for a window on a retina screen.

virtual wxSize	GetWindowBorderSize () const
	Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

virtual bool	InformFirstDirection (int direction, int size, int availableOtherDir)
	wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known.

void	InvalidateBestSize ()
	Resets the cached best size value so it will be recalculated the next time it is needed.

void	PostSizeEvent ()
	Posts a size event to the window.

void	PostSizeEventToParent ()
	Posts a size event to the parent of this window.

virtual void	SendSizeEvent (int flags=0)
	This function sends a dummy size event to the window allowing it to re-layout its children positions.

void	SendSizeEventToParent (int flags=0)
	Safe wrapper for GetParent()->SendSizeEvent().

void	SetClientSize (int width, int height)
	This sets the size of the window client area in pixels.

void	SetClientSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetClientSize (const wxRect &rect)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetContainingSizer (wxSizer *sizer)
	This normally does not need to be called by user code.

void	SetInitialSize (const wxSize &size=wxDefaultSize)
	A smart SetSize that will fill in default size components with the window's best size values.

virtual void	SetMaxClientSize (const wxSize &size)
	Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

virtual void	SetMaxSize (const wxSize &size)
	Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

virtual void	SetMinClientSize (const wxSize &size)
	Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area.

virtual void	SetMinSize (const wxSize &size)
	Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

void	SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO)
	Sets the size of the window in pixels.

void	SetSize (const wxRect &rect)
	Sets the size of the window in pixels.

void	SetSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetSize (int width, int height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual void	SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize)
	Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

virtual void	SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	SetVirtualSize (int width, int height)
	Sets the virtual size of the window in pixels.

void	SetVirtualSize (const wxSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	Center (int dir=wxBOTH)
	A synonym for Centre().

void	CenterOnParent (int dir=wxBOTH)
	A synonym for CentreOnParent().

void	Centre (int direction=wxBOTH)
	Centres the window.

void	CentreOnParent (int direction=wxBOTH)
	Centres the window on its parent.

void	GetPosition (int x, int y) const
	This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

wxPoint	GetPosition () const
	This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

wxRect	GetRect () const
	Returns the position and size of the window as a wxRect object.

void	GetScreenPosition (int x, int y) const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one.

wxPoint	GetScreenPosition () const
	Returns the window position in screen coordinates, whether the window is a child window or a top level one.

wxRect	GetScreenRect () const
	Returns the position and size of the window on the screen as a wxRect object.

virtual wxPoint	GetClientAreaOrigin () const
	Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...)

wxRect	GetClientRect () const
	Get the client rectangle in window (i.e. client) coordinates.

void	Move (int x, int y, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position.

void	Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING)
	Moves the window to the given position.

void	SetPosition (const wxPoint &pt)
	A synonym for Centre().

void	ClientToScreen (int x, int y) const
	Converts to screen coordinates from coordinates relative to this window.

wxPoint	ClientToScreen (const wxPoint &pt) const
	Converts to screen coordinates from coordinates relative to this window.

wxPoint	ConvertDialogToPixels (const wxPoint &pt) const
	Converts a point or size from dialog units to pixels.

wxSize	ConvertDialogToPixels (const wxSize &sz) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

wxPoint	ConvertPixelsToDialog (const wxPoint &pt) const
	Converts a point or size from pixels to dialog units.

wxSize	ConvertPixelsToDialog (const wxSize &sz) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	ScreenToClient (int x, int y) const
	Converts from screen to client window coordinates.

wxPoint	ScreenToClient (const wxPoint &pt) const
	Converts from screen to client window coordinates.

virtual void	ClearBackground ()
	Clears the window by filling it with the current background colour.

void	Freeze ()
	Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

void	Thaw ()
	Re-enables window updating after a previous call to Freeze().

bool	IsFrozen () const
	Returns true if the window is currently frozen by a call to Freeze().

wxColour	GetBackgroundColour () const
	Returns the background colour of the window.

virtual wxBackgroundStyle	GetBackgroundStyle () const
	Returns the background style of the window.

virtual int	GetCharHeight () const
	Returns the character height for this window.

virtual int	GetCharWidth () const
	Returns the average character width for this window.

virtual wxVisualAttributes	GetDefaultAttributes () const
	Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).

wxFont	GetFont () const
	Returns the font for this window.

wxColour	GetForegroundColour () const
	Returns the foreground colour of the window.

void	GetTextExtent (const wxString &string, int w, int h, int descent=NULL, int externalLeading=NULL, const wxFont *font=NULL) const
	Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

wxSize	GetTextExtent (const wxString &string) const
	Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

const wxRegion &	GetUpdateRegion () const
	Returns the region specifying which parts of the window have been damaged.

wxRect	GetUpdateClientRect () const
	Get the update rectangle bounding box in client coords.

virtual bool	HasTransparentBackground ()
	Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background.

virtual void	Refresh (bool eraseBackground=true, const wxRect *rect=NULL)
	Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted.

void	RefreshRect (const wxRect &rect, bool eraseBackground=true)
	Redraws the contents of the given rectangle: only the area inside it will be repainted.

virtual void	Update ()
	Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

virtual bool	SetBackgroundColour (const wxColour &colour)
	Sets the background colour of the window.

virtual bool	SetBackgroundStyle (wxBackgroundStyle style)
	Sets the background style of the window.

virtual bool	IsTransparentBackgroundSupported (wxString *reason=NULL) const
	Checks whether using transparent background might work.

virtual bool	SetForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window.

void	SetOwnBackgroundColour (const wxColour &colour)
	Sets the background colour of the window but prevents it from being inherited by the children of this window.

bool	InheritsBackgroundColour () const
	Return true if this window inherits the background colour from its parent.

bool	UseBgCol () const
	Return true if a background colour has been set for this window.

void	SetOwnFont (const wxFont &font)
	Sets the font of the window but prevents it from being inherited by the children of this window.

void	SetOwnForegroundColour (const wxColour &colour)
	Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

void	SetPalette (const wxPalette &pal)

virtual bool	ShouldInheritColours () const
	Return true from here to allow the colours of this window to be changed by InheritAttributes().

virtual void	SetThemeEnabled (bool enable)
	This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code.

virtual bool	GetThemeEnabled () const
	Clears the window by filling it with the current background colour.

virtual bool	CanSetTransparent ()
	Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

virtual bool	SetTransparent (wxByte alpha)
	Set the transparency of the window.

wxEvtHandler *	GetEventHandler () const
	Returns the event handler for this window.

bool	HandleAsNavigationKey (const wxKeyEvent &event)
	This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

bool	HandleWindowEvent (wxEvent &event) const
	Shorthand for:

bool	ProcessWindowEvent (wxEvent &event)
	Convenient wrapper for ProcessEvent().

bool	ProcessWindowEventLocally (wxEvent &event)
	Wrapper for wxEvtHandler::ProcessEventLocally().

wxEvtHandler *	PopEventHandler (bool deleteHandler=false)
	Removes and returns the top-most event handler on the event handler stack.

void	PushEventHandler (wxEvtHandler *handler)
	Pushes this event handler onto the event stack for the window.

bool	RemoveEventHandler (wxEvtHandler *handler)
	Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

void	SetEventHandler (wxEvtHandler *handler)
	Sets the event handler for this window.

virtual void	SetNextHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called.

virtual void	SetPreviousHandler (wxEvtHandler *handler)
	wxWindows cannot be used to form event handler chains; this function thus will assert when called.

long	GetExtraStyle () const
	Returns the extra style bits for the window.

virtual long	GetWindowStyleFlag () const
	Gets the window style that was passed to the constructor or Create() method.

long	GetWindowStyle () const
	See GetWindowStyleFlag() for more info.

bool	HasExtraStyle (int exFlag) const
	Returns true if the window has the given exFlag bit set in its extra styles.

bool	HasFlag (int flag) const
	Returns true if the window has the given flag bit set.

virtual void	SetExtraStyle (long exStyle)
	Sets the extra style bits for the window.

virtual void	SetWindowStyleFlag (long style)
	Sets the style of the window.

void	SetWindowStyle (long style)
	See SetWindowStyleFlag() for more info.

bool	ToggleWindowStyle (int flag)
	Turns the given flag on if it's currently turned off and vice versa.

void	MoveAfterInTabOrder (wxWindow *win)
	Moves this window in the tab navigation order after the specified win.

void	MoveBeforeInTabOrder (wxWindow *win)
	Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

bool	Navigate (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action starting from this window.

bool	NavigateIn (int flags=wxNavigationKeyEvent::IsForward)
	Performs a keyboard navigation action inside this window.

virtual void	Lower ()
	Lowers the window to the bottom of the window hierarchy (Z-order).

virtual void	Raise ()
	Raises the window to the top of the window hierarchy (Z-order).

bool	Hide ()
	Equivalent to calling wxWindow::Show(false).

virtual bool	HideWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function hides a window, like Hide(), but using a special visual effect if possible.

bool	IsEnabled () const
	Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

bool	IsExposed (int x, int y) const
	Returns true if the given point or rectangle area has been exposed since the last repaint.

bool	IsExposed (wxPoint &pt) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	IsExposed (int x, int y, int w, int h) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	IsExposed (wxRect &rect) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual bool	IsShown () const
	Returns true if the window is shown, false if it has been hidden.

virtual bool	IsShownOnScreen () const
	Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well.

bool	Disable ()
	Disables the window.

virtual bool	Enable (bool enable=true)
	Enable or disable the window for user input.

virtual bool	Show (bool show=true)
	Shows or hides the window.

virtual bool	ShowWithEffect (wxShowEffect effect, unsigned int timeout=0)
	This function shows a window, like Show(), but using a special visual effect if possible.

wxString	GetHelpText () const
	Gets the help text to be used as context-sensitive help for this window.

void	SetHelpText (const wxString &helpText)
	Sets the help text to be used as context-sensitive help for this window.

virtual wxString	GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const
	Gets the help text to be used as context-sensitive help for this window.

wxToolTip *	GetToolTip () const
	Get the associated tooltip or NULL if none.

wxString	GetToolTipText () const
	Get the text of the associated tooltip or empty string if none.

void	SetToolTip (const wxString &tipString)
	Attach a tooltip to the window.

void	SetToolTip (wxToolTip *tip)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	UnsetToolTip ()
	Unset any existing tooltip.

int	GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos=wxDefaultPosition)
	This function shows a popup menu at the given position in this window and returns the selected id.

int	GetPopupMenuSelectionFromUser (wxMenu &menu, int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition)
	Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

bool	PopupMenu (wxMenu *menu, int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

virtual wxValidator *	GetValidator ()
	Validator functions.

virtual void	SetValidator (const wxValidator &validator)
	Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type.

virtual bool	TransferDataFromWindow ()
	Transfers values from child controls to data areas specified by their validators.

virtual bool	TransferDataToWindow ()
	Transfers values to child controls from data areas specified by their validators.

virtual bool	Validate ()
	Validates the current values of the child controls using their validators.

wxWindowID	GetId () const
	Returns the identifier of the window.

virtual wxLayoutDirection	GetLayoutDirection () const
	Returns the layout direction for this window, Note that `wxLayout_Default` is returned if layout direction is not supported.

virtual wxCoord	AdjustForLayoutDirection (wxCoord x, wxCoord width, wxCoord widthTotal) const
	Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

virtual wxString	GetName () const
	Returns the window's name.

wxWindowVariant	GetWindowVariant () const
	Returns the value previously passed to SetWindowVariant().

void	SetId (wxWindowID winid)
	Sets the identifier of the window.

virtual void	SetLayoutDirection (wxLayoutDirection dir)
	Sets the layout direction for this window.

virtual void	SetName (const wxString &name)
	Sets the window's name.

void	SetWindowVariant (wxWindowVariant variant)
	Chooses a different variant of the window display to use.

wxAcceleratorTable *	GetAcceleratorTable ()
	Gets the accelerator table for this window.

wxAccessible *	GetAccessible ()
	Returns the accessible object for this window, if any.

virtual void	SetAcceleratorTable (const wxAcceleratorTable &accel)
	Sets the accelerator table for this window.

void	SetAccessible (wxAccessible *accessible)
	Sets the accessible for this window.

bool	Close (bool force=false)
	This function simply generates a wxCloseEvent whose handler usually tries to close the window.

virtual bool	Destroy ()
	Destroys the window safely.

bool	IsBeingDeleted () const
	Returns true if this window is in process of being destroyed.

virtual wxDropTarget *	GetDropTarget () const
	Returns the associated drop target, which may be NULL.

virtual void	SetDropTarget (wxDropTarget *target)
	Associates a drop target with this window.

virtual void	DragAcceptFiles (bool accept)
	Enables or disables eligibility for drop file events (OnDropFiles).

wxSizer *	GetContainingSizer () const
	Returns the sizer of which this window is a member, if any, otherwise NULL.

wxSizer *	GetSizer () const
	Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

void	SetSizer (wxSizer *sizer, bool deleteOld=true)
	Sets the window to have the given layout sizer.

void	SetSizerAndFit (wxSizer *sizer, bool deleteOld=true)
	This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size.

wxLayoutConstraints *	GetConstraints () const
	Returns a pointer to the window's layout constraints, or NULL if there are none.

void	SetConstraints (wxLayoutConstraints *constraints)
	Sets the window to have the given layout constraints.

virtual bool	Layout ()
	Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window.

void	SetAutoLayout (bool autoLayout)
	Determines whether the Layout() function will be called automatically when the window is resized.

bool	GetAutoLayout () const
	Returns the sizer of which this window is a member, if any, otherwise NULL.

void	CaptureMouse ()
	Directs all mouse input to this window.

wxCaret *	GetCaret () const
	Returns the caret() associated with the window.

const wxCursor &	GetCursor () const
	Return the cursor associated with this window.

virtual bool	HasCapture () const
	Returns true if this window has the current mouse capture.

void	ReleaseMouse ()
	Releases mouse input captured with CaptureMouse().

void	SetCaret (wxCaret *caret)
	Sets the caret() associated with the window.

virtual bool	SetCursor (const wxCursor &cursor)
	Sets the window's cursor.

virtual void	WarpPointer (int x, int y)
	Moves the pointer to the given position on the window.

wxHitTest	HitTest (wxCoord x, wxCoord y) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

wxHitTest	HitTest (const wxPoint &pt) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

wxBorder	GetBorder (long flags) const
	Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable.

wxBorder	GetBorder () const
	Get border for the flags of this window.

virtual void	DoUpdateWindowUI (wxUpdateUIEvent &event)
	Does the window-specific updating after processing the update event.

virtual WXWidget	GetHandle () const
	Returns the platform-specific handle of the physical window.

virtual bool	HasMultiplePages () const
	This method should be overridden to return true if this window has multiple pages.

virtual void	InheritAttributes ()
	This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.

virtual void	InitDialog ()
	Sends an `wxEVT_INIT_DIALOG` event, whose handler usually transfers data to the dialog via validators.

virtual bool	IsDoubleBuffered () const
	Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later.

void	SetDoubleBuffered (bool on)
	Turn on or off double buffering of the window if the system supports it.

virtual bool	IsRetained () const
	Returns true if the window is retained, false otherwise.

bool	IsThisEnabled () const
	Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

virtual bool	IsTopLevel () const
	Returns true if the given window is a top-level one.

virtual void	OnInternalIdle ()
	This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class.

virtual bool	SendIdleEvents (wxIdleEvent &event)
	Send idle event to window and all subwindows.

virtual bool	RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode)
	Registers a system wide hotkey.

virtual bool	UnregisterHotKey (int hotkeyId)
	Unregisters a system wide hotkey.

virtual void	UpdateWindowUI (long flags=wxUPDATE_UI_NONE)
	This function sends one or more wxUpdateUIEvent to the window.

Public Member Functions inherited from wxEvtHandler
	wxEvtHandler ()
	Constructor.

virtual	~wxEvtHandler ()
	Destructor.

template<typename T , typename T1 , ... >
void	CallAfter (void(T::*method)(T1,...), T1 x1,...)
	Asynchronously call the given method.

template<typename T >
void	CallAfter (const T &functor)
	Asynchronously call the given functor.

bool	ProcessEventLocally (wxEvent &event)
	Try to process the event in this handler and all those chained to it.

bool	SafelyProcessEvent (wxEvent &event)
	Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

void	ProcessPendingEvents ()
	Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a `wxCHECK` will fail.

void	DeletePendingEvents ()
	Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

virtual bool	SearchEventTable (wxEventTable &table, wxEvent &event)
	Searches the event table, executing an event handler function if an appropriate one is found.

void	Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	Connects the given function dynamically with the event handler, id and event type.

void	Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject, wxEvtHandler) overload for more info.

void	Connect (wxEventType eventType, wxObjectEventFunction function, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject, wxEvtHandler) overload for more info.

bool	Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.

bool	Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject, wxEvtHandler) overload for more info.

bool	Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject userData=NULL, wxEvtHandler eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject, wxEvtHandler) overload for more info.

template<typename EventTag , typename Functor >
void	Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Binds the given function, functor or method dynamically with the event.

template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
void	Bind (const EventTag &eventType, void(Class::method)(EventArg &), EventHandler handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.

template<typename EventTag , typename Functor >
bool	Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.

template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
bool	Unbind (const EventTag &eventType, void(Class::method)(EventArg &), EventHandler handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.

void *	GetClientData () const
	Returns user-supplied client data.

wxClientData *	GetClientObject () const
	Returns a pointer to the user-supplied client data object.

void	SetClientData (void *data)
	Sets user-supplied client data.

void	SetClientObject (wxClientData *data)
	Set the client data object.

bool	GetEvtHandlerEnabled () const
	Returns true if the event handler is enabled, false otherwise.

wxEvtHandler *	GetNextHandler () const
	Returns the pointer to the next handler in the chain.

wxEvtHandler *	GetPreviousHandler () const
	Returns the pointer to the previous handler in the chain.

void	SetEvtHandlerEnabled (bool enabled)
	Enables or disables the event handler.

void	Unlink ()
	Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).

bool	IsUnlinked () const
	Returns true if the next and the previous handler pointers of this event handler instance are NULL.

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.

Public Member Functions inherited from wxWithImages
	wxWithImages ()

virtual	~wxWithImages ()

void	AssignImageList (wxImageList *imageList)
	Sets the image list for the page control and takes ownership of the list.

virtual void	SetImageList (wxImageList *imageList)
	Sets the image list to use.

wxImageList *	GetImageList () const
	Returns the associated image list, may be NULL.

Additional Inherited Members
Public Types inherited from wxBookCtrlBase
enum	{ NO_IMAGE = -1 }

Static Public Member Functions inherited from wxControl
static wxString	GetLabelText (const wxString &label)
	Returns the given label string without mnemonics ("&" characters).

static wxString	RemoveMnemonics (const wxString &str)
	Returns the given str string without mnemonics ("&" characters).

static wxString	EscapeMnemonics (const wxString &text)
	Escapes the special mnemonics characters ("&") in the given string.

static wxString	Ellipsize (const wxString &label, const wxDC &dc, wxEllipsizeMode mode, int maxWidth, int flags=wxELLIPSIZE_FLAGS_DEFAULT)
	Replaces parts of the label string with ellipsis, if needed, so that it fits into maxWidth pixels if possible.

Protected Member Functions inherited from wxWindow
virtual void	DoCentre (int direction)
	Centres the window.

virtual wxSize	DoGetBestSize () const
	Implementation of GetBestSize() that can be overridden.

virtual wxSize	DoGetBestClientSize () const
	Override this method to return the best size for a custom control.

virtual int	DoGetBestClientHeight (int width) const
	Override this method to implement height-for-width best size calculation.

virtual int	DoGetBestClientWidth (int height) const
	Override this method to implement width-for-height best size calculation.

virtual void	SetInitialBestSize (const wxSize &size)
	Sets the initial window size if none is given (i.e. at least one of the components of the size passed to ctor/Create() is wxDefaultCoord).

void	SendDestroyEvent ()
	Generate wxWindowDestroyEvent for this window.

virtual bool	ProcessEvent (wxEvent &event)
	This function is public in wxEvtHandler but protected in wxWindow because for wxWindows you should always call ProcessEvent() on the pointer returned by GetEventHandler() and not on the wxWindow object itself.

bool	SafelyProcessEvent (wxEvent &event)
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.

virtual void	QueueEvent (wxEvent *event)
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.

virtual void	AddPendingEvent (const wxEvent &event)
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.

void	ProcessPendingEvents ()
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.

bool	ProcessThreadEvent (const wxEvent &event)
	See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow.

Protected Member Functions inherited from wxWithImages
bool	HasImageList () const
	Return true if we have a valid image list.

wxIcon	GetImage (int iconIndex) const
	Return the image with the given index from the image list.

Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

wxAuiNotebook::wxAuiNotebook ( )

Default ctor.

wxAuiNotebook::wxAuiNotebook	(	wxWindow *	parent,
		wxWindowID	id = `wxID_ANY`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `wxAUI_NB_DEFAULT_STYLE`
	)

Constructor.

Creates a wxAuiNotebok control.

Member Function Documentation

bool wxAuiNotebook::AddPage	(	wxWindow *	page,
		const wxString &	caption,
		bool	select = `false`,
		const wxBitmap &	bitmap = `wxNullBitmap`
	)

Adds a page.

If the select parameter is true, calling this will generate a page change event.

virtual bool wxAuiNotebook::AddPage	(	wxWindow *	page,
		const wxString &	text,
		bool	select,
		int	imageId
	)

virtual

Adds a new page.

The page must have the book control itself as the parent and must not have been added to this control previously.

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

Parameters

page	Specifies the new page.
text	Specifies the text for the new page.
select	Specifies whether the page should be selected.
imageId	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 book control.

See Also: InsertPage()

Since: 2.9.3

Reimplemented from wxBookCtrlBase.

void wxAuiNotebook::AdvanceSelection ( bool forward = true )

Sets the selection to the next or previous page.

virtual int wxAuiNotebook::ChangeSelection ( size_t n )

virtual

Changes the selection for the given page, returning the previous selection.

This function behaves as SetSelection() but does not generate the page changing events.

See User Generated Events vs Programmatically Generated Events for more information.

Since: 2.9.3

Implements wxBookCtrlBase.

bool wxAuiNotebook::Create	(	wxWindow *	parent,
		wxWindowID	id = `wxID_ANY`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `0`
	)

Creates the notebook window.

virtual bool wxAuiNotebook::DeleteAllPages ( )

virtual

Deletes all pages.

Since: 2.9.3

Reimplemented from wxBookCtrlBase.

bool wxAuiNotebook::DeletePage ( size_t page )

virtual

Deletes a page at the given index.

Calling this method will generate a page change event.

Reimplemented from wxBookCtrlBase.

wxAuiTabArt* wxAuiNotebook::GetArtProvider ( ) const

Returns the associated art provider.

wxWindow* wxAuiNotebook::GetCurrentPage ( ) const

Returns the currently selected page or NULL.

Since: 2.9.3

int wxAuiNotebook::GetHeightForPageHeight ( int pageHeight )

Returns the desired height of the notebook for the given page height.

Use this to fit the notebook to a given page size.

wxWindow* wxAuiNotebook::GetPage ( size_t page_idx ) const

Returns the page specified by the given index.

wxBitmap wxAuiNotebook::GetPageBitmap ( size_t page ) const

Returns the tab bitmap for the page.

size_t wxAuiNotebook::GetPageCount ( ) const

virtual

Returns the number of pages in the notebook.

Reimplemented from wxBookCtrlBase.

int wxAuiNotebook::GetPageIndex ( wxWindow * page_wnd ) const

Returns the page index for the specified window.

If the window is not found in the notebook, wxNOT_FOUND is returned.

wxString wxAuiNotebook::GetPageText ( size_t page ) const

virtual

Returns the tab label for the page.

Implements wxBookCtrlBase.

wxString wxAuiNotebook::GetPageToolTip ( size_t pageIdx ) const

Returns the tooltip for the tab label of the page.

Since: 2.9.4

int wxAuiNotebook::GetSelection ( ) const

virtual

Returns the currently selected page.

Implements wxBookCtrlBase.

int wxAuiNotebook::GetTabCtrlHeight ( ) const

Returns the height of the tab control.

bool wxAuiNotebook::InsertPage	(	size_t	page_idx,
		wxWindow *	page,
		const wxString &	caption,
		bool	select = `false`,
		const wxBitmap &	bitmap = `wxNullBitmap`
	)

InsertPage() is similar to AddPage, but allows the ability to specify the insert location.

If the select parameter is true, calling this will generate a page change event.

virtual bool wxAuiNotebook::InsertPage	(	size_t	index,
		wxWindow *	page,
		const wxString &	text,
		bool	select = `false`,
		int	imageId = `NO_IMAGE`
	)

virtual

Inserts a new page at the specified position.

Parameters

index	Specifies the position for the new page.
page	Specifies the new page.
text	Specifies the text for the new page.
select	Specifies whether the page should be selected.
imageId	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 book control.

See Also: AddPage()

Since: 2.9.3

Implements wxBookCtrlBase.

bool wxAuiNotebook::RemovePage ( size_t page )

virtual

Removes a page, without deleting the window pointer.

Reimplemented from wxBookCtrlBase.

void wxAuiNotebook::SetArtProvider ( wxAuiTabArt * art )

Sets the art provider to be used by the notebook.

virtual bool wxAuiNotebook::SetFont ( const wxFont & font )

virtual

Sets the font for drawing the tab labels, using a bold version of the font for selected tab labels.

Reimplemented from wxWindow.

void wxAuiNotebook::SetMeasuringFont ( const wxFont & font )

Sets the font for measuring tab labels.

void wxAuiNotebook::SetNormalFont ( const wxFont & font )

Sets the font for drawing unselected tab labels.

bool wxAuiNotebook::SetPageBitmap	(	size_t	page,
		const wxBitmap &	bitmap
	)

Sets the bitmap for the page.

To remove a bitmap from the tab caption, pass wxNullBitmap.

virtual bool wxAuiNotebook::SetPageImage	(	size_t	n,
		int	imageId
	)

virtual

Sets the image index for the given page.

image is an index into the image list which was set with SetImageList().

Since: 2.9.3

Implements wxBookCtrlBase.

bool wxAuiNotebook::SetPageText	(	size_t	page,
		const wxString &	text
	)

virtual

Sets the tab label for the page.

Implements wxBookCtrlBase.

bool wxAuiNotebook::SetPageToolTip	(	size_t	page,
		const wxString &	text
	)

Sets the tooltip displayed when hovering over the tab label of the page.

Returns: true if tooltip was updated, false if it failed, e.g. because the page index is invalid.

Since: 2.9.4

void wxAuiNotebook::SetSelectedFont ( const wxFont & font )

Sets the font for drawing selected tab labels.

size_t wxAuiNotebook::SetSelection ( size_t new_page )

virtual

Sets the page selection.

Calling this method will generate a page change event.

Implements wxBookCtrlBase.

virtual void wxAuiNotebook::SetTabCtrlHeight ( int height )

virtual

Sets the tab height.

By default, the tab control height is calculated by measuring the text height and bitmap sizes on the tab captions. Calling this method will override that calculation and set the tab control to the specified height parameter. A call to this method will override any call to SetUniformBitmapSize().

Specifying -1 as the height will return the control to its default auto-sizing behaviour.

virtual void wxAuiNotebook::SetUniformBitmapSize ( const wxSize & size )

virtual

Split performs a split operation programmatically.

The argument page indicates the page that will be split off. This page will also become the active page after the split.

The direction argument specifies where the pane should go, it should be one of the following: wxTOP, wxBOTTOM, wxLEFT, or wxRIGHT.

bool wxAuiNotebook::ShowWindowMenu ( )

Shows the window menu for the active tab control associated with this notebook, and returns true if a selection was made.

virtual void wxAuiNotebook::Split	(	size_t	page,
		int	direction
	)

virtual

Split performs a split operation programmatically.

The argument page indicates the page that will be split off. This page will also become the active page after the split.

The direction argument specifies where the pane should go, it should be one of the following: wxTOP, wxBOTTOM, wxLEFT, or wxRIGHT.

Detailed Description

Styles

Events emitted by this class

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation