Frameless

Window 

class KeyboardModifierFilter(*args: Any, **kwargs: Any)

Bases: QObject

windowEvent: alias of object

currentEvent = None

eventFilter(obj, event)

class ZooWindow(*args: Any, **kwargs: Any)

Bases: QWidget

helpUrl = ''

windowSettingsPath = ''

property windowEvent

setDefaultStyleSheet()

Try to set the default stylesheet, if not, just ignore it

Returns:

property titleContentsLayout

property cornerLayout

showOverlay()

Show overlay

Returns:

setOnTop(t)

move(*args, **kwargs)

Move window, offset the resizers if they are visible

Parameters:

args
kwargs

Returns:

classmethod getZooWindow(widget)

Gets the zoo window based on the widget

Parameters:: widget (QtWidgets.QWidget)
Returns:
Return type:: ZooWindow

setTitleBarDirection(direction)

property docked

Docked signal

Returns:
Return type:: QtCore.Signal

property undocked

Undocked signal

Returns:
Return type:: QtCore.Signal

setMainLayout(layout)

Set the main layout

Parameters:: layout
Returns:
Return type:

mainLayout()

Main Layout

Will generate a vBoxLayout if it is empty.

Returns:
Return type:

titleDoubleClicked(): Title double-clicked

isMinimized()

Window is minimized

Returns:
Return type:: bool

setMinimizeEnabled(enabled)

Parameters:: enabled (bool)

dockEvent(container)

Dock event

Returns:
Return type:

undockedEvent()

Undocked event

Returns:
Return type:

maximize(): Maximize UI

minimize(): Minimize UI

setUiMinimized(minimize)

Resizes the spacing, icons and hides only. It doesn’t resize the window.

Parameters:: minimize (bool)

showResizers()

Show resizers

Returns:
Return type:

hideResizers()

Hide resizers

Returns:
Return type:

hide(): Hide the window

show(move=None): Show the window

setTitleStyle(style)

Set title style

Parameters:: style – TitleStyle.Default or TitleStyle.Thin

titleStyle()

Get title style

Returns:

setLogoColor(color)

setMaxButtonVisible(vis)

setMinButtonVisible(vis)

centerToParent()

Center widget to parent

Returns:

showWindow()

setName(name)

Set the name of the widget

Parameters:: name
Returns:
Return type:

setTitle(text)

Set the title text

Parameters:: text
Returns:
Return type:

setResizable(active)

Window is resizable

Parameters:: active
Returns:
Return type:

attachFramelessWindow(show=False, saveWindowPref=True)

Attach widget to frameless window

Parameters:

show
saveWindowPref – Restores positions from saved settings

Returns:

Return type:

FramelessWindow

resizeWindow(width=-1, height=-1)

Parameters:

width (float)
height (float)

Returns:

keyPressEvent(event)

Key Press event

Parameters:: event
Returns:

property parentContainer

Returns:
Return type:: FramelessWindow or DockingContainer

isDocked()

Returns:
Return type:

setMovable(movable)

Movable through the titlebar

Parameters:: movable (bool)
Returns:
Return type:

movable()

close()

Close window

Returns:
Return type:

class ZooWindowThin(*args: Any, **kwargs: Any)

Bases: ZooWindow

Same as ZooWindow with modified title style

parentWindow()

Returns:
Return type:: QtWidgets.QWidget

getZooWindows()

Gets all frameless windows in the scene

Returns:: All found window widgets under the Maya window

Container Widgets 

class DockableMixin: Bases: object

class ContainerType

Bases: object

CT_DockingContainer = 1

CT_FramelessWindow = 2

class SideGrip(*args: Any, **kwargs: Any)

Bases: QFrame

resizeTop(delta)

resizeBottom(delta)

resizeLeft(delta)

resizeRight(delta)

mousePressEvent(event)

mouseMoveEvent(event)

mouseReleaseEvent(event)

class ContainerWidget(*args, **kwargs)

Bases: object

An abstract class that can be used in both container types, FramelessWindow and DockingContainer.

isDockingContainer()

Container widget can be either DockingContainer or FramelessWindow

Returns:

isFramelessWindow()

Container widget can be either DockingContainer or FramelessWindow

Returns:

setOnTop()

containerType()

Return container type

Returns:: ContainerType.CT_FramelessWindow or ContainerType.CT_DockingContainer
Return type:: int

setWidget(widget)

class FramelessWindow(*args: Any, **kwargs: Any)

Bases: QMainWindow, ContainerWidget

property gripSize

setGripSize(size)

setOnTop(onTop)

Set window on top

Parameters:: onTop
Returns:

saveWindowPref(): Magic property for the frameless window to parent to the maya window for macs Also saves the size and position

setTransparency(enabled)

Set transparency

Parameters:: enabled
Returns:
Return type:

setShadowEffectEnabled(enabled)

Set the shadow effect of the zoo window

Parameters:: enabled
Returns:

setWidget(widget)

Set widget. Same as the DockingContainer.

Parameters:: widget (QtWidgets.QWidget)
Returns:
Return type:

property zooWindow

setNewObjectName(widget)

Set new name based on widget

Parameters:: widget (QtWidgets.QWidget)

resizeEvent(event)

class DockingContainer(*args: Any, **kwargs: Any)

Bases: DockableMixin, QWidget, ContainerWidget

deleteControl(): Delete control

moveToMouse(): Move the window to the mouse

setWidget(widget: ZooWindow) → None

Set the main widget

Parameters:: widget (ZooWindow)
Returns:
Return type:

