wbpDocBrowser package

class DocTreeModel

Bases: object

TreeModel holds the domain objects that are shown in the tree control.

property app: App

Returns:

The running Workbench application.

property documentManager: DocumentManager

Returns:

The document manager of the running application.

property items: List[Tuple[str, tuple, str]]

GetItem(indices)

Parameters:

indices (Tuple[int, ...]) –

GetText(indices)

Parameters:

indices (Tuple[int, ...]) –

Return type:

str

GetChildren(indices)

Parameters:

indices (Tuple[int, ...]) –

GetChildrenCount(indices)

Parameters:

indices (Tuple[int, ...]) –

Return type:

int

class DocTreeMixin

Bases: VirtualTree

Mixin class for virtual TreeCtrl.

__init__(*args, **kwargs)

property app: App

Returns:

The running Workbench application.

property documentManager: DocumentManager

Returns:

The document manager of the running application.

createImageList()

Create an image list from all known document and view icons.

Return type:

None

OnGetItemText(indices, column=0)

Returns:

The string for the item specified by indices

Parameters:

• indices (Tuple[int, ...]) –

• column (int) –

Return type:

str

OnGetChildrenCount(indices)

Returns:

the number of child items of the item with the provided indices.

Parameters:

indices (Tuple[int, ...]) –

Return type:

int

OnGetItemImage(indices, which=wx.TreeItemIcon_Normal, column=0)

Returns:

The index in the image list of the image to be used

Parameters:

• indices (Tuple[int, ...]) –

• which (int) –

• column (int) –

Return type:

int

class DocTreeCtrl

Bases: DocTreeMixin, TreeCtrl

TreeCtrl to show all open documents and the associated views.

__init__(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.TR_DEFAULT_STYLE | wx.TR_SINGLE | wx.TR_TWIST_BUTTONS)

on_itemActivated(event)

Handle double click on item in tree control.

Parameters:

event (TreeEvent) –

on_updateUI(event)

makeImageList(app)

Parameters:

app (App) –