VerticalStackGroup

class vanilla.VerticalStackGroup(posSize, spacing=0, alignment='center', edgeInsets=(0, 0, 0, 0))

posSize Tuple of form (left, top, width, height) or “auto” representing the position and size of the group.

spacing Space to insert between views in points.

alignment The alignment of the views. Options:

edgeInsets Tuple of four numbers indicating the amount to inset the views.

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.

addView(view, width=None, height=None, gravity='center')

Add a view.

view A vanilla object or an instance of NSView.

width and height are None, numbers or strings:

  • value as integer or float
  • “==value” where value can be coerced to an integer or float
  • “<=value” where value can be coerced to an integer or float
  • “>=value” where value can be coerced to an integer or float

Up to two are allowed. Separate with , (comma).

gravity The gravity that this view should be attracted to.

HorizontalStackGroup Options:

VerticalStackGroup Options:

enable(onOff)

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

getPosSize()

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

insertView(index, view, width=None, height=None, gravity='center')

Insert a view.

See addView() documentation.

isVisible()

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

move(x, y)

Move the object by x units and y units.

removeView(view)

Remove a view.

view A vanilla object or an instance of NSView.

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.

show(onOff)

Show or hide the object.

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