ShotGrid Search Widget

The ShotGrid search widgets are similar to the global search and hierarchical search found in ShotGrid. They return a number of matches based on text that is being typed in by the user.

_images/global_search.png

Once a user selects an object, a signal fires to indicate the request.

class shotgun_search_widget.GlobalSearchWidget(parent)[source]

A QT Widget deriving from QLineEdit that creates a global search input box with auto completion.

Signal:

entity_selected(str, int) - Fires when someone selects an entity inside the search results. The returned parameters are entity type and entity id.

Signal:

entity_activated(str, int, str) - Fires when someone selects an entity inside the search results. Similar to entity_selected, with the addition of the name of the activated entity being supplied.

Uses the GlobalSearchCompleter as the completer for searching SG entities.

Parameters:

parent (QWidget) – Qt parent object

set_searchable_entity_types(types_dict)[source]

Specify a dictionary of entity types with optional search filters to limit the breadth of the widget’s search.

See the documentation for GlobalSearchCompleter.set_searchable_entity_types for the default values if this method is not called on the widget.

Parameters:

types_dict – A dictionary of searchable types with optional filters

acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, event: PySide2.QtGui.QActionEvent) None
actions(self) List[PySide2.QtWidgets.QAction]
activateWindow(self) None
addAction(self, action: PySide2.QtWidgets.QAction) None
addAction(self, action: PySide2.QtWidgets.QAction, position: PySide2.QtWidgets.QLineEdit.ActionPosition) None
addAction(self, arg__1: PySide2.QtWidgets.QAction) None
addAction(self, icon: PySide2.QtGui.QIcon, position: PySide2.QtWidgets.QLineEdit.ActionPosition) PySide2.QtWidgets.QAction
addActions(self, actions: Sequence[PySide2.QtWidgets.QAction]) None
adjustSize(self) None
alignment(self) PySide2.QtCore.Qt.Alignment
autoFillBackground(self) bool
backgroundRole(self) PySide2.QtGui.QPalette.ColorRole
backingStore(self) PySide2.QtGui.QBackingStore
backspace(self) None
baseSize(self) PySide2.QtCore.QSize
blockSignals(self, b: bool) bool
changeEvent(self, arg__1: PySide2.QtCore.QEvent) None
childAt(self, p: PySide2.QtCore.QPoint) PySide2.QtWidgets.QWidget
childAt(self, x: int, y: int) PySide2.QtWidgets.QWidget
childEvent(self, event: PySide2.QtCore.QChildEvent) None
children(self) List[PySide2.QtCore.QObject]
childrenRect(self) PySide2.QtCore.QRect
childrenRegion(self) PySide2.QtGui.QRegion
clear()

Clears the search box.

clearFocus(self) None
clearMask(self) None
close(self) bool
closeEvent(self, event: PySide2.QtGui.QCloseEvent) None
colorCount(self) int
completer(self) PySide2.QtWidgets.QCompleter
static connect(arg__1: PySide2.QtCore.QObject, arg__2: bytes, arg__3: Callable, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) bool
static connect(self, arg__1: bytes, arg__2: Callable, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) bool
static connect(self, arg__1: bytes, arg__2: PySide2.QtCore.QObject, arg__3: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) bool
static connect(self, sender: PySide2.QtCore.QObject, signal: bytes, member: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) PySide2.QtCore.QMetaObject.Connection
static connect(sender: PySide2.QtCore.QObject, signal: PySide2.QtCore.QMetaMethod, receiver: PySide2.QtCore.QObject, method: PySide2.QtCore.QMetaMethod, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) PySide2.QtCore.QMetaObject.Connection
static connect(sender: PySide2.QtCore.QObject, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) PySide2.QtCore.QMetaObject.Connection
connectNotify(self, signal: PySide2.QtCore.QMetaMethod) None
contentsMargins(self) PySide2.QtCore.QMargins
contentsRect(self) PySide2.QtCore.QRect
contextMenuEvent(self, arg__1: PySide2.QtGui.QContextMenuEvent) None
contextMenuPolicy(self) PySide2.QtCore.Qt.ContextMenuPolicy
copy(self) None
create(self, arg__1: int = 0, initializeWindow: bool = True, destroyOldWindow: bool = True) None
createStandardContextMenu(self) PySide2.QtWidgets.QMenu
createWinId(self) None
static createWindowContainer(window: PySide2.QtGui.QWindow, parent: Optional[PySide2.QtWidgets.QWidget] = None, flags: PySide2.QtCore.Qt.WindowFlags = Default(Qt.WindowFlags)) PySide2.QtWidgets.QWidget
cursor(self) PySide2.QtGui.QCursor
cursorBackward(self, mark: bool, steps: int = 1) None
cursorForward(self, mark: bool, steps: int = 1) None
cursorMoveStyle(self) PySide2.QtCore.Qt.CursorMoveStyle
cursorPosition(self) int
cursorPositionAt(self, pos: PySide2.QtCore.QPoint) int
cursorRect(self) PySide2.QtCore.QRect
cursorWordBackward(self, mark: bool) None
cursorWordForward(self, mark: bool) None
customEvent(self, event: PySide2.QtCore.QEvent) None
cut(self) None
del_(self) None
deleteLater(self) None
depth(self) int
deselect(self) None
destroy()

Should be called before the widget is closed.

