wxBookCtrlBase

Implements methods from the following classes

• wxControl
• wxWithImages

Methods

• Create
  Constructs the book control with the given parameters.
• AddPage
  Adds a new page.
• AdvanceSelection
  Cycles through the tabs.
• DeleteAllPages
  Deletes all pages.
• DeletePage
  Deletes the specified page, and the associated window.
• GetCurrentPage
  Returns the currently selected page or NULL.
• GetPage
  Returns the window at the given page position.
• GetPageCount
  Returns the number of pages in the control.
• HitTest
  Returns the index of the tab at the specified position or wxNOT_FOUND if none.
• InsertPage
  Inserts a new page at the specified position.
• RemovePage
  Deletes the specified page, without deleting the associated window.
• SetPageImage
  Sets the image index for the given page.
• SetPageSize
  Sets the width and height of the pages.
• SetPageText
  Sets the text for the given page.
• SetSelection
  Sets the selection to the given page, returning the previous selection.
• GetSelection
  Returns the currently selected page, or wxNOT_FOUND if none was selected.
• GetPageText
  Returns the string for the given page.
• GetPageImage
  Returns the image index for the given page.
• ChangeSelection
  Changes the selection to the given page, returning the previous selection.

Static Methods

Create

bool Create ( wxWindow &$parent, integer $winid, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style, string $name=wxEmptyString )

Constructs the book control with the given parameters.

AddPage

bool AddPage ( wxWindow &$page, string $text, bool $select=false, integer $imageId=NO_IMAGE )

Adds a new page.

AdvanceSelection

AdvanceSelection ( bool $forward=true )

Cycles through the tabs.

DeleteAllPages

bool DeleteAllPages ( )

Deletes all pages.

DeletePage

bool DeletePage ( integer $page )

Deletes the specified page, and the associated window.

GetCurrentPage

wxWindow& GetCurrentPage ( )

Returns the currently selected page or NULL.

GetPage

wxWindow& GetPage ( integer $page )

Returns the window at the given page position.

GetPageCount

integer GetPageCount ( )

Returns the number of pages in the control.

HitTest

integer HitTest ( wxPoint $pt, integer &$flags=NULL )

Returns the index of the tab at the specified position or wxNOT_FOUND if none.

InsertPage

bool InsertPage ( integer $index, wxWindow &$page, string $text, bool $select=false, integer $imageId=NO_IMAGE )

Inserts a new page at the specified position.

RemovePage

bool RemovePage ( integer $page )

Deletes the specified page, without deleting the associated window.

SetPageImage

bool SetPageImage ( integer $page, integer $image )

Sets the image index for the given page.

SetPageSize

SetPageSize ( wxSize $size )

Sets the width and height of the pages.

SetPageText

bool SetPageText ( integer $page, string $text )

Sets the text for the given page.

SetSelection

integer SetSelection ( integer $page )

Sets the selection to the given page, returning the previous selection.

GetSelection

integer GetSelection ( )

Returns the currently selected page, or wxNOT_FOUND if none was selected.

GetPageText

string GetPageText ( integer $nPage )

Returns the string for the given page.

GetPageImage

integer GetPageImage ( integer $nPage )

Returns the image index for the given page.

ChangeSelection

integer ChangeSelection ( integer $page )

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