Source code for shotgun_fields.list_widget

# Copyright (c) 2016 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.

import sgtk
from sgtk.platform.qt import QtGui, QtCore
from tank_vendor import six
from .label_base_widget import LabelBaseWidget
from .shotgun_field_meta import ShotgunFieldMeta

shotgun_globals = sgtk.platform.import_framework(
    "tk-framework-shotgunutils", "shotgun_globals"
)


[docs]@six.add_metaclass(ShotgunFieldMeta) class ListWidget(LabelBaseWidget): """ Display a ``list`` field value as returned by the Shotgun API. """ _DISPLAY_TYPE = "list"
[docs]@six.add_metaclass(ShotgunFieldMeta) class ListEditorWidget(QtGui.QComboBox): """ Allows editing of a ``list`` field value as returned by the Shotgun API. """ _EDITOR_TYPE = "list" _IMMEDIATE_APPLY = True
[docs] def get_value(self): """ :return: The internal value being displayed by the widget. """ return self._get_safe_str(self.currentText())
def setup_widget(self): """ Prepare the widget for display. Called by the metaclass during initialization. Adds the valid values to the list and connects the ``activated`` signal. """ self.addItem("") valid_values = shotgun_globals.get_valid_values( self._entity_type, self._field_name ) self.addItems(valid_values) self.activated.connect(lambda i: self.value_changed.emit()) def _begin_edit(self): """ Prepare the widget for editing by showing the popup. """ self.showPopup() def _display_default(self): """ Display the default value of the widget. """ self.setCurrentIndex(0) def _display_value(self, value): """ Set the value displayed by the widget. :param value: The value returned by the Shotgun API to be displayed """ if value is None: self.clearEditText() index = self.findText(value) if index != -1: self.setCurrentIndex(index)