Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
rqt_console.console_widget.ConsoleWidget Class Reference
Inheritance diagram for rqt_console.console_widget.ConsoleWidget:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def cleanup_browsers_on_close
def get_message_summary
def get_time_range_from_selection
def restore_settings
def save_settings
def update_status

Public Attributes

 debug
 error
 fatal
 filter_factory
 info
 severitylist
 warn

Private Member Functions

def _add_exclude_filter
def _add_highlight_filter
def _delete_exclude_filter
def _delete_highlight_filter
def _delete_selected_rows
def _handle_clear_button_clicked
def _handle_column_resize_clicked
def _handle_custom_keypress
def _handle_load_clicked
def _handle_mouse_double_click
def _handle_mouse_press
def _handle_pause_clicked
def _handle_save_clicked
def _process_highlight_exclude_filter
def _rightclick_menu
def _show_browsers

Private Attributes

 _browsers
 _columnwidth
 _datamodel
 _exclude_filters
 _highlight_filters
 _pauseicon
 _proxymodel
 _recordicon

Detailed Description

Primary widget for the rqt_console plugin.

Definition at line 65 of file console_widget.py.


Constructor & Destructor Documentation

def rqt_console.console_widget.ConsoleWidget.__init__ (   self,
  proxymodel,
  minimal = False 
)
:param proxymodel: the proxy model to display in the widget,''QSortFilterProxyModel''
:param minimal: if true the load, save and column buttons will be hidden as well as the filter splitter, ''bool''

Definition at line 69 of file console_widget.py.


Member Function Documentation

def rqt_console.console_widget.ConsoleWidget._add_exclude_filter (   self,
  filter_index = False 
) [private]
:param filter_index: if false then this function shows a QMenu to allow the user to choose a type of message filter. ''bool''
OR
:param filter_index: the index of the filter to be added, ''int''
:return: if a filter was added then the index is returned, ''int''
OR
:return: if no filter was added then None is returned, ''NoneType''

Definition at line 272 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._add_highlight_filter (   self,
  filter_index = False 
) [private]
:param filter_index: if false then this function shows a QMenu to allow the user to choose a type of message filter. ''bool''
OR
:param filter_index: the index of the filter to be added, ''int''
:return: if a filter was added then the index is returned, ''int''
OR
:return: if no filter was added then None is returned, ''NoneType''

Definition at line 228 of file console_widget.py.

Deletes any exclude filters which have a checked delete button

Definition at line 215 of file console_widget.py.

Deletes any highlight filters which have a checked delete button

Definition at line 202 of file console_widget.py.

Definition at line 525 of file console_widget.py.

Definition at line 480 of file console_widget.py.

Definition at line 522 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._handle_custom_keypress (   self,
  event,
  old_keyPressEvent = QTableView.keyPressEvent 
) [private]
Handles the delete key.
The delete key removes the tableview's selected rows from the datamodel

Definition at line 532 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._handle_load_clicked (   self,
  checked 
) [private]

Definition at line 484 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._handle_mouse_double_click (   self,
  event,
  old_doubleclickevent = QTableView.mouseDoubleClickEvent 
) [private]

Definition at line 547 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._handle_mouse_press (   self,
  event,
  old_pressEvent = QTableView.mousePressEvent 
) [private]

Definition at line 553 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._handle_pause_clicked (   self,
  checked 
) [private]

Definition at line 513 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._handle_save_clicked (   self,
  checked 
) [private]

Definition at line 498 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._process_highlight_exclude_filter (   self,
  selection,
  selectiontype,
  exclude = False 
) [private]
Modifies the relevant filters (based on selectiontype) to remove (exclude=True)
or highlight (exclude=False) the selection from the dataset in the tableview.
:param selection: the actual selection, ''str''
:param selectiontype: the type of selection, ''str''
:param exclude: If True process as an exclude filter, False process as an highlight filter, ''bool''

Definition at line 316 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget._rightclick_menu (   self,
  event 
) [private]
Dynamically builds the rightclick menu based on the unique column data
from the passed in datamodel and then launches it modally
:param event: the mouse event object, ''QMouseEvent''

Definition at line 376 of file console_widget.py.

Definition at line 471 of file console_widget.py.

Definition at line 467 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget.get_message_summary (   self,
  start_time_offset = None,
  end_time_offset = None 
)
:param start_time: number of seconds before now to start, ''int'' (optional)
:param end_time: number of seconds before now to end, ''int'' (optional)
:returns: summary of message numbers within time

Definition at line 143 of file console_widget.py.

:returns: the range of time of messages in the current table selection (min, max), ''tuple(str,str)''

Definition at line 185 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget.restore_settings (   self,
  pluggin_settings,
  instance_settings 
)

Definition at line 582 of file console_widget.py.

def rqt_console.console_widget.ConsoleWidget.save_settings (   self,
  plugin_settings,
  instance_settings 
)

Definition at line 559 of file console_widget.py.

Sets the message display label to the current value

Definition at line 457 of file console_widget.py.


Member Data Documentation

Definition at line 72 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 147 of file console_widget.py.

Definition at line 147 of file console_widget.py.

Definition at line 147 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 147 of file console_widget.py.

Definition at line 72 of file console_widget.py.

Definition at line 147 of file console_widget.py.


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


rqt_console
Author(s): Aaron Blasdel
autogenerated on Fri Jan 3 2014 11:54:30