ComboBox

class vanilla.ComboBox(posSize, items, completes=True, continuous=False, callback=None, formatter=None, sizeStyle='regular')

A text entry control that allows direct text entry or selection for a list of options.

../_images/ComboBox.png
from vanilla import Window, ComboBox

class ComboBoxDemo:

    def __init__(self):
        self.w = Window((100, 41))
        self.w.comboBox = ComboBox((10, 10, -10, 21),
                            ["AA", "BB", "CC", "DD"],
                            callback=self.comboBoxCallback)
        self.w.open()

    def comboBoxCallback(self, sender):
        print("combo box entry!", sender.get())

ComboBoxDemo()

posSize Tuple of form (left, top, width, height) or “auto” representing the position and size of the combo box control. The size of the combo box should match the appropriate value for the given sizeStyle.

Standard Dimensions

Regular

H

21

Small

H

17

Mini

H

14

items The items to be displayed in the combo box.

completes Boolean representing if the combo box auto completes entered text.

continuous If True, the callback (if any) will be called upon each keystroke, if False, only call the callback when editing finishes or after item selection. Default is False.

callback The method to be called when the user enters text.

formatter A NSFormatter for controlling the display and input of the text entry.

sizeStyle A string representing the desired size style of the combo box. The options are:

“regular”

“small”

“mini”

addAutoPosSizeRules(rules, metrics=None)

Add auto layout rules for controls/view in this view.

rules must be a list of rule definitions. Rule definitions may take two forms:

key

value

“view1”

The vanilla wrapped view for the left side of the rule.

“attribute1”

The attribute of the view for the left side of the rule. See below for options.

“relation” (optional)

The relationship between the left side of the rule and the right side of the rule. See below for options. The default value is “==”.

“view2”

The vanilla wrapped view for the right side of the rule.

“attribute2”

The attribute of the view for the right side of the rule. See below for options.

“multiplier” (optional)

The constant multiplied with the attribute on the right side of the rule as part of getting the modified attribute. The default value is 1.

“constant” (optional)

The constant added to the multiplied attribute value on the right side of the rule to yield the final modified attribute. The default value is 0.

The attribute1 and attribute2 options are:

value

AppKit equivalent

“left”

NSLayoutAttributeLeft

“right”

NSLayoutAttributeRight

“top”

NSLayoutAttributeTop

“bottom”

NSLayoutAttributeBottom

“leading”

NSLayoutAttributeLeading

“trailing”

NSLayoutAttributeTrailing

“width”

NSLayoutAttributeWidth

“height”

NSLayoutAttributeHeight

“centerX”

NSLayoutAttributeCenterX

“centerY”

NSLayoutAttributeCenterY

“baseline”

NSLayoutAttributeBaseline

“lastBaseline”

NSLayoutAttributeLastBaseline

“firstBaseline”

NSLayoutAttributeFirstBaseline

Refer to the NSLayoutAttribute documentation for the information about what each of these do.

The relation options are:

value

AppKit equivalent

“<=”

NSLayoutRelationLessThanOrEqual

“==”

NSLayoutRelationEqual

“>=”

NSLayoutRelationGreaterThanOrEqual

Refer to the NSLayoutRelation documentation for the information about what each of these do.

metrics may be either None or a dict containing key value pairs representing metrics keywords used in the rules defined with strings.

enable(onOff)

Enable or disable the object. onOff should be a boolean.

get()

Get the text entered in the combo box.

getItems()

Get the items in the combo box as a list.

getNSComboBox()

Return the NSComboBox that this object wraps.

getPosSize()

The position and size of the object as a tuple of form (left, top, width, height).

getTitle()

Get the control title.

isEnabled()

Return a bool indicating if the object is enable or not.

isVisible()

Return a bool indicating if the object is visible or not.

move(x, y)

Move the object by x units and y units.

resize(width, height)

Change the size of the object to width and height.

set(value)

Set the text in the text field of the combo box.

value A string to set in the combo box.

setItems(items)

Set the items in the combo box list.

items A list of strings to set in the combo box list.

setPosSize(posSize, animate=False)

Set the position and size of the object.

posSize A tuple of form (left, top, width, height).

animate A boolean flag telling to animate the transition. Off by default.

setShowFocusRing(value)

Set if the focus ring is visible.

setTitle(title)

Set the control title.

title A string representing the title.

setToolTip(toolTipMessage)

Add tool tip message to the object when hover over it with the cursor.

show(onOff)

Show or hide the object.

onOff A boolean value representing if the object should be shown or not.