LevelIndicator

class vanilla.LevelIndicator(posSize, style='discrete', value=5, minValue=0, maxValue=10, warningValue=None, criticalValue=None, tickMarkPosition=None, minorTickMarkCount=None, majorTickMarkCount=None, callback=None)

A control which shows a value on a linear scale.:

from vanilla import *

class LevelIndicatorDemo(object):

     def __init__(self):
         self.w = Window((200, 68))
         self.w.discreteIndicator = LevelIndicator(
                    (10, 10, -10, 18), callback=self.levelIndicatorCallback)
         self.w.continuousIndicator = LevelIndicator(
                    (10, 40, -10, 18), style="continuous",
                    callback=self.levelIndicatorCallback)
         self.w.open()

     def levelIndicatorCallback(self, sender):
         print("level indicator edit!", sender.get())

LevelIndicatorDemo()

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

Standard Dimensions
discrete without ticks H 18
discrete with minor ticks H 22
discrete with major ticks H 25
continuous without ticks H 16
continuous with minor ticks H 20
continuous with major ticks H 23

style The style of the level indicator. The options are:

“continuous” A continuous bar.
“discrete” A segmented bar.

value The initial value of the level indicator.

minValue The minimum value allowed by the level indicator.

maxValue The maximum value allowed by the level indicator.

warningValue The value at which the filled portions of the level indicator should display the warning color.

criticalValue The value at which the filled portions of the level indicator should display the critical color.

tickMarkPosition The position of the tick marks in relation to the level indicator. The options are:

“above”
“below”

minorTickMarkCount The number of minor tick marcks to be displayed on the level indicator. If None is given, no minor tick marks will be displayed.

majorTickMarkCount The number of major tick marcks to be displayed on the level indicator. If None is given, no major tick marks will be displayed.

callback The method to be called when the level indicator has been edited. If no callback is given, the level indicator will not be editable.

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 value of the level indicator.

getCriticalValue(value)

Get the critical value of the level indicator.

getMaxValue()

Get the maximum of the level indicator.

getMinValue()

Get the minimum value of the level indicator.

getNSLevelIndicator()

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

getWarningValue(value)

Get the warning value of the level indicator.

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 value of the level indicator.

setCriticalValue(value)

Set the critical value of the level indicator.

setMaxValue(value)

Set the maximum of the level indicator.

setMinValue(value)

Set the minimum value of the level indicator.

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.

setTitle(title)

Set the control title.

title A string representing the title.

setWarningValue(value)

Set the warning value of the level indicator.

show(onOff)

Show or hide the object.

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