A bordered container for other controls.
To add a control to a box, simply set it as an attribute of the box.
from vanilla import Window, Box, TextBox class BoxDemo: def __init__(self): self.w = Window((150, 70)) self.w.box = Box((10, 10, -10, -10)) self.w.box.text = TextBox((10, 10, -10, -10), "This is a box") self.w.open() BoxDemo()
No special naming is required for the attributes. However, each attribute must have a unique name.
posSize Tuple of form (left, top, width, height) or “auto” representing the position and size of the box.
title The title to be displayed above the box. Pass None if no title is desired.
Add auto layout rules for controls/view in this view.
rules must be a list of rule definitions. Rule definitions may take two forms:
- strings that follow the Visual Format Language
- dictionaries with the following key/value pairs:
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 or disable the object. onOff should be a boolean.
The position and size of the object as a tuple of form (left, top, width, height).
Get the title of the box.
Return a bool indicating if the object is visible or not.
Move the object by x units and y units.
Change the size of the object to width and height.
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.
Set the title of the box.
Show or hide the object.
onOff A boolean value representing if the object should be shown or not.