hou.PaneTab class

Methods

name(self) → str

Return the name of this tab.

setName(self, name)

Set the name of this pane tab. A pane tab name may contain spaces.

Note that this name is the internal name of the tab, and is different from the label displayed in the interface.

type(self) → hou.paneTabType enum value

Return the type of this tab (i.e. whether it is a scene viewer, parameter editor, network editor, etc.).

setType(self, type) → hou.PaneTab

Create a new pane tab of the given type, replace this tab with it, and return the new pane tab. Use the returned pane tab afterward; references to this tab become invalid.

close(self)

Close the pane tab.

pane(self) → hou.Pane or None

Return the pane in the desktop that contains this pane tab. Note that pane tabs in regular floating panels are always in a pane, since regular floating panels contain one or more panes.

However, some floating panels have their content stripped down to only contain one particular pane tab type, and do not display the user interface to add more pane tabs, split the pane, etc. This method returns None for these stripped down floating panels.

isCurrentTab(self) → bool

Return whether this tab is the selected tab in the containing pane.

setIsCurrentTab(self)

Set this tab as the selected tab in the containing pane.

isFloating(self) → bool

Return whether this pane tab is in a floating panel.

This method can be approximately implemented as follows:

def isFloating(self):
    return self.pane() is None or self.pane().floatingPanel() is not None

clone(self) → hou.PaneTab

Create a floating copy of the pane tab and return the cloned pane tab. The new pane tab is in a new floating panel.

linkGroup(self) → hou.paneLinkType enum value

Return the link group that this pane tab belongs to.

See also hou.PaneTab.isPin.

setLinkGroup(self, group)

Set the link group membership of this pane tab.

isPin(self) → bool

Return whether this pane tab is pinned. This method is equivalent to (self.linkGroup() == hou.paneLinkType.Pinned)

See also hou.PaneTab.linkGroup.

setPin(self, pin)

If pin is True, set the link group membership to hou.paneLinkType.Pinned. Otherwise, set it to hou.paneLinkType.FollowSelection. This method can be implemented using hou.PaneTab.setLinkGroup as follows:

def setPin(self, pin):
    if pin:
        self.setLinkGroup(hou.paneLinkType.Pinned)
    else:
        self.setLinkGroup(hou.paneLinkType.FollowSelection)

See also hou.PaneTab.setLinkGroup.