Skip to content

ComboBoxMixin

Base classes

Name Children Inherits
WidgetMixin
prettyqt.widgets.widget

Subclasses

Class Module Description
ComboBox prettyqt.widgets.combobox
FontComboBox prettyqt.widgets.fontcombobox

⋔ Inheritance diagram

graph TD
  1473296223680["widgets.ComboBoxMixin"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473293688240 --> 1473296223680
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480

🛈 DocStrings

Bases: WidgetMixin

Combobox that lets the user select a font family.

Source code in prettyqt\widgets\combobox.py 
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
class ComboBoxMixin(widgets.WidgetMixin):
    """Combobox that lets the user select a font family."""

    value_changed = core.Signal(object)

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.currentIndexChanged.connect(self._index_changed)

    def __len__(self) -> int:
        return self.count()

    def _get_map(self):
        maps = super()._get_map()
        maps |= {
            "insertPolicy": INSERT_POLICY,
            "sizeAdjustPolicy": SIZE_ADJUST_POLICY,
        }
        return maps

    # def __reduce__(self):
    #     return type(self), (), self.__getstate__()

    def _index_changed(self, index: int):
        # data = self.itemData(index)
        data = self.get_value()
        self.value_changed.emit(data)

    def add_items(
        self, items: Iterable[str | tuple | list] | Mapping[Any, str], default=...
    ):
        if isinstance(items, Mapping):
            for k, v in items.items():
                self.addItem(v, userData=k)
        else:
            for i in items:
                if isinstance(i, tuple | list):
                    self.add(*i)
                else:
                    self.addItem(i, i)
        if default is not ...:
            self.set_value(default)

    def add(self, label: str, data=..., icon: datatypes.IconType = None):
        if data is ...:
            data = label
        if icon is not None:
            icon = iconprovider.get_icon(icon)
            self.addItem(gui.Icon(icon), label, userData=data)
        else:
            self.addItem(label, userData=data)

    def get_item_icon(self, index: int) -> gui.Icon | None:
        icon = self.itemIcon(index)
        return None if icon.isNull() else gui.Icon(icon)

    def set_editable(self, editable: bool):
        self.setEditable(editable)
        if self.completer() is None and editable:
            self.setCompleter(widgets.Completer(self))

    def set_insert_policy(self, policy: InsertPolicyStr | mod.InsertPolicy):
        """Set insert policy.

        Args:
            policy: insert policy to use
        """
        self.setInsertPolicy(INSERT_POLICY.get_enum_value(policy))

    def get_insert_policy(self) -> InsertPolicyStr:
        """Return insert policy.

        Returns:
            insert policy
        """
        return INSERT_POLICY.inverse[self.insertPolicy()]

    def set_size_adjust_policy(self, policy: SizeAdjustPolicyStr | mod.SizeAdjustPolicy):
        """Set size adjust policy.

        Args:
            policy: size adjust policy to use
        """
        self.setSizeAdjustPolicy(SIZE_ADJUST_POLICY.get_enum_value(policy))

    def get_size_adjust_policy(self) -> SizeAdjustPolicyStr:
        """Return size adjust policy.

        Returns:
            size adjust policy
        """
        return SIZE_ADJUST_POLICY.inverse[self.sizeAdjustPolicy()]

    def set_icon_size(self, size: datatypes.SizeType):
        """Set size of the icons."""
        self.setIconSize(datatypes.to_size(size))

    def get_icon_size(self) -> core.Size:
        return core.Size(self.iconSize())

    def set_min_char_length(self, chars: int):
        self.setMinimumContentsLength(chars)

    def get_value(self) -> Any:
        # if all(self.itemData(i) is None for i in range(self.count())):
        #     return self.currentText()
        # else:
        #     return self.currentData()
        return self.currentData()

    def set_value(self, value: Any):
        self.set_data(value)

    def set_text(self, text: str):
        self.setCurrentText(text)

    def set_data(self, data: Any):
        idx = self.findData(data)
        if idx == -1:
            raise ValueError("invalid data")
        self.setCurrentIndex(idx)

    def text(self) -> str:
        return self.currentText()

    def hide_completer(self):
        """Hides the completion widget."""
        completer = widgets.Completer(self)
        self.setCompleter(completer)

get_insert_policy() -> InsertPolicyStr

Return insert policy.

Source code in prettyqt\widgets\combobox.py 
116
117
118
119
120
121
122
def get_insert_policy(self) -> InsertPolicyStr:
    """Return insert policy.

    Returns:
        insert policy
    """
    return INSERT_POLICY.inverse[self.insertPolicy()]

get_size_adjust_policy() -> SizeAdjustPolicyStr

Return size adjust policy.

Source code in prettyqt\widgets\combobox.py 
132
133
134
135
136
137
138
def get_size_adjust_policy(self) -> SizeAdjustPolicyStr:
    """Return size adjust policy.

    Returns:
        size adjust policy
    """
    return SIZE_ADJUST_POLICY.inverse[self.sizeAdjustPolicy()]

hide_completer()

Hides the completion widget.

Source code in prettyqt\widgets\combobox.py 
172
173
174
175
def hide_completer(self):
    """Hides the completion widget."""
    completer = widgets.Completer(self)
    self.setCompleter(completer)

set_icon_size(size: datatypes.SizeType)

Set size of the icons.

Source code in prettyqt\widgets\combobox.py 
140
141
142
def set_icon_size(self, size: datatypes.SizeType):
    """Set size of the icons."""
    self.setIconSize(datatypes.to_size(size))

set_insert_policy(policy: InsertPolicyStr | mod.InsertPolicy)

Set insert policy.

Parameters:

Name Type Description Default
policy InsertPolicyStr | InsertPolicy

insert policy to use

 required
Source code in prettyqt\widgets\combobox.py 
108
109
110
111
112
113
114
def set_insert_policy(self, policy: InsertPolicyStr | mod.InsertPolicy):
    """Set insert policy.

    Args:
        policy: insert policy to use
    """
    self.setInsertPolicy(INSERT_POLICY.get_enum_value(policy))

set_size_adjust_policy(policy: SizeAdjustPolicyStr | mod.SizeAdjustPolicy)

Set size adjust policy.

Parameters:

Name Type Description Default
policy SizeAdjustPolicyStr | SizeAdjustPolicy

size adjust policy to use

 required
Source code in prettyqt\widgets\combobox.py 
124
125
126
127
128
129
130
def set_size_adjust_policy(self, policy: SizeAdjustPolicyStr | mod.SizeAdjustPolicy):
    """Set size adjust policy.

    Args:
        policy: size adjust policy to use
    """
    self.setSizeAdjustPolicy(SIZE_ADJUST_POLICY.get_enum_value(policy))