rqt_console.filters.list_filter_widget.ListFilterWidget Class Reference

Inheritance diagram for rqt_console.filters.list_filter_widget.ListFilterWidget:

Public Member Functions
def	__init__ (self, parentfilter, rospack, item_provider)
def	handle_item_changed (self)
def	repopulate (self)
def	restore_settings (self, settings)
def	save_settings (self, settings)
def	select_item (self, text)

Private Member Functions
def	_add_item (self, item)

Private Attributes
	_display_list
	_list_populate_function
	_parentfilter

Detailed Description

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

Definition at line 44 of file list_filter_widget.py.

Constructor & Destructor Documentation

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

:param parentfilter: The filter object, must implement set_list and
contain _list ''QObject''
:param item_provider: a function designed to provide a list or dict

Definition at line 51 of file list_filter_widget.py.

Member Function Documentation

def rqt_console.filters.list_filter_widget.ListFilterWidget._add_item (   self,   item  )

private

Insert item in alphabetical order.

Definition at line 111 of file list_filter_widget.py.

def rqt_console.filters.list_filter_widget.ListFilterWidget.handle_item_changed

(

self

)

Definition at line 84 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 87 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 128 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 121 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 74 of file list_filter_widget.py.

Member Data Documentation

rqt_console.filters.list_filter_widget.ListFilterWidget._display_list

private

Definition at line 71 of file list_filter_widget.py.

rqt_console.filters.list_filter_widget.ListFilterWidget._list_populate_function

private

Definition at line 69 of file list_filter_widget.py.

rqt_console.filters.list_filter_widget.ListFilterWidget._parentfilter

private

Definition at line 63 of file list_filter_widget.py.

---

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

• list_filter_widget.py