Button

class vanilla.Button(posSize, title, callback=None, sizeStyle='regular')

A standard button.

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

class ButtonDemo:

     def __init__(self):
         self.w = Window((100, 40))
         self.w.button = Button((10, 10, -10, 20), "A Button",
                            callback=self.buttonCallback)
         self.w.open()

     def buttonCallback(self, sender):
         print("button hit!")

ButtonDemo()

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

Standard Dimensions

Regular

H

20

Small

H

17

Mini

H

14

title The text to be displayed on the button. Pass None if no title is desired.

callback The method to be called when the user presses the button.

sizeStyle A string representing the desired size style of the button. 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.

bind(key, modifiers)

Bind a key to the button.

key A single character or one of the following:

“help”

“home”

“end”

“pageup”

“pagedown”

“forwarddelete”

“leftarrow”

“rightarrow”

“uparrow”

“downarrow”

modifiers A list containing nothing or as many of the following as desired:

“command”

“control”

“option”

“shift”

“capslock”

enable(onOff)

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

getNSButton()

Return the NSButton 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.

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.