Mixin to help solve if tree aware plugin has focus. More...

Inheritance diagram for robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin:

Public Member Functions
def	add_self_as_tree_aware_plugin (self)

def	add_tree_aware_plugin (self, other)

def	is_focus_on_tree_aware_plugin (self)

def	remove_self_from_tree_aware_plugins (self)

def	remove_tree_aware_plugin (self, other)

Properties
	_tree_aware_plugins = property

Private Member Functions
def	_tree_aware_plugin_added (self, message)

def	_tree_aware_plugins (self)

Static Private Attributes
	_tree_aware_plugins_set

Detailed Description

Mixin to help solve if tree aware plugin has focus.

The plugin that inherits this Mixin must be a Plugin and also it must offer a method #is_focused -> bool

To properly initialize this Mixin the Plugin in question must add_self_as_tree_aware_plugin

To properly teardown this Mixin the Plugin in question must remove_self_from_tree_aware_plugins

To check if one of the other three aware plugins has focus is_focus_on_tree_aware_plugin

NOTE: Could be used for more generic purpose for grouping plugins and interacting with them

Definition at line 37 of file tree_aware_plugin_mixin.py.

Member Function Documentation

◆ _tree_aware_plugin_added()

def robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin._tree_aware_plugin_added	(	self,
		message
	)

private

Definition at line 62 of file tree_aware_plugin_mixin.py.

◆ _tree_aware_plugins()

def robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin._tree_aware_plugins ( self )

private

Definition at line 69 of file tree_aware_plugin_mixin.py.

◆ add_self_as_tree_aware_plugin()

def robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin.add_self_as_tree_aware_plugin ( self )

Definition at line 47 of file tree_aware_plugin_mixin.py.

◆ add_tree_aware_plugin()

def robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin.add_tree_aware_plugin	(	self,
		other
	)

Definition at line 56 of file tree_aware_plugin_mixin.py.

◆ is_focus_on_tree_aware_plugin()

def robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin.is_focus_on_tree_aware_plugin ( self )

Definition at line 44 of file tree_aware_plugin_mixin.py.

◆ remove_self_from_tree_aware_plugins()

def robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin.remove_self_from_tree_aware_plugins ( self )

Definition at line 51 of file tree_aware_plugin_mixin.py.

◆ remove_tree_aware_plugin()

def robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin.remove_tree_aware_plugin	(	self,
		other
	)

Definition at line 59 of file tree_aware_plugin_mixin.py.

Member Data Documentation

◆ _tree_aware_plugins_set

robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin._tree_aware_plugins_set

staticprivate

Definition at line 42 of file tree_aware_plugin_mixin.py.

Property Documentation

◆ _tree_aware_plugins

robotide.pluginapi.tree_aware_plugin_mixin.TreeAwarePluginMixin._tree_aware_plugins = property