Base class for the containing window for LabelBook and FlatImageBook.
__init__ | Default class constructor. |
AddPage | Adds a page to the book. |
AdvanceSelection | Cycles through the tabs. |
AssignImageList | Assigns an image list to the control. |
ChangeSelection | Changes the selection for the given page, returning the previous selection. |
DeleteAllPages | Deletes all the pages in the book. |
DeletePage | Deletes the specified page, and the associated window. |
DoSetSelection | Select the window by the provided pointer. |
EnableTab | Enables or disables a tab. |
GetAGWWindowStyleFlag | Returns the FlatBookBase window style. |
GetCurrentPage | Returns the currently selected notebook page or None. |
GetEnabled | Returns whether a tab is enabled or not. |
GetFontBold | Gets the font bold status. |
GetFontSizeMultiple | Gets the font size multiple for the page captions. |
GetImageList | Returns the associated image list. |
GetPage | Returns the window at the given page position. |
GetPageCount | Returns the number of pages in the book. |
GetPageImage | Returns the image index for the given page. |
GetPageText | Returns the text for the given page. |
GetSelection | Returns the current selection. |
HasAGWFlag | Returns whether a flag is present in the FlatBookBase style. |
InsertPage | Inserts a page into the book at the specified position. |
OnNavigationKey | Handles the EVT_NAVIGATION_KEY event for FlatBookBase. |
RemovePage | Deletes the specified page, without deleting the associated window. |
ResizeTabArea | Resizes the tab area if the control has the INB_FIT_LABELTEXT style set. |
SetAGWWindowStyleFlag | Sets the window style. |
SetFontBold | Sets whether the page captions are bold or not. |
SetFontSizeMultiple | Sets the font size multiple for the page captions. |
SetPageImage | Sets the image index for the given page. |
SetPageText | Sets the text for the given page. |
SetSelection | Changes the selection from currently visible/selected page to the page |
CurrentPage | See GetCurrentPage |
Page | See GetPage |
PageCount | See GetPageCount |
PageImage | See GetPageImage, SetPageImage |
PageText | See GetPageText, SetPageText |
Selection | See GetSelection, SetSelection |
Base class for the containing window for LabelBook and FlatImageBook.
Default class constructor.
Parameters: |
|
---|
Adds a page to the book.
Parameters: |
|
---|
Note
The call to this function generates the page changing events.
Cycles through the tabs.
Parameters: | forward – if True, the selection is advanced in ascending order (to the right), otherwise the selection is advanced in descending order. |
---|
Note
The call to this function generates the page changing events.
Assigns an image list to the control.
Parameters: | imglist – an instance of ImageList. |
---|
Changes the selection for the given page, returning the previous selection.
Parameters: | page – an integer specifying the page to be selected. |
---|
Note
The call to this function does not generate the page changing events.
Deletes all the pages in the book.
Deletes the specified page, and the associated window.
Parameters: | page – an integer specifying the page to be deleted. |
---|
Note
The call to this function generates the page changing events.
Select the window by the provided pointer.
Parameters: | window – an instance of Window. |
---|
Enables or disables a tab.
Parameters: |
|
---|
Returns the FlatBookBase window style.
See also
SetAGWWindowStyleFlag for a list of possible window style flags.
Returns the currently selected notebook page or None.
Returns whether a tab is enabled or not.
Parameters: | page – an integer specifying the page index. |
---|
Gets the font bold status.
Gets the font size multiple for the page captions.
Returns the associated image list.
Returns the window at the given page position.
Parameters: | page – an integer specifying the page to be returned. |
---|
Returns the number of pages in the book.
Returns the image index for the given page.
Parameters: | page – an integer specifying the page index. |
---|
Returns the text for the given page.
Parameters: | page – an integer specifying the page index. |
---|
Returns the current selection.
Returns whether a flag is present in the FlatBookBase style.
Parameters: | flag – one of the possible FlatBookBase window styles. |
---|
See also
SetAGWWindowStyleFlag for a list of possible window style flags.
Inserts a page into the book at the specified position.
Parameters: |
|
---|
Note
The call to this function generates the page changing events.
Handles the EVT_NAVIGATION_KEY event for FlatBookBase.
Parameters: | event – a NavigationKeyEvent event to be processed. |
---|
Deletes the specified page, without deleting the associated window.
Parameters: | page – an integer specifying the page to be removed. |
---|
Note
The call to this function generates the page changing events.
Resizes the tab area if the control has the INB_FIT_LABELTEXT style set.
Sets the window style.
Parameters: | agwStyle – can be a combination of the following bits:
|
---|
Sets whether the page captions are bold or not.
Parameters: | bold – True or False. |
---|
Sets the font size multiple for the page captions.
Parameters: | multiple – The multiple to be applied to the system font to get the our font size. |
---|
Sets the image index for the given page.
Parameters: |
|
---|
Sets the text for the given page.
Parameters: |
|
---|
Changes the selection from currently visible/selected page to the page given by page.
Parameters: | page – an integer specifying the page to be selected. |
---|
Note
The call to this function generates the page changing events.
See GetCurrentPage
See GetPageCount
See SetPageImage , GetPageImage
See SetPageText , GetPageText
See SetSelection , GetSelection