Table Of Contents

Previous topic

ed_tab

Next topic

ed_theme

This Page

phoenix_title EdTabBase

Base class for all tab views to derive from, this class just defines the abstract interface and some common basic methods. Initialize this base class after initializing the wx control instance of the subclass.


class_hierarchy Inheritance Diagram

Inheritance diagram for class EdTabBase

Inheritance diagram of EdTabBase


method_summary Methods Summary

__init__ Initialize the tab base class
CanCloseTab Called when checking if tab can be closed or not
DoDeactivateTab Called when the tab is moved from the foreground to background
DoOnIdle Called when the notebook is idle and this instance is the active
DoTabClosing Called when the tab has been selected to be closed in the notebook
DoTabOpen Called to open a new tab
DoTabSelected Called when the page is selected in the notebook
GetName Get the unique name for this tab control.
GetTabImage Get the Bitmap to use for the tab
GetTabIndex Return the index of the tab in the notebook
GetTabLabel Get the tabs label
GetTabMenu Get the context menu to show on the tab
GetTitleString Get the title string to display in the MainWindows title bar
OnTabMenu Handle events from this tabs menu
SetTabIndex Set the tab index
SetTabLabel Set the tabs label
SetTabTitle Set the notebooks title text for this tab

api Class API



class EdTabBase(object)

Base class for all tab views to derive from, this class just defines the abstract interface and some common basic methods. Initialize this base class after initializing the wx control instance of the subclass.


Methods



__init__(self)

Initialize the tab base class



CanCloseTab(self)

Called when checking if tab can be closed or not

Returns:bool


DoDeactivateTab(self)

Called when the tab is moved from the foreground to background



DoOnIdle(self)

Called when the notebook is idle and this instance is the active tab.



DoTabClosing(self)

Called when the tab has been selected to be closed in the notebook



DoTabOpen(self)

Called to open a new tab



DoTabSelected(self)

Called when the page is selected in the notebook



GetName(self)

Get the unique name for this tab control.

Returns:(unicode) string


GetTabImage(self)

Get the Bitmap to use for the tab

Returns:wx.Bitmap (16x16)


GetTabIndex(self)

Return the index of the tab in the notebook

Returns:int


GetTabLabel(self)

Get the tabs label

Returns:string


GetTabMenu(self)

Get the context menu to show on the tab

Returns:wx.Menu or None


GetTitleString(self)

Get the title string to display in the MainWindows title bar

Returns:(unicode) string


OnTabMenu(self, evt)

Handle events from this tabs menu

Parameters:evt – menu event


SetTabIndex(self, idx)

Set the tab index

Parameters:idx – int


SetTabLabel(self, lbl)

Set the tabs label

Parameters:lbl – string


SetTabTitle(self, title)

Set the notebooks title text for this tab