| Inheritance | 
 | 
Desktops (and floating panels) are composed of one or more panes. Initially a desktop contains one pane, and more panes are added to it by splitting existing panes in two, either horizontally or vertically.
See hou.Desktop for more information about panes and pane tabs. See hou.FloatingPanel for more information about floating panels.
Methods ¶
tabOfType(type, index=0)
  → hou.PaneTab or None
        
Find and return a pane tab with the desired type, or None if no such tab
    exists in the pane.
If there are multiple tabs in the pane with the desired type, then the
    first found tab is returned.  Use index to return the other tabs.  For
    example, use index=0 to return the first found tab, use index=1 to
    return the second found tab, etc.
See also hou.ui.paneTabOfType.
currentTab()
  → hou.PaneTab
        
Return the currently focused pane tab.
See also hou.PaneTab.setIsCurrentTab.
createTab(type, python_panel_interface=None)
  → hou.PaneTab
        
Create a new pane tab with the desired type and return it. The new pane tab will be current (i.e. it will be the pane tab that’s open).
type
A hou.paneTabType enumerated variable.
python_panel_interface
The name of the Python Panel interface to be displayed in the new
        pane tab.  Specifying the interface name additionally hides the Python
        Panel toolbar.  If python_panel_interface is None or points to an
        interface that does not exist then the default Python Panel pane tab is
        displayed along with the toolbar.
This argument is ignored if pane_tab_type is not set to
        hou.paneTabType.PythonPanel.
splitHorizontally()
  → hou.Pane
        
Split the pane, adding a new pane to the right, and return the new pane. The new pane will have a single tab whose type is the same as the type of this pane’s current tab.
See also hou.Pane.splitVertically.
splitVertically()
  → hou.Pane
        
Split the pane, adding a new pane to the bottom, and return the new pane. The new pane will have a single tab whose type is the same as the type of this pane’s current tab.
See also hou.Pane.splitHorizontally.
desktop()
  → hou.Desktop or None
        
Return the desktop in which this pane exists, or None if it is in
    a floating panel that’s not attached to the desktop.
isMaximized()
  → bool
        
Return True if this pane is maximized.
setIsMaximized(on)
        
Set the maximized state of this pane.
getSplitParent()
  → hou.Pane or None
        
Return the parent split pane if the Pane is nested under a split.
getSplitChild(self,index)
  → hou.Pane or None
        
Return the split child Pane at index if the Pane is a split.
splitSwap()
        
Swap the left and right panes of an horizontal split Pane. Swap the top and bottom panes of a vertical split Pane.
splitRotate()
        
Turn an horizontal split Pane into a vertical split Pane.
isSplitMinimized()
  → bool
        
Return True if the Pane is minimized on the split. A split can’t be minimized and maximized at the same time. In its default state, a split is not minimized and not maximized.
isSplitMaximized()
  → bool
        
Return True if the Pane is maximized on the split. A split can’t be minimized and maximized at the same time. In its default state, a split is not minimized and not maximized.
setIsSplitMaximized(on)
  → bool
        
Set the maximized state of a split.
isSplit()
  → bool
        
Return True if the pane is a split.
setSplitFraction(self,fraction)
        
Set the split fraction of the parent split.
getSplitFraction(self,fraction)
  → double
        
Return the split fraction of the parent split.
setSplitDirection(self,dir)
        
Set the split direction of the parent split.
getSplitDirection(self,dir)
  → double
        
Return the split direction of the parent split.
isShowingPaneTabs()
  → bool
        
Return True if the Pane is showing pane tabs.
setShowPaneTabs(self,on)
        
Show or Hide the pane tabs bar.
This method is deprecated in favor of showPaneTabs.
showPaneTabs(self,on)
        
Show or Hide the pane tabs bar.
isShowingPaneTabsStow()
  → bool
        
Return True if the Pane is showing the pane tabs stow bar when pane tabs are hidden.
showPaneTabsStow(self,on)
        
Show or Hide the pane tabs stow bar button when pane tabs are hidden.
qtParentWindow()
  → QWidget
        
Return a PySide6.QtWidgets.QWidget instance that represents the window
    containing the pane.
qtScreenGeometry()
  → QRect
        
Return the geometry of the pane as a PySide6.QtCore.QRect
    object.  The x and y properties of the returned QRect object
    point to the top-left corner of the pane in screen coordinates.