peppy.plugins.preferences.Preferences

Class Preferences

Instance Methods

action(self, index=-1, multiplier=1)
Override this to provide the functionality of the action.

Inherited from actions.SelectAction: __call__, __init__, getMenuItemName, getSubIds, getTooltip, initPostHook, initPreHook, insertIntoMenu, insertIntoToolbar, isEnabled, showEnable

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables

name = '&Preferences...'
This is the name of the menu entry as it appears in the menu bar.

tooltip = 'Preferences, settings, and configurations...'
Tooltip that is displayed when the mouse is hovering over the menu entry.

default_menu = ('Edit', 1000.1)
The default menu location is specified here as a tuple containing the menu path (separated by / characters) and a number between 1 and 1000 representing the position within the menu.

default_toolbar = False
Toolbar item will automatically be created unless this is False

icon = 'icons/wrench.png'
If there is an icon associated with this action, name it here.

stock_id = 5022
If this menu action has a stock wx id, such as wx.ID_ABOUT or wx.ID_PREFERENCES, add it here and the wx menu system can do some special things to it, like automatically give it the correct location on WXMAC.

key_bindings = {'mac': 'C-,'}
Map of platform to default keybinding.

Inherited from actions.SelectAction: alias, global_id, keyboard

Inherited from debug.debugmixin: debuglevel

Properties

Inherited from object: __class__

Method Details

action(self, index=-1, multiplier=1)

Override this to provide the functionality of the action.

This method gets called when the user initiates the action, whether it be from the menu bar, toolbar, or keyboard.

Parameters:

index - The index of the item in the list. This is only useful for list or radio items.
multiplier - the multiplier supplied by the keyboard handler. The keyboard handler allows for emacs-style repeat commands. For some actions, it makes sense to allow repetition of the command. For instance, in a command that uppercases words, the multiplier could be 4, would mean that the next 4 words get uppercased. The default is 1.

Overrides: actions.SelectAction.action

(inherited documentation)