robotide.action.actioninfo.ActionInfo Class Reference

Used to create menu entries, keyboard shortcuts and/or toolbar buttons. More...

Inheritance diagram for robotide.action.actioninfo.ActionInfo:

Public Member Functions
def	__init__ (self, menu_name, name, action=None, container=None, shortcut=None, icon=None, doc='', position=-1)
	Initializes information needed to create actions. More...
Public Member Functions inherited from robotide.action.actioninfo.MenuInfo
def	__init__ (self)
def	is_separator (self)
def	set_menu_position (self, before=None, after=None)
	Sets the position of this menu entry. More...

Public Attributes
	action
	container
	doc
	menu_name
	name
	shortcut
Public Attributes inherited from robotide.action.actioninfo.MenuInfo
	insertion_point

Properties
	icon = property
	position = property

Private Member Functions
def	_get_icon (self)
def	icon (self)
def	position (self)

Private Attributes
	_icon
	_icon_source
	_position

Detailed Description

Used to create menu entries, keyboard shortcuts and/or toolbar buttons.

Definition at line 176 of file actioninfo.py.

Constructor & Destructor Documentation

__init__()

def robotide.action.actioninfo.ActionInfo.__init__	(		self,
			menu_name,
			name,
			action = None,
			container = None,
			shortcut = None,
			icon = None,
			doc = '',
			position = -1
	)

Initializes information needed to create actions.

    :Parameters:
      menu_name
        The name of the menu where the new entry will be added. The menu is
        created if it does not exist.
      name
        The name of the new menu entry. The name may contain an accelerator
        key prefixed by an ampersand like ``New &Action``. If an accelerator
        is not specified, or the one requested is already taken, the next
        free key is selected.
      action
        The callable which will be called when a user does any of the
        associated UI actions.
      container
        The wxPython element containing the UI components associated with
        the ``action``. When any of the registered UI actions is executed,
        the ``action`` is called only if the ``container`` or any of its
        child components has focus. It is possible to make the ``action``
        always active by using ``None`` as the ``container``.
      shortcut
        The keyboard shortcut associated to the ``action``. The ``shortcut``
        must be a string constructed from optional modifiers (``Ctrl, Shift,
        Alt``) and the actual shortcut key separating the parts with a hyphen.
        The shortcut key can be either a single character or any of the
        `wx keycodes`__ without the ``WXK_`` prefix. Examples: ``Ctrl-C``,
        ``Shift-Ctrl-6``, ``Alt-Left``, ``F6``.
      icon
        The icon added to the toolbar as a toolbar button. It can be either
        a 16x16 bitmap or a string presenting one of the icons provided by
        `wxPython's ArtProvider`__ like ``ART_FILE_OPEN``.
      doc
        The documentation shown on the statusbar when selection is on
        the associated menu entry or toolbar button.
      position
        The positional value of an item in the menu. Provided for ordering
        Tools menu. Defaults to -1.

    __ http://docs.wxwidgets.org/stable/wx_keycodes.html#keycodes
    __ http://www.wxpython.org/docs/api/wx.ArtProvider-class.html

Definition at line 219 of file actioninfo.py.

Member Function Documentation

_get_icon()

def robotide.action.actioninfo.ActionInfo._get_icon (   self )

private

Definition at line 240 of file actioninfo.py.

icon()

def robotide.action.actioninfo.ActionInfo.icon (   self )

private

Definition at line 235 of file actioninfo.py.

position()

def robotide.action.actioninfo.ActionInfo.position (   self )

private

Definition at line 253 of file actioninfo.py.

Member Data Documentation

_icon

robotide.action.actioninfo.ActionInfo._icon

private

Definition at line 227 of file actioninfo.py.

_icon_source

robotide.action.actioninfo.ActionInfo._icon_source

private

Definition at line 228 of file actioninfo.py.

_position

robotide.action.actioninfo.ActionInfo._position

private

Definition at line 230 of file actioninfo.py.

action

robotide.action.actioninfo.ActionInfo.action

Definition at line 224 of file actioninfo.py.

container

robotide.action.actioninfo.ActionInfo.container

Definition at line 225 of file actioninfo.py.

doc

robotide.action.actioninfo.ActionInfo.doc

Definition at line 229 of file actioninfo.py.

menu_name

robotide.action.actioninfo.ActionInfo.menu_name

Definition at line 222 of file actioninfo.py.

name

robotide.action.actioninfo.ActionInfo.name

Definition at line 223 of file actioninfo.py.

shortcut

robotide.action.actioninfo.ActionInfo.shortcut

Definition at line 226 of file actioninfo.py.

Property Documentation

icon

robotide.action.actioninfo.ActionInfo.icon = property

static

Definition at line 233 of file actioninfo.py.

position

robotide.action.actioninfo.ActionInfo.position = property

static

Definition at line 251 of file actioninfo.py.

---

The documentation for this class was generated from the following file:

• src/robotide/action/actioninfo.py