The QT Widgets Framework

The QT Widgets Framework contains a collection of QT UI Related modules.

Contents:

• ShotGrid Activity Stream Widget
  • Introduction
  • ActivityStreamWidget
  • ReplyListWidget
• Auto-Elide label
• ShotGrid Search Completers
  • Global Search Completer
  • Hierarchical Search Completer
• ShotGrid Search Widget
• Context Selector Widget
• Delegates
• Filtering
• Help Screen Popup
  • Introduction
  • API Reference
• Model Related Classes
  • HierarchicalFilteringProxyModel
  • ShotgunSortFilterProxyModel
• Navigation Widgets
  • Breadcrumbs
  • Home/Next/Prev Navigation
• Shotgun Note Input Widget
  • NoteInputWidget
  • NoteInputDialog
• Text Overlay Widget
  • Introduction
  • ShotgunSpinningWidget
  • ShotgunOverlayWidget
  • ShotgunModelOverlayWidget
• ShotGrid Playback Label Widget
• Screen Capture Widget
• ShotGrid Field Widgets
  • Introduction
  • Field Widget Manager
  • Field Widget Metaclass
  • Field Widgets
  • Editable Widgets
  • Base Classes
  • Field Widget Delegates
  • Example Code
  • TODOs & Known Issues
• ShotGrid Menus
  • Introduction
• Shotgun Widgets
• Spinner Widget
• ShotGrid Version Details Widget
  • Introduction
  • VersionDetailsWidget
• View Related Classes
  • QT Widget Delegate System
  • Grouped List View

Importing widgets into your app

Each of the modules in this framework can be used inside your Toolkit Apps. They are typically imported via Toolkit’s special import_framework() method, which handles automatic reload and resource management behind the scenes:

overlay_widget = sgtk.platform.import_framework("tk-framework-qtwidgets", "overlay_widget")

These imports work just like the normal import call in python and we recommend that they are placed at the top of the file.

Once you have imported the module, you can access the class or objects inside:

my_overlay = overlay_widget.ShotgunOverlayWidget(self)

Using widgets with QT Designer

If you are dropping the widgets into QT Designer directly, there isn’t an option to run the import_framework method. In this case, we recommend adding imports to a wrapper file and place that next to your other python files. You can for example call this file qtwidgets.py and then do the imports in this file:

import sgtk

note_input_widget = sgtk.platform.current_bundle().import_module("note_input_widget")
NoteInputWidget = note_input_widget.NoteInputWidget

version_label = sgtk.platform.current_bundle().import_module("version_label")
VersionLabel = version_label.VersionLabel

In your designer generated .ui files, you can now reference these widgets as if they were local to your project.