resizeEvent(event)

Parameters:: event (QtGui.QResizeEvent)
Returns:

showEvent(event)

Docking container show event.

Parameters:: event
Returns:

close(): Close windows

moveEvent(event: MockExt.QtGui.QMoveEvent) → None

Move event

Parameters:: event (QtGui.QMoveEvent)

enterEvent(event)

The enter event

Parameters:: event

undock()

For when the window is undocked

Returns:
Return type:

class SpawnerIcon(*args: Any, **kwargs: Any)

Bases: IconMenuButton

docked: alias of object

spawnSize = 35

mousePressEvent(event)

Mouse Press event

Parameters:: event

updateTheme(event)

Override update theme to ignore

Parameters:: event
Returns:

name()

Name should match frameless name.

If nothing found though, just generate a random one.

Returns:
Return type:

dockLocked()

initDockingContainer()

Initialize the docking container.

What this does is it creates a maya workspaceControl and moves the window into it. WorkspaceControls are used because it has docking functionality built-in.

It creates a small icon window, which can then be used to drag into a docked position in Maya.

Returns:
Return type:

workspaceFloating()

Is floating or not

Returns:
Return type:

mouseMoveEvent(event)

Mouse move event

Parameters:: event (QtGui.QMouseEvent)
Returns:
Return type:

moveToMouse()

Move the window to the mouse

Returns:
Return type:

mouseReleaseEvent(event)

Mouse Release event

Parameters:: event
Returns:
Return type:

dockedEvent()

The dockedEvent when docked into Maya.

Returns:
Return type:

arrangeSplitters(w)

If docked into splitter widgets, fix the splitter sizes

Parameters:: w
Returns:

splitterAncestor(w)

Get the widgets splitter ancestors

Parameters:: w
Returns:

deleteControl()

Delete workspace control

Returns:
Return type:

setLogoHighlight(highlight)

Set the logo highlight

Parameters:: highlight (bool)
Returns:
Return type:

toggleToolTips(taggedAction)

Parameters:: taggedAction
Type:: zoo.libs.pyqt.extended.searchablemenu.action.TaggedAction
Returns:

zooToolsProHelp(): Zoo Tools pro help

create3dCharactersAction()

The menu button to open to create 3d characters webpage

Returns:
Return type:

Widgets 

class ResizeDirection

Bases: object

Flag attributes to tell what position the resizer is

Left = 1

Top = 2

Right = 4

Bottom = 8

class TitleBar(*args: Any, **kwargs: Any)

Bases: QFrame

moving: alias of object

class TitleStyle

Bases: object

Default = 'DEFAULT'

Thin = 'THIN'

VerticalThin = 'VERTICAL_THIN'

setDirection(direction)

setDebugColors(debug)

initUi(): Init UI

setTitleSpacing(spacing)

Parameters:: spacing
Returns:

setTitleAlign(align)

Set Title Align

Parameters:: align

setDockable(dockable)

setMoveEnabled(enabled)

Window moving enabled

Parameters:: enabled
Returns:
Return type:

setTitleStyle(style)

Set the title style

Parameters:: style (TitleStyle)
Returns:: TitleStyle.Default or TitleStyle.Thin
Return type:

moveEnabled()

If the titlebar can drive movement.

Returns:
Return type:

setMaxButtonVisible(vis)

Set max button visible

Parameters:: vis
Returns:
Return type:

setMinButtonVisible(vis)

Set Minimize button visible

Parameters:: vis
Returns:
Return type:

titleStyle()

Return the title style

Returns:
Return type:

previousTitleStyle()

mouseDoubleClickEvent(event)

Mouse double clicked event

Parameters:: event (QtGui.QMouseEvent)
Returns:
Return type:

setLogoHighlight(highlight)

Set logo highlight.

Highlight the logo

Parameters:: highlight
Returns:
Return type:

refreshTitleBar()

Workaround for mainLayout not showing

Returns:

setTitleText(value='')

The text of the title bar in the window

Parameters:: value
Returns:
Return type:

openHelp()

Open help url

Returns:

setWindowIconSize(size): Sets the icon size of the titlebar icons :param size: :return:

setMaximiseVisible(show=True)

Set Maximise button visible

Parameters:: show

setMinimiseVisible(show=True)

Set minimize button visibility

Parameters:: show

toggleContents(): Show or hide the additional contents in the titlebar

mousePressEvent(event)

Mouse click event to start the moving of the window

mouseReleaseEvent(event)

Mouse release for title bar

startMove()

endMove()

mouseMoveEvent(event)

Move the window based on if the titlebar has been clicked or not

class FramelessOverlay(*args: Any, **kwargs: Any)

Bases: OverlayWidget

mousePressEvent(event)

Alt-Middle click to move window

Parameters:: event
Returns:

classmethod isModifier()

mouseReleaseEvent(event)

Send events back down to parent

Parameters:: event
Returns:

mouseMoveEvent(event)

Parameters:: event

quadrant()

Get the quadrant of where the mouse is pointed, and return the direction

Returns:: The direction ResizeDirection
Return type:: ResizeDirection

show()

setEnabled(enabled)

updateStyleSheet()

Set style sheet

Returns:

class WindowContents(*args: Any, **kwargs: Any)

Bases: QFrame

For CSS purposes

class TitleLabel(*args: Any, **kwargs: Any)

Bases: ClippedLabel

For CSS purposes

Frameless

Window

Container Widgets

Widgets

Window 

Container Widgets 

Widgets 