HelpButton

class vanilla.HelpButton(posSize, callback=None, page=None, anchor=None)

A standard help button.:

from vanilla import *

class HelpButtonDemo(object):

     def __init__(self):
         self.w = Window((90, 40))
         self.w.button = HelpButton((10, 10, 21, 20),
                            callback=self.buttonCallback)
         self.w.open()

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

HelpButtonDemo()

posSize Tuple of form (left, top, width, height) representing the position and size of the button. The size of the button sould match the standard dimensions.

Standard Dimensions
Width 21
Height 20

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

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.

isVisible()

Return a bool indicting 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)

Set the postion and size of the object.

posSize A tuple of form (left, top, width, height).

setTitle(title)

Set the control title.

title A string representing the title.

show(onOff)

Show or hide the object.

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