robotide.action.action.Action Class Reference

Acts based on user actions if action is enabled. More...

Inheritance diagram for robotide.action.action.Action:

Public Member Functions
def	__init__ (self, action_info)
def	act (self, event)
def	disable (self)
	Disables action and related menu item, toolbar button and shortcut. More...
def	enable (self)
	Enables action and related menu item, toolbar button and shortcut. More...
def	get_shortcut (self)
def	is_active (self)
Public Member Functions inherited from robotide.action.action._Registrable
def	get_insertion_index (self, menu)
def	has_action (self)
def	has_icon (self)
def	has_shortcut (self)
def	inform_changes_in_enabled_status (self, listener)
def	is_separator (self)
def	register (self, registerer)
def	unregister (self)

Public Attributes
	action
	container
	doc
	icon
	menu_name
	name
	shortcut
Public Attributes inherited from robotide.action.action._Registrable
	action
	icon
	shortcut

Private Member Functions
def	_container_is_active (self)
def	_inform_changes_in_enabled_status (self)
def	_is_always_active (self)
def	_is_always_inactive (self)

Private Attributes
	_enabled

Additional Inherited Members
Static Public Attributes inherited from robotide.action.action._Registrable
	disable = lambda event: None

Detailed Description

Acts based on user actions if action is enabled.

Created from ActionInfo.

If `ActionInfo` contains container, acts and allows to select related UI
widgets (menu item, toolbar button) and shortcuts only if the focus is in the given
container or its children.
Action can be set enabled or disabled which enables/disables also related UI
widgets and shortcut.

Definition at line 71 of file action.py.

Constructor & Destructor Documentation

__init__()

def robotide.action.action.Action.__init__	(		self,
			action_info
	)

Reimplemented from robotide.action.action._Registrable.

Definition at line 73 of file action.py.

Member Function Documentation

_container_is_active()

def robotide.action.action.Action._container_is_active (   self )

private

Definition at line 118 of file action.py.

_inform_changes_in_enabled_status()

def robotide.action.action.Action._inform_changes_in_enabled_status (   self )

private

Definition at line 101 of file action.py.

_is_always_active()

def robotide.action.action.Action._is_always_active (   self )

private

Definition at line 115 of file action.py.

_is_always_inactive()

def robotide.action.action.Action._is_always_inactive (   self )

private

Definition at line 112 of file action.py.

act()

def robotide.action.action.Action.act	(		self,
			event
	)

Definition at line 87 of file action.py.

disable()

def robotide.action.action.Action.disable

(

self

)

Disables action and related menu item, toolbar button and shortcut.

Definition at line 92 of file action.py.

enable()

def robotide.action.action.Action.enable

(

self

)

Enables action and related menu item, toolbar button and shortcut.

Definition at line 97 of file action.py.

get_shortcut()

def robotide.action.action.Action.get_shortcut

(

self

)

Definition at line 84 of file action.py.

is_active()

def robotide.action.action.Action.is_active

(

self

)

Definition at line 105 of file action.py.

Member Data Documentation

_enabled

robotide.action.action.Action._enabled

private

Definition at line 93 of file action.py.

action

robotide.action.action.Action.action

Definition at line 77 of file action.py.

container

robotide.action.action.Action.container

Definition at line 78 of file action.py.

doc

robotide.action.action.Action.doc

Definition at line 81 of file action.py.

icon

robotide.action.action.Action.icon

Definition at line 80 of file action.py.

menu_name

robotide.action.action.Action.menu_name

Definition at line 75 of file action.py.

name

robotide.action.action.Action.name

Definition at line 76 of file action.py.

shortcut

robotide.action.action.Action.shortcut

Definition at line 79 of file action.py.

---

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

• src/robotide/action/action.py