Skip to content

qtutils

Type hints for rv.qtutils module.

dockWidget(widget, title, area=None, parent=None)

Dock a widget in the RV interface.

Parameters:

Name Type Description Default
widget QWidget

The widget to dock

required
title str

Title of the dock widget

required
area Optional[int]

Dock area to use (Qt.DockWidgetArea)

None
parent Optional[QMainWindow]

Parent window, defaults to sessionWindow()

None

Returns:

Type Description
QDockWidget

QtWidgets.QDockWidget: The created dock widget

Source code in client/ayon_openrv/typing/rv/qtutils/__init__.py
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def dockWidget(widget: QtWidgets.QWidget, 
               title: str, 
               area: Optional[int] = None, 
               parent: Optional[QtWidgets.QMainWindow] = None) -> QtWidgets.QDockWidget:
    """
    Dock a widget in the RV interface.

    Args:
        widget (QtWidgets.QWidget): The widget to dock
        title (str): Title of the dock widget
        area (Optional[int]): Dock area to use (Qt.DockWidgetArea)
        parent (Optional[QtWidgets.QMainWindow]): Parent window, defaults to sessionWindow()

    Returns:
        QtWidgets.QDockWidget: The created dock widget
    """
    ...

getLayer()

Returns the current layer.

Returns:

Name Type Description
Any Any

The current layer object.

Source code in client/ayon_openrv/typing/rv/qtutils/__init__.py
16
17
18
19
20
21
22
23
def getLayer() -> Any:
    """
    Returns the current layer.

    Returns:
        Any: The current layer object.
    """
    ...

getView()

Returns the current view.

Returns:

Name Type Description
Any Any

The current view object.

Source code in client/ayon_openrv/typing/rv/qtutils/__init__.py
25
26
27
28
29
30
31
32
def getView() -> Any:
    """
    Returns the current view.

    Returns:
        Any: The current view object.
    """
    ...

sessionWindow()

Returns the main window for the current RV session.

Returns:

Type Description
QMainWindow

QtWidgets.QMainWindow: The main RV application window.

Source code in client/ayon_openrv/typing/rv/qtutils/__init__.py
 7
 8
 9
10
11
12
13
14
def sessionWindow() -> QtWidgets.QMainWindow:
    """
    Returns the main window for the current RV session.

    Returns:
        QtWidgets.QMainWindow: The main RV application window.
    """
    ...