Package peppy :: Package plugins :: Module editra_styleeditor :: Class EditraStyles

Class EditraStyles

      object --+        
               |        
debug.debugmixin --+    
                   |    
actions.SelectAction --+
                       |
                      EditraStyles

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 Methods

Inherited from actions.SelectAction: getHelp, setAcceleratorText, worksWithMajorMode

Inherited from debug.debugmixin: dprint

Class Variables
	name = `'Text Styles...'` This is the name of the menu entry as it appears in the menu bar.
	tooltip = `'Open the STC Style Editor to edit the current mode\...` Tooltip that is displayed when the mouse is hovering over the menu entry.
	default_menu = `('Edit', -1000)` 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.
	export_count = `0`
Inherited from `actions.SelectAction`: `alias`, `default_toolbar`, `global_id`, `icon`, `key_bindings`, `keyboard`, `stock_id` 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)

Class Variable Details

tooltip

Tooltip that is displayed when the mouse is hovering over the menu entry. If the tooltip is None, the tooltip is taken from the first line of the docstring, if it exists.

Value:

'Open the STC Style Editor to edit the current mode\'s text display.'