rqt_console.filters.list_filter_widget.ListFilterWidget Class Reference

Inheritance diagram for rqt_console.filters.list_filter_widget.ListFilterWidget:

List of all members.

Public Member Functions
def	__init__
def	handle_item_changed
def	repopulate
def	restore_settings
def	save_settings
def	select_item
Private Attributes
	_display_list
	_function_argument
	_list_populate_function
	_parentfilter

---

Detailed Description

Generic List widget to be used when implementing filters that require
limited dynamic selections

Definition at line 42 of file list_filter_widget.py.

---

Constructor & Destructor Documentation

def rqt_console.filters.list_filter_widget.ListFilterWidget.__init__	(		self,
			parentfilter,
			display_list_args
	)

:param parentfilter: The filter object, must implement set_list and
contain _list ''QObject''
:param display_list_args: list of arguments which must contain a
function designed to populate a list 'display_list_args[0]' and may
contain an optional variable to pass into that function 'display_list_args[1]'

Definition at line 47 of file list_filter_widget.py.

---

Member Function Documentation

def rqt_console.filters.list_filter_widget.ListFilterWidget.handle_item_changed

(

self

)

Definition at line 79 of file list_filter_widget.py.

def rqt_console.filters.list_filter_widget.ListFilterWidget.repopulate

(

self

)

Repopulates the display widgets based on the function arguments passed
in during initialization

Definition at line 82 of file list_filter_widget.py.

def rqt_console.filters.list_filter_widget.ListFilterWidget.restore_settings	(		self,
			settings
	)

Restores the settings for this filter from an ini file.
:param settings: used to extract the settings from an ini file ''qt_gui.settings.Settings''

Definition at line 106 of file list_filter_widget.py.

def rqt_console.filters.list_filter_widget.ListFilterWidget.save_settings	(		self,
			settings
	)

Saves the settings for this filter.
:param settings: used to write the settings to an ini file ''qt_gui.settings.Settings''

Definition at line 98 of file list_filter_widget.py.

def rqt_console.filters.list_filter_widget.ListFilterWidget.select_item	(		self,
			text
	)

All items matching text will be selected in the list_widget
:param item: a string to be matched against the list ''str''

Definition at line 69 of file list_filter_widget.py.

---

Member Data Documentation

rqt_console::filters::list_filter_widget.ListFilterWidget::_display_list [private]

Definition at line 53 of file list_filter_widget.py.

rqt_console::filters::list_filter_widget.ListFilterWidget::_function_argument [private]

Definition at line 53 of file list_filter_widget.py.

rqt_console::filters::list_filter_widget.ListFilterWidget::_list_populate_function [private]

Definition at line 53 of file list_filter_widget.py.

rqt_console::filters::list_filter_widget.ListFilterWidget::_parentfilter [private]

Definition at line 53 of file list_filter_widget.py.

---

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

• list_filter_widget.py