Drawer(size, parentWindow, minSize=None, maxSize=None, preferredEdge='left', forceEdge=False, leadingOffset=20, trailingOffset=20)¶
A drawer attached to a window. Drawers are capable of containing controls.
Drawers are deprecated and should not be used in modern macOS apps.
To add a control to a drawer, simply set it as an attribute of the drawer.
from vanilla import Window, Button, Drawer, TextBox class DrawerDemo: def __init__(self): self.w = Window((200, 200)) self.w.button = Button((10, 10, -10, 20), "Toggle Drawer", callback=self.toggleDrawer) self.d = Drawer((100, 150), self.w) self.d.textBox = TextBox((10, 10, -10, -10), "This is a drawer.") self.w.open() self.d.open() def toggleDrawer(self, sender): self.d.toggle() DrawerDemo()
No special naming is required for the attributes. However, each attribute must have a unique name.
size Tuple of form (width, height) representing the size of the drawer.
parentWindow The window that the drawer should be attached to.
minSize Tuple of form (width, height) representing the minimum size of the drawer.
maxSize Tuple of form (width, height) representing the maximum size of the drawer.
preferredEdge The preferred edge of the window that the drawer should be attached to. If the drawer cannot be opened on the preferred edge, it will be opened on the opposite edge. The options are:
“left” “right” “top” “bottom”
forceEdge Boolean representing if the drawer should always be opened on the preferred edge.
leadingOffset Distance between the top or left edge of the drawer and the parent window.
trailingOffset Distance between the bottom or right edge of the drawer and the parent window.
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.
Close the drawer.
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).
Return True if the drawer is open, False if it is closed.
Return a bool indicating if the object is visible or not.
Move the object by x units and y units.
Open the drawer.
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.
Show or hide the object.
onOff A boolean value representing if the object should be shown or not.
Open the drawer if it is closed. Close it if it is open.