devType(self) int
devicePixelRatio(self) int
devicePixelRatioF(self) float
static devicePixelRatioFScale() float
static disconnect(arg__1: PySide2.QtCore.QMetaObject.Connection) bool
static disconnect(arg__1: PySide2.QtCore.QObject, arg__2: bytes, arg__3: Callable) bool
static disconnect(self, arg__1: bytes, arg__2: Callable) bool
static disconnect(self, receiver: PySide2.QtCore.QObject, member: Optional[bytes] = None) bool
static disconnect(self, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes) bool
static disconnect(sender: PySide2.QtCore.QObject, signal: PySide2.QtCore.QMetaMethod, receiver: PySide2.QtCore.QObject, member: PySide2.QtCore.QMetaMethod) bool
static disconnect(sender: PySide2.QtCore.QObject, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes) bool
disconnectNotify(self, signal: PySide2.QtCore.QMetaMethod) None
displayText(self) str
dragEnabled(self) bool
dragEnterEvent(self, arg__1: PySide2.QtGui.QDragEnterEvent) None
dragLeaveEvent(self, e: PySide2.QtGui.QDragLeaveEvent) None
dragMoveEvent(self, e: PySide2.QtGui.QDragMoveEvent) None
dropEvent(self, arg__1: PySide2.QtGui.QDropEvent) None
dumpObjectInfo(self) None
dumpObjectTree(self) None
dynamicPropertyNames(self) List[PySide2.QtCore.QByteArray]
echoMode(self) PySide2.QtWidgets.QLineEdit.EchoMode
effectiveWinId(self) int
emit(self, arg__1: bytes, *args: None) bool
end(self, mark: bool) None
ensurePolished(self) None
enterEvent(self, event: PySide2.QtCore.QEvent) None
event(self, arg__1: PySide2.QtCore.QEvent) bool
eventFilter(self, watched: PySide2.QtCore.QObject, event: PySide2.QtCore.QEvent) bool
static find(arg__1: int) PySide2.QtWidgets.QWidget
findChild(self, arg__1: type, arg__2: str = '') object
findChildren(self, arg__1: type, arg__2: PySide2.QtCore.QRegExp) Iterable
findChildren(self, arg__1: type, arg__2: PySide2.QtCore.QRegularExpression) Iterable
findChildren(self, arg__1: type, arg__2: str = '') Iterable
focusInEvent(self, arg__1: PySide2.QtGui.QFocusEvent) None
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, arg__1: PySide2.QtGui.QFocusEvent) None
focusPolicy(self) PySide2.QtCore.Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) PySide2.QtWidgets.QWidget
focusWidget(self) PySide2.QtWidgets.QWidget
font(self) PySide2.QtGui.QFont
fontInfo(self) PySide2.QtGui.QFontInfo
fontMetrics(self) PySide2.QtGui.QFontMetrics
foregroundRole(self) PySide2.QtGui.QPalette.ColorRole
frameGeometry(self) PySide2.QtCore.QRect
frameSize(self) PySide2.QtCore.QSize
geometry(self) PySide2.QtCore.QRect
getContentsMargins(self) Tuple[int, int, int, int]
getTextMargins(self) Tuple[int, int, int, int]
grab(self, rectangle: PySide2.QtCore.QRect = PySide2.QtCore.QRect(0, 0, -1, -1)) PySide2.QtGui.QPixmap
grabGesture(self, type: PySide2.QtCore.Qt.GestureType, flags: PySide2.QtCore.Qt.GestureFlags = Default(Qt.GestureFlags)) None
grabKeyboard(self) None
grabMouse(self) None
grabMouse(self, arg__1: PySide2.QtGui.QCursor) None
grabShortcut(self, key: PySide2.QtGui.QKeySequence, context: PySide2.QtCore.Qt.ShortcutContext = PySide2.QtCore.Qt.ShortcutContext.WindowShortcut) int
graphicsEffect(self) PySide2.QtWidgets.QGraphicsEffect
graphicsProxyWidget(self) PySide2.QtWidgets.QGraphicsProxyWidget
hasAcceptableInput(self) bool
hasFocus(self) bool
hasFrame(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasSelectedText(self) bool
hasTabletTracking(self) bool
height(self) int
heightForWidth(self, arg__1: int) int
heightMM(self) int
hide(self) None
hideEvent(self, event: PySide2.QtGui.QHideEvent) None
home(self, mark: bool) None
inherits(self, classname: bytes) bool
initPainter(self, painter: PySide2.QtGui.QPainter) None
initStyleOption(self, option: PySide2.QtWidgets.QStyleOptionFrame) None
inputMask(self) str
inputMethodEvent(self, arg__1: PySide2.QtGui.QInputMethodEvent) None
inputMethodHints(self) PySide2.QtCore.Qt.InputMethodHints
inputMethodQuery(self, arg__1: PySide2.QtCore.Qt.InputMethodQuery) Any
inputMethodQuery(self, property: PySide2.QtCore.Qt.InputMethodQuery, argument: Any) Any
insert(self, arg__1: str) None
insertAction(self, before: PySide2.QtWidgets.QAction, action: PySide2.QtWidgets.QAction) None
insertActions(self, before: PySide2.QtWidgets.QAction, actions: Sequence[PySide2.QtWidgets.QAction]) None
installEventFilter(self, filterObj: PySide2.QtCore.QObject) None
internalWinId(self) int
isActiveWindow(self) bool
isAncestorOf(self, child: PySide2.QtWidgets.QWidget) bool
isClearButtonEnabled(self) bool
isEnabled(self) bool
isEnabledTo(self, arg__1: PySide2.QtWidgets.QWidget) bool
isEnabledToTLW(self) bool
isFullScreen(self) bool
isHidden(self) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isModified(self) bool
isReadOnly(self) bool
isRedoAvailable(self) bool
isRightToLeft(self) bool
isSignalConnected(self, signal: PySide2.QtCore.QMetaMethod) bool
isTopLevel(self) bool
isUndoAvailable(self) bool
isVisible(self) bool
isVisibleTo(self, arg__1: PySide2.QtWidgets.QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
keyPressEvent(event)

Clears the line edit when the user hits escape.

keyReleaseEvent(self, event: PySide2.QtGui.QKeyEvent) None
static keyboardGrabber() PySide2.QtWidgets.QWidget
killTimer(self, id: int) None
layout(self) PySide2.QtWidgets.QLayout
layoutDirection(self) PySide2.QtCore.Qt.LayoutDirection
leaveEvent(self, event: PySide2.QtCore.QEvent) None
locale(self) PySide2.QtCore.QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self) None
mapFrom(self, arg__1: PySide2.QtWidgets.QWidget, arg__2: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapFromGlobal(self, arg__1: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapFromParent(self, arg__1: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapTo(self, arg__1: PySide2.QtWidgets.QWidget, arg__2: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapToGlobal(self, arg__1: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapToParent(self, arg__1: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mask(self) PySide2.QtGui.QRegion
maxLength(self) int
maximumHeight(self) int
maximumSize(self) PySide2.QtCore.QSize
maximumWidth(self) int
metaObject(self) PySide2.QtCore.QMetaObject
metric(self, arg__1: PySide2.QtGui.QPaintDevice.PaintDeviceMetric) int
minimumHeight(self) int
minimumSize(self) PySide2.QtCore.QSize
minimumSizeHint(self) PySide2.QtCore.QSize
minimumWidth(self) int
mouseDoubleClickEvent(self, arg__1: PySide2.QtGui.QMouseEvent) None
static mouseGrabber() PySide2.QtWidgets.QWidget
mouseMoveEvent(self, arg__1: PySide2.QtGui.QMouseEvent) None
mousePressEvent(self, arg__1: PySide2.QtGui.QMouseEvent) None
mouseReleaseEvent(self, arg__1: PySide2.QtGui.QMouseEvent) None
move(self, arg__1: PySide2.QtCore.QPoint) None
move(self, x: int, y: int) None
moveEvent(self, event: PySide2.QtGui.QMoveEvent) None
moveToThread(self, thread: PySide2.QtCore.QThread) None
nativeEvent(self, eventType: PySide2.QtCore.QByteArray, message: int) Tuple[bool, int]
nativeParentWidget(self) PySide2.QtWidgets.QWidget
nextInFocusChain(self) PySide2.QtWidgets.QWidget
normalGeometry(self) PySide2.QtCore.QRect
objectName(self) str
overrideWindowFlags(self, type: PySide2.QtCore.Qt.WindowFlags) None
overrideWindowState(self, state: PySide2.QtCore.Qt.WindowStates) None
paintEngine(self) PySide2.QtGui.QPaintEngine
paintEvent(self, arg__1: PySide2.QtGui.QPaintEvent) None
paintingActive(self) bool
palette(self) PySide2.QtGui.QPalette
parent(self) PySide2.QtCore.QObject
parentWidget(self) PySide2.QtWidgets.QWidget
paste(self) None
physicalDpiX(self) int
physicalDpiY(self) int
placeholderText(self) str
pos(self) PySide2.QtCore.QPoint
previousInFocusChain(self) PySide2.QtWidgets.QWidget
property(self, name: bytes) Any
raise_(self) None
receivers(self, signal: bytes) int
rect(self) PySide2.QtCore.QRect
redirected(self, offset: PySide2.QtCore.QPoint) PySide2.QtGui.QPaintDevice
redo(self) None
static registerUserData() int
releaseKeyboard(self) None
releaseMouse(self) None
releaseShortcut(self, id: int) None
removeAction(self, action: PySide2.QtWidgets.QAction) None
removeEventFilter(self, obj: PySide2.QtCore.QObject) None
render(self, painter: PySide2.QtGui.QPainter, targetOffset: PySide2.QtCore.QPoint, sourceRegion: PySide2.QtGui.QRegion = Default(QRegion), renderFlags: PySide2.QtWidgets.QWidget.RenderFlags = Instance(QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))) None
render(self, target: PySide2.QtGui.QPaintDevice, targetOffset: PySide2.QtCore.QPoint = Default(QPoint), sourceRegion: PySide2.QtGui.QRegion = Default(QRegion), renderFlags: PySide2.QtWidgets.QWidget.RenderFlags = Instance(QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))) None
repaint(self) None
repaint(self, arg__1: PySide2.QtCore.QRect) None
repaint(self, arg__1: PySide2.QtGui.QRegion) None
repaint(self, x: int, y: int, w: int, h: int) None
resize(self, arg__1: PySide2.QtCore.QSize) None
resize(self, w: int, h: int) None
resizeEvent(self, event: PySide2.QtGui.QResizeEvent) None
restoreGeometry(self, geometry: PySide2.QtCore.QByteArray) bool
saveGeometry(self) PySide2.QtCore.QByteArray
screen(self) PySide2.QtGui.QScreen
scroll(self, dx: int, dy: int) None
scroll(self, dx: int, dy: int, arg__3: PySide2.QtCore.QRect) None
selectAll(self) None
selectedText(self) str
selectionEnd(self) int
selectionLength(self) int
selectionStart(self) int
sender(self) PySide2.QtCore.QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool) None
setAccessibleDescription(self, description: str) None
setAccessibleName(self, name: str) None
setAlignment(self, flag: PySide2.QtCore.Qt.Alignment) None
setAttribute(self, arg__1: PySide2.QtCore.Qt.WidgetAttribute, on: bool = True) None
setAutoFillBackground(self, enabled: bool) None
setBackgroundRole(self, arg__1: PySide2.QtGui.QPalette.ColorRole) None
setBaseSize(self, arg__1: PySide2.QtCore.QSize) None
setBaseSize(self, basew: int, baseh: int) None
setClearButtonEnabled(self, enable: bool) None
setCompleter(self, completer: PySide2.QtWidgets.QCompleter) None
setContentsMargins(self, left: int, top: int, right: int, bottom: int) None
setContentsMargins(self, margins: PySide2.QtCore.QMargins) None
setContextMenuPolicy(self, policy: PySide2.QtCore.Qt.ContextMenuPolicy) None
setCursor(self, arg__1: PySide2.QtGui.QCursor) None
setCursorMoveStyle(self, style: PySide2.QtCore.Qt.CursorMoveStyle) None
setCursorPosition(self, arg__1: int) None
setDisabled(self, arg__1: bool) None
setDragEnabled(self, b: bool) None
setEchoMode(self, arg__1: PySide2.QtWidgets.QLineEdit.EchoMode) None
setEnabled(self, arg__1: bool) None
setFixedHeight(self, h: int) None
setFixedSize(self, arg__1: PySide2.QtCore.QSize) None
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int) None
setFocus(self) None
setFocus(self, reason: PySide2.QtCore.Qt.FocusReason) None
setFocusPolicy(self, policy: PySide2.QtCore.Qt.FocusPolicy) None
setFocusProxy(self, arg__1: PySide2.QtWidgets.QWidget) None
setFont(self, arg__1: PySide2.QtGui.QFont) None
setForegroundRole(self, arg__1: PySide2.QtGui.QPalette.ColorRole) None
setFrame(self, arg__1: bool) None
setGeometry(self, arg__1: PySide2.QtCore.QRect) None
setGeometry(self, x: int, y: int, w: int, h: int) None
setGraphicsEffect(self, effect: PySide2.QtWidgets.QGraphicsEffect) None
setHidden(self, hidden: bool) None
setInputMask(self, inputMask: str) None
setInputMethodHints(self, hints: PySide2.QtCore.Qt.InputMethodHints) None
setLayout(self, arg__1: PySide2.QtWidgets.QLayout) None
setLayoutDirection(self, direction: PySide2.QtCore.Qt.LayoutDirection) None
setLocale(self, locale: PySide2.QtCore.QLocale) None
setMask(self, arg__1: PySide2.QtGui.QBitmap) None
setMask(self, arg__1: PySide2.QtGui.QRegion) None
setMaxLength(self, arg__1: int) None
setMaximumHeight(self, maxh: int) None
setMaximumSize(self, arg__1: PySide2.QtCore.QSize) None
setMaximumSize(self, maxw: int, maxh: int) None
setMaximumWidth(self, maxw: int) None
setMinimumHeight(self, minh: int) None
setMinimumSize(self, arg__1: PySide2.QtCore.QSize) None
setMinimumSize(self, minw: int, minh: int) None
setMinimumWidth(self, minw: int) None
setModified(self, arg__1: bool) None
setMouseTracking(self, enable: bool) None
setObjectName(self, name: str) None
setPalette(self, arg__1: PySide2.QtGui.QPalette) None
setParent(self, parent: PySide2.QtCore.QObject) None
setParent(self, parent: PySide2.QtWidgets.QWidget) None
setParent(self, parent: PySide2.QtWidgets.QWidget, f: PySide2.QtCore.Qt.WindowFlags) None
setPlaceholderText(self, arg__1: str) None
setProperty(self, name: bytes, value: Any) bool
setReadOnly(self, arg__1: bool) None
setSelection(self, arg__1: int, arg__2: int) None
setShortcutAutoRepeat(self, id: int, enable: bool = True) None
setShortcutEnabled(self, id: int, enable: bool = True) None
setSizeIncrement(self, arg__1: PySide2.QtCore.QSize) None
setSizeIncrement(self, w: int, h: int) None
setSizePolicy(self, arg__1: PySide2.QtWidgets.QSizePolicy) None
setSizePolicy(self, horizontal: PySide2.QtWidgets.QSizePolicy.Policy, vertical: PySide2.QtWidgets.QSizePolicy.Policy) None
setStatusTip(self, arg__1: str) None
setStyle(self, arg__1: PySide2.QtWidgets.QStyle) None
setStyleSheet(self, styleSheet: str) None
static setTabOrder(arg__1: PySide2.QtWidgets.QWidget, arg__2: PySide2.QtWidgets.QWidget) None
setTabletTracking(self, enable: bool) None
setText(self, arg__1: str) None
setTextMargins(self, left: int, top: int, right: int, bottom: int) None
setTextMargins(self, margins: PySide2.QtCore.QMargins) None
setToolTip(self, arg__1: str) None
setToolTipDuration(self, msec: int) None
setUpdatesEnabled(self, enable: bool) None
setValidator(self, arg__1: PySide2.QtGui.QValidator) None
setVisible(self, visible: bool) None
setWhatsThis(self, arg__1: str) None
setWindowFilePath(self, filePath: str) None
setWindowFlag(self, arg__1: PySide2.QtCore.Qt.WindowType, on: bool = True) None
setWindowFlags(self, type: PySide2.QtCore.Qt.WindowFlags) None
setWindowIcon(self, icon: PySide2.QtGui.QIcon) None
setWindowIconText(self, arg__1: str) None
setWindowModality(self, windowModality: PySide2.QtCore.Qt.WindowModality) None
setWindowModified(self, arg__1: bool) None
setWindowOpacity(self, level: float) None
setWindowRole(self, arg__1: str) None
setWindowState(self, state: PySide2.QtCore.Qt.WindowStates) None
setWindowTitle(self, arg__1: str) None
set_bg_task_manager(task_manager)

Specify the background task manager to use to pull data in the background. Data calls to Shotgun will be dispatched via this object.

Parameters:

task_manager (BackgroundTaskManager) – Background task manager to use

set_placeholder_text(text)

Set the placeholder text for the widget

Parameters:

text – The text to use

sharedPainter(self) PySide2.QtGui.QPainter
show(self) None
showEvent(self, event: PySide2.QtGui.QShowEvent) None
showFullScreen(self) None
showMaximized(self) None
showMinimized(self) None
showNormal(self) None
signalsBlocked(self) bool
size(self) PySide2.QtCore.QSize
sizeHint(self) PySide2.QtCore.QSize
sizeIncrement(self) PySide2.QtCore.QSize
sizePolicy(self) PySide2.QtWidgets.QSizePolicy
stackUnder(self, arg__1: PySide2.QtWidgets.QWidget) None
startTimer(self, interval: int, timerType: PySide2.QtCore.Qt.TimerType = PySide2.QtCore.Qt.TimerType.CoarseTimer) int
statusTip(self) str
style(self) PySide2.QtWidgets.QStyle
styleSheet(self) str
tabletEvent(self, event: PySide2.QtGui.QTabletEvent) None
testAttribute(self, arg__1: PySide2.QtCore.Qt.WidgetAttribute) bool
text(self) str
textMargins(self) PySide2.QtCore.QMargins
thread(self) PySide2.QtCore.QThread
timerEvent(self, event: PySide2.QtCore.QTimerEvent) None
toolTip(self) str
toolTipDuration(self) int
topLevelWidget(self) PySide2.QtWidgets.QWidget
tr(self, arg__1: bytes, arg__2: bytes = b'', arg__3: int = -1) str
underMouse(self) bool
undo(self) None
ungrabGesture(self, type: PySide2.QtCore.Qt.GestureType) None
unsetCursor(self) None
unsetLayoutDirection(self) None
unsetLocale(self) None
update(self) None
update(self, arg__1: PySide2.QtCore.QRect) None
update(self, arg__1: PySide2.QtGui.QRegion) None
update(self, x: int, y: int, w: int, h: int) None
updateGeometry(self) None
updateMicroFocus(self) None
updatesEnabled(self) bool
validator(self) PySide2.QtGui.QValidator
visibleRegion(self) PySide2.QtGui.QRegion
whatsThis(self) str
wheelEvent(self, event: PySide2.QtGui.QWheelEvent) None
width(self) int
widthMM(self) int
winId(self) int
window(self) PySide2.QtWidgets.QWidget
windowFilePath(self) str
windowFlags(self) PySide2.QtCore.Qt.WindowFlags
windowHandle(self) PySide2.QtGui.QWindow
windowIcon(self) PySide2.QtGui.QIcon
windowIconText(self) str
windowModality(self) PySide2.QtCore.Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) PySide2.QtCore.Qt.WindowStates
windowTitle(self) str
windowType(self) PySide2.QtCore.Qt.WindowType
x(self) int
y(self) int
class shotgun_search_widget.HierarchicalSearchWidget(parent)[source]

A QT Widget deriving from QLineEdit that creates a hierarchical search input box with auto completion.

If defaults to searching inside the current context’s project and to only show entities.

Signal:

node_activated(str, int, str, str, list) - Fires when someone activates a node inside the search results. The parameters are type, id, name, label path and incremental_paths. If the node activated is not an entity, type and id will be None.

Uses the HierarchicalSearchCompleter as the completer for searching SG entities.

Parameters:

parent (QWidget) – Qt parent object

property search_root

The entity under which the search will be done. If None, the search will be done for the whole site.

The entity is a dict with keys id and type. Note that only Project entities are supported at the moment.

property show_entities_only

Indicates if only entities will be shown in the search results.

If set to True, only entities will be shown.

acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, event: PySide2.QtGui.QActionEvent) None
actions(self) List[PySide2.QtWidgets.QAction]
activateWindow(self) None
addAction(self, action: PySide2.QtWidgets.QAction) None
addAction(self, action: PySide2.QtWidgets.QAction, position: PySide2.QtWidgets.QLineEdit.ActionPosition) None
addAction(self, arg__1: PySide2.QtWidgets.QAction) None
addAction(self, icon: PySide2.QtGui.QIcon, position: PySide2.QtWidgets.QLineEdit.ActionPosition) PySide2.QtWidgets.QAction
addActions(self, actions: Sequence[PySide2.QtWidgets.QAction]) None
adjustSize(self) None
alignment(self) PySide2.QtCore.Qt.Alignment
autoFillBackground(self) bool
backgroundRole(self) PySide2.QtGui.QPalette.ColorRole
backingStore(self) PySide2.QtGui.QBackingStore
backspace(self) None
baseSize(self) PySide2.QtCore.QSize
blockSignals(self, b: bool) bool
changeEvent(self, arg__1: PySide2.QtCore.QEvent) None
childAt(self, p: PySide2.QtCore.QPoint) PySide2.QtWidgets.QWidget
childAt(self, x: int, y: int) PySide2.QtWidgets.QWidget
childEvent(self, event: PySide2.QtCore.QChildEvent) None
children(self) List[PySide2.QtCore.QObject]
childrenRect(self) PySide2.QtCore.QRect
childrenRegion(self) PySide2.QtGui.QRegion
clear()

Clears the search box.

clearFocus(self) None
clearMask(self) None
close(self) bool
closeEvent(self, event: PySide2.QtGui.QCloseEvent) None
colorCount(self) int
completer(self) PySide2.QtWidgets.QCompleter
static connect(arg__1: PySide2.QtCore.QObject, arg__2: bytes, arg__3: Callable, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) bool
static connect(self, arg__1: bytes, arg__2: Callable, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) bool
static connect(self, arg__1: bytes, arg__2: PySide2.QtCore.QObject, arg__3: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) bool
static connect(self, sender: PySide2.QtCore.QObject, signal: bytes, member: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) PySide2.QtCore.QMetaObject.Connection
static connect(sender: PySide2.QtCore.QObject, signal: PySide2.QtCore.QMetaMethod, receiver: PySide2.QtCore.QObject, method: PySide2.QtCore.QMetaMethod, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) PySide2.QtCore.QMetaObject.Connection
static connect(sender: PySide2.QtCore.QObject, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes, type: PySide2.QtCore.Qt.ConnectionType = PySide2.QtCore.Qt.ConnectionType.AutoConnection) PySide2.QtCore.QMetaObject.Connection
connectNotify(self, signal: PySide2.QtCore.QMetaMethod) None
contentsMargins(self) PySide2.QtCore.QMargins
contentsRect(self) PySide2.QtCore.QRect
contextMenuEvent(self, arg__1: PySide2.QtGui.QContextMenuEvent) None
contextMenuPolicy(self) PySide2.QtCore.Qt.ContextMenuPolicy
copy(self) None
create(self, arg__1: int = 0, initializeWindow: bool = True, destroyOldWindow: bool = True) None
createStandardContextMenu(self) PySide2.QtWidgets.QMenu
createWinId(self) None
static createWindowContainer(window: PySide2.QtGui.QWindow, parent: Optional[PySide2.QtWidgets.QWidget] = None, flags: PySide2.QtCore.Qt.WindowFlags = Default(Qt.WindowFlags)) PySide2.QtWidgets.QWidget
cursor(self) PySide2.QtGui.QCursor
cursorBackward(self, mark: bool, steps: int = 1) None
cursorForward(self, mark: bool, steps: int = 1) None
cursorMoveStyle(self) PySide2.QtCore.Qt.CursorMoveStyle
cursorPosition(self) int
cursorPositionAt(self, pos: PySide2.QtCore.QPoint) int
cursorRect(self) PySide2.QtCore.QRect
cursorWordBackward(self, mark: bool) None
cursorWordForward(self, mark: bool) None
customEvent(self, event: PySide2.QtCore.QEvent) None
cut(self) None
del_(self) None
deleteLater(self) None
depth(self) int
deselect(self) None
destroy()

Should be called before the widget is closed.

devType(self) int
devicePixelRatio(self) int
devicePixelRatioF(self) float
static devicePixelRatioFScale() float
static disconnect(arg__1: PySide2.QtCore.QMetaObject.Connection) bool
static disconnect(arg__1: PySide2.QtCore.QObject, arg__2: bytes, arg__3: Callable) bool
static disconnect(self, arg__1: bytes, arg__2: Callable) bool
static disconnect(self, receiver: PySide2.QtCore.QObject, member: Optional[bytes] = None) bool
static disconnect(self, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes) bool
static disconnect(sender: PySide2.QtCore.QObject, signal: PySide2.QtCore.QMetaMethod, receiver: PySide2.QtCore.QObject, member: PySide2.QtCore.QMetaMethod) bool
static disconnect(sender: PySide2.QtCore.QObject, signal: bytes, receiver: PySide2.QtCore.QObject, member: bytes) bool
disconnectNotify(self, signal: PySide2.QtCore.QMetaMethod) None
displayText(self) str
dragEnabled(self) bool
dragEnterEvent(self, arg__1: PySide2.QtGui.QDragEnterEvent) None
dragLeaveEvent(self, e: PySide2.QtGui.QDragLeaveEvent) None
dragMoveEvent(self, e: PySide2.QtGui.QDragMoveEvent) None
dropEvent(self, arg__1: PySide2.QtGui.QDropEvent) None
dumpObjectInfo(self) None
dumpObjectTree(self) None
dynamicPropertyNames(self) List[PySide2.QtCore.QByteArray]
echoMode(self) PySide2.QtWidgets.QLineEdit.EchoMode
effectiveWinId(self) int
emit(self, arg__1: bytes, *args: None) bool
end(self, mark: bool) None
ensurePolished(self) None
enterEvent(self, event: PySide2.QtCore.QEvent) None
event(self, arg__1: PySide2.QtCore.QEvent) bool
eventFilter(self, watched: PySide2.QtCore.QObject, event: PySide2.QtCore.QEvent) bool
static find(arg__1: int) PySide2.QtWidgets.QWidget
findChild(self, arg__1: type, arg__2: str = '') object
findChildren(self, arg__1: type, arg__2: PySide2.QtCore.QRegExp) Iterable
findChildren(self, arg__1: type, arg__2: PySide2.QtCore.QRegularExpression) Iterable
findChildren(self, arg__1: type, arg__2: str = '') Iterable
focusInEvent(self, arg__1: PySide2.QtGui.QFocusEvent) None
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, arg__1: PySide2.QtGui.QFocusEvent) None
focusPolicy(self) PySide2.QtCore.Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) PySide2.QtWidgets.QWidget
focusWidget(self) PySide2.QtWidgets.QWidget
font(self) PySide2.QtGui.QFont
fontInfo(self) PySide2.QtGui.QFontInfo
fontMetrics(self) PySide2.QtGui.QFontMetrics
foregroundRole(self) PySide2.QtGui.QPalette.ColorRole
frameGeometry(self) PySide2.QtCore.QRect
frameSize(self) PySide2.QtCore.QSize
geometry(self) PySide2.QtCore.QRect
getContentsMargins(self) Tuple[int, int, int, int]
getTextMargins(self) Tuple[int, int, int, int]
grab(self, rectangle: PySide2.QtCore.QRect = PySide2.QtCore.QRect(0, 0, -1, -1)) PySide2.QtGui.QPixmap
grabGesture(self, type: PySide2.QtCore.Qt.GestureType, flags: PySide2.QtCore.Qt.GestureFlags = Default(Qt.GestureFlags)) None
grabKeyboard(self) None
grabMouse(self) None
grabMouse(self, arg__1: PySide2.QtGui.QCursor) None
grabShortcut(self, key: PySide2.QtGui.QKeySequence, context: PySide2.QtCore.Qt.ShortcutContext = PySide2.QtCore.Qt.ShortcutContext.WindowShortcut) int
graphicsEffect(self) PySide2.QtWidgets.QGraphicsEffect
graphicsProxyWidget(self) PySide2.QtWidgets.QGraphicsProxyWidget
hasAcceptableInput(self) bool
hasFocus(self) bool
hasFrame(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasSelectedText(self) bool
hasTabletTracking(self) bool
height(self) int
heightForWidth(self, arg__1: int) int
heightMM(self) int
hide(self) None
hideEvent(self, event: PySide2.QtGui.QHideEvent) None
home(self, mark: bool) None
inherits(self, classname: bytes) bool
initPainter(self, painter: PySide2.QtGui.QPainter) None
initStyleOption(self, option: PySide2.QtWidgets.QStyleOptionFrame) None
inputMask(self) str
inputMethodEvent(self, arg__1: PySide2.QtGui.QInputMethodEvent) None
inputMethodHints(self) PySide2.QtCore.Qt.InputMethodHints
inputMethodQuery(self, arg__1: PySide2.QtCore.Qt.InputMethodQuery) Any
inputMethodQuery(self, property: PySide2.QtCore.Qt.InputMethodQuery, argument: Any) Any
insert(self, arg__1: str) None
insertAction(self, before: PySide2.QtWidgets.QAction, action: PySide2.QtWidgets.QAction) None
insertActions(self, before: PySide2.QtWidgets.QAction, actions: Sequence[PySide2.QtWidgets.QAction]) None
installEventFilter(self, filterObj: PySide2.QtCore.QObject) None
internalWinId(self) int
isActiveWindow(self) bool
isAncestorOf(self, child: PySide2.QtWidgets.QWidget) bool
isClearButtonEnabled(self) bool
isEnabled(self) bool
isEnabledTo(self, arg__1: PySide2.QtWidgets.QWidget) bool
isEnabledToTLW(self) bool
isFullScreen(self) bool
isHidden(self) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isModified(self) bool
isReadOnly(self) bool
isRedoAvailable(self) bool
isRightToLeft(self) bool
isSignalConnected(self, signal: PySide2.QtCore.QMetaMethod) bool
isTopLevel(self) bool
isUndoAvailable(self) bool
isVisible(self) bool
isVisibleTo(self, arg__1: PySide2.QtWidgets.QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
keyPressEvent(event)

Clears the line edit when the user hits escape.

keyReleaseEvent(self, event: PySide2.QtGui.QKeyEvent) None
static keyboardGrabber() PySide2.QtWidgets.QWidget
killTimer(self, id: int) None
layout(self) PySide2.QtWidgets.QLayout
layoutDirection(self) PySide2.QtCore.Qt.LayoutDirection
leaveEvent(self, event: PySide2.QtCore.QEvent) None
locale(self) PySide2.QtCore.QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self) None
mapFrom(self, arg__1: PySide2.QtWidgets.QWidget, arg__2: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapFromGlobal(self, arg__1: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapFromParent(self, arg__1: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapTo(self, arg__1: PySide2.QtWidgets.QWidget, arg__2: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapToGlobal(self, arg__1: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mapToParent(self, arg__1: PySide2.QtCore.QPoint) PySide2.QtCore.QPoint
mask(self) PySide2.QtGui.QRegion
maxLength(self) int
maximumHeight(self) int
maximumSize(self) PySide2.QtCore.QSize
maximumWidth(self) int
metaObject(self) PySide2.QtCore.QMetaObject
metric(self, arg__1: PySide2.QtGui.QPaintDevice.PaintDeviceMetric) int
minimumHeight(self) int
minimumSize(self) PySide2.QtCore.QSize
minimumSizeHint(self) PySide2.QtCore.QSize
minimumWidth(self) int
mouseDoubleClickEvent(self, arg__1: PySide2.QtGui.QMouseEvent) None
static mouseGrabber() PySide2.QtWidgets.QWidget
mouseMoveEvent(self, arg__1: PySide2.QtGui.QMouseEvent) None
mousePressEvent(self, arg__1: PySide2.QtGui.QMouseEvent) None
mouseReleaseEvent(self, arg__1: PySide2.QtGui.QMouseEvent) None
move(self, arg__1: PySide2.QtCore.QPoint) None
move(self, x: int, y: int) None
moveEvent(self, event: PySide2.QtGui.QMoveEvent) None
moveToThread(self, thread: PySide2.QtCore.QThread) None
nativeEvent(self, eventType: PySide2.QtCore.QByteArray, message: int) Tuple[bool, int]
nativeParentWidget(self) PySide2.QtWidgets.QWidget
nextInFocusChain(self) PySide2.QtWidgets.QWidget
normalGeometry(self) PySide2.QtCore.QRect
objectName(self) str
overrideWindowFlags(self, type: PySide2.QtCore.Qt.WindowFlags) None
overrideWindowState(self, state: PySide2.QtCore.Qt.WindowStates) None
paintEngine(self) PySide2.QtGui.QPaintEngine
paintEvent(self, arg__1: PySide2.QtGui.QPaintEvent) None
paintingActive(self) bool
palette(self) PySide2.QtGui.QPalette
parent(self) PySide2.QtCore.QObject
parentWidget(self) PySide2.QtWidgets.QWidget
paste(self) None
physicalDpiX(self) int
physicalDpiY(self) int
placeholderText(self) str
pos(self) PySide2.QtCore.QPoint
previousInFocusChain(self) PySide2.QtWidgets.QWidget
property(self, name: bytes) Any
raise_(self) None
receivers(self, signal: bytes) int
rect(self) PySide2.QtCore.QRect
redirected(self, offset: PySide2.QtCore.QPoint) PySide2.QtGui.QPaintDevice
redo(self) None
static registerUserData() int
releaseKeyboard(self) None
releaseMouse(self) None
releaseShortcut(self, id: int) None
removeAction(self, action: PySide2.QtWidgets.QAction) None
removeEventFilter(self, obj: PySide2.QtCore.QObject) None
render(self, painter: PySide2.QtGui.QPainter, targetOffset: PySide2.QtCore.QPoint, sourceRegion: PySide2.QtGui.QRegion = Default(QRegion), renderFlags: PySide2.QtWidgets.QWidget.RenderFlags = Instance(QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))) None
render(self, target: PySide2.QtGui.QPaintDevice, targetOffset: PySide2.QtCore.QPoint = Default(QPoint), sourceRegion: PySide2.QtGui.QRegion = Default(QRegion), renderFlags: PySide2.QtWidgets.QWidget.RenderFlags = Instance(QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))) None
repaint(self) None
repaint(self, arg__1: PySide2.QtCore.QRect) None
repaint(self, arg__1: PySide2.QtGui.QRegion) None
repaint(self, x: int, y: int, w: int, h: int) None
resize(self, arg__1: PySide2.QtCore.QSize) None
resize(self, w: int, h: int) None
resizeEvent(self, event: PySide2.QtGui.QResizeEvent) None
restoreGeometry(self, geometry: PySide2.QtCore.QByteArray) bool
saveGeometry(self) PySide2.QtCore.QByteArray
screen(self) PySide2.QtGui.QScreen
scroll(self, dx: int, dy: int) None
scroll(self, dx: int, dy: int, arg__3: PySide2.QtCore.QRect) None
selectAll(self) None
selectedText(self) str
selectionEnd(self) int
selectionLength(self) int
selectionStart(self) int
sender(self) PySide2.QtCore.QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool) None
setAccessibleDescription(self, description: str) None
setAccessibleName(self, name: str) None
setAlignment(self, flag: PySide2.QtCore.Qt.Alignment) None
setAttribute(self, arg__1: PySide2.QtCore.Qt.WidgetAttribute, on: bool = True) None
setAutoFillBackground(self, enabled: bool) None
setBackgroundRole(self, arg__1: PySide2.QtGui.QPalette.ColorRole) None
setBaseSize(self, arg__1: PySide2.QtCore.QSize) None
setBaseSize(self, basew: int, baseh: int) None
setClearButtonEnabled(self, enable: bool) None
setCompleter(self, completer: PySide2.QtWidgets.QCompleter) None
setContentsMargins(self, left: int, top: int, right: int, bottom: int) None
setContentsMargins(self, margins: PySide2.QtCore.QMargins) None
setContextMenuPolicy(self, policy: PySide2.QtCore.Qt.ContextMenuPolicy) None
setCursor(self, arg__1: PySide2.QtGui.QCursor) None
setCursorMoveStyle(self, style: PySide2.QtCore.Qt.CursorMoveStyle) None
setCursorPosition(self, arg__1: int) None
setDisabled(self, arg__1: bool) None
setDragEnabled(self, b: bool) None
setEchoMode(self, arg__1: PySide2.QtWidgets.QLineEdit.EchoMode) None
setEnabled(self, arg__1: bool) None
setFixedHeight(self, h: int) None
setFixedSize(self, arg__1: PySide2.QtCore.QSize) None
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int) None
setFocus(self) None
setFocus(self, reason: PySide2.QtCore.Qt.FocusReason) None
setFocusPolicy(self, policy: PySide2.QtCore.Qt.FocusPolicy) None
setFocusProxy(self, arg__1: PySide2.QtWidgets.QWidget) None
setFont(self, arg__1: PySide2.QtGui.QFont) None
setForegroundRole(self, arg__1: PySide2.QtGui.QPalette.ColorRole) None
setFrame(self, arg__1: bool) None
setGeometry(self, arg__1: PySide2.QtCore.QRect) None
setGeometry(self, x: int, y: int, w: int, h: int) None
setGraphicsEffect(self, effect: PySide2.QtWidgets.QGraphicsEffect) None
setHidden(self, hidden: bool) None
setInputMask(self, inputMask: str) None
setInputMethodHints(self, hints: PySide2.QtCore.Qt.InputMethodHints) None
setLayout(self, arg__1: PySide2.QtWidgets.QLayout) None
setLayoutDirection(self, direction: PySide2.QtCore.Qt.LayoutDirection) None
setLocale(self, locale: PySide2.QtCore.QLocale) None
setMask(self, arg__1: PySide2.QtGui.QBitmap) None
setMask(self, arg__1: PySide2.QtGui.QRegion) None
setMaxLength(self, arg__1: int) None
setMaximumHeight(self, maxh: int) None
setMaximumSize(self, arg__1: PySide2.QtCore.QSize) None
setMaximumSize(self, maxw: int, maxh: int) None
setMaximumWidth(self, maxw: int) None
setMinimumHeight(self, minh: int) None
setMinimumSize(self, arg__1: PySide2.QtCore.QSize) None
setMinimumSize(self, minw: int, minh: int) None
setMinimumWidth(self, minw: int) None
setModified(self, arg__1: bool) None
setMouseTracking(self, enable: bool) None
setObjectName(self, name: str) None
setPalette(self, arg__1: PySide2.QtGui.QPalette) None
setParent(self, parent: PySide2.QtCore.QObject) None
setParent(self, parent: PySide2.QtWidgets.QWidget) None
setParent(self, parent: PySide2.QtWidgets.QWidget, f: PySide2.QtCore.Qt.WindowFlags) None
setPlaceholderText(self, arg__1: str) None
setProperty(self, name: bytes, value: Any) bool
setReadOnly(self, arg__1: bool) None
setSelection(self, arg__1: int, arg__2: int) None
setShortcutAutoRepeat(self, id: int, enable: bool = True) None
setShortcutEnabled(self, id: int, enable: bool = True) None
setSizeIncrement(self, arg__1: PySide2.QtCore.QSize) None
setSizeIncrement(self, w: int, h: int) None
setSizePolicy(self, arg__1: PySide2.QtWidgets.QSizePolicy) None
setSizePolicy(self, horizontal: PySide2.QtWidgets.QSizePolicy.Policy, vertical: PySide2.QtWidgets.QSizePolicy.Policy) None
setStatusTip(self, arg__1: str) None
setStyle(self, arg__1: PySide2.QtWidgets.QStyle) None
setStyleSheet(self, styleSheet: str) None
static setTabOrder(arg__1: PySide2.QtWidgets.QWidget, arg__2: PySide2.QtWidgets.QWidget) None
setTabletTracking(self, enable: bool) None
setText(self, arg__1: str) None
setTextMargins(self, left: int, top: int, right: int, bottom: int) None
setTextMargins(self, margins: PySide2.QtCore.QMargins) None
setToolTip(self, arg__1: str) None
setToolTipDuration(self, msec: int) None
setUpdatesEnabled(self, enable: bool) None
setValidator(self, arg__1: PySide2.QtGui.QValidator) None
setVisible(self, visible: bool) None
setWhatsThis(self, arg__1: str) None
setWindowFilePath(self, filePath: str) None
setWindowFlag(self, arg__1: PySide2.QtCore.Qt.WindowType, on: bool = True) None
setWindowFlags(self, type: PySide2.QtCore.Qt.WindowFlags) None
setWindowIcon(self, icon: PySide2.QtGui.QIcon) None
setWindowIconText(self, arg__1: str) None
setWindowModality(self, windowModality: PySide2.QtCore.Qt.WindowModality) None
setWindowModified(self, arg__1: bool) None
setWindowOpacity(self, level: float) None
setWindowRole(self, arg__1: str) None
setWindowState(self, state: PySide2.QtCore.Qt.WindowStates) None
setWindowTitle(self, arg__1: str) None
set_bg_task_manager(task_manager)

Specify the background task manager to use to pull data in the background. Data calls to Shotgun will be dispatched via this object.

Parameters:

task_manager (BackgroundTaskManager) – Background task manager to use

set_placeholder_text(text)

Set the placeholder text for the widget

Parameters:

text – The text to use

sharedPainter(self) PySide2.QtGui.QPainter
show(self) None
showEvent(self, event: PySide2.QtGui.QShowEvent) None
showFullScreen(self) None
showMaximized(self) None
showMinimized(self) None
showNormal(self) None
signalsBlocked(self) bool
size(self) PySide2.QtCore.QSize
sizeHint(self) PySide2.QtCore.QSize
sizeIncrement(self) PySide2.QtCore.QSize
sizePolicy(self) PySide2.QtWidgets.QSizePolicy
stackUnder(self, arg__1: PySide2.QtWidgets.QWidget) None
startTimer(self, interval: int, timerType: PySide2.QtCore.Qt.TimerType = PySide2.QtCore.Qt.TimerType.CoarseTimer) int
statusTip(self) str
style(self) PySide2.QtWidgets.QStyle
styleSheet(self) str
tabletEvent(self, event: PySide2.QtGui.QTabletEvent) None
testAttribute(self, arg__1: PySide2.QtCore.Qt.WidgetAttribute) bool
text(self) str
textMargins(self) PySide2.QtCore.QMargins
thread(self) PySide2.QtCore.QThread
timerEvent(self, event: PySide2.QtCore.QTimerEvent) None
toolTip(self) str
toolTipDuration(self) int
topLevelWidget(self) PySide2.QtWidgets.QWidget
tr(self, arg__1: bytes, arg__2: bytes = b'', arg__3: int = -1) str
underMouse(self) bool
undo(self) None
ungrabGesture(self, type: PySide2.QtCore.Qt.GestureType) None
unsetCursor(self) None
unsetLayoutDirection(self) None
unsetLocale(self) None
update(self) None
update(self, arg__1: PySide2.QtCore.QRect) None
update(self, arg__1: PySide2.QtGui.QRegion) None
update(self, x: int, y: int, w: int, h: int) None
updateGeometry(self) None
updateMicroFocus(self) None
updatesEnabled(self) bool
validator(self) PySide2.QtGui.QValidator
visibleRegion(self) PySide2.QtGui.QRegion
whatsThis(self) str
wheelEvent(self, event: PySide2.QtGui.QWheelEvent) None
width(self) int
widthMM(self) int
winId(self) int
window(self) PySide2.QtWidgets.QWidget
windowFilePath(self) str
windowFlags(self) PySide2.QtCore.Qt.WindowFlags
windowHandle(self) PySide2.QtGui.QWindow
windowIcon(self) PySide2.QtGui.QIcon
windowIconText(self) str
windowModality(self) PySide2.QtCore.Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) PySide2.QtCore.Qt.WindowStates
windowTitle(self) str
windowType(self) PySide2.QtCore.Qt.WindowType
x(self) int
y(self) int
property seed_entity_field

The seed entity to use when searching for entity.

Can be PublishedFile.entity or Version.entity.