rxtools::RosoutListControl Class Reference

Custom list control for displaying large numbers of constantly changing messages. More...

#include <rosout_list_control.h>

Public Member Functions
void	copySelectionToClipboard (bool message_only)
const S_int32 &	getSelection ()
	Get the index of the currently selected item.
wxString	getSeverityText (const rosgraph_msgs::LogConstPtr &message) const
	Get a text representation of the severity level of a message.
void	postItemChanges ()
void	preItemChanges ()
	RosoutListControl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxLC_ICON, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxListCtrlNameStr)
	Standard wxListCtrl constructor.
void	setModel (RosoutPanel *model)
void	setSelection (const S_int32 &sel)
virtual	~RosoutListControl ()
	Destructor.
Protected Member Functions
rosgraph_msgs::LogConstPtr	getSelectedMessage ()
void	onChar (wxKeyEvent &event)
void	onCopy (wxCommandEvent &event)
void	onCopyMessageOnly (wxCommandEvent &event)
void	onExcludeLocation (wxCommandEvent &event)
void	onExcludeLocationNewWindow (wxCommandEvent &event)
void	onExcludeMessage (wxCommandEvent &event)
void	onExcludeMessageNewWindow (wxCommandEvent &event)
void	onExcludeNode (wxCommandEvent &event)
void	onExcludeNodeNewWindow (wxCommandEvent &event)
virtual wxListItemAttr *	OnGetItemAttr (long item) const
virtual int	OnGetItemImage (long item) const
virtual wxString	OnGetItemText (long item, long column) const
void	onIncludeLocation (wxCommandEvent &event)
void	onIncludeLocationNewWindow (wxCommandEvent &event)
void	onIncludeMessage (wxCommandEvent &event)
void	onIncludeMessageNewWindow (wxCommandEvent &event)
void	onIncludeNode (wxCommandEvent &event)
void	onIncludeNodeNewWindow (wxCommandEvent &event)
void	onItemActivated (wxListEvent &event)
void	onItemRightClick (wxListEvent &event)
void	onItemSelected (wxListEvent &event)
void	updateSelection ()
Protected Attributes
wxListItemAttr	attr_
int32_t	debug_image_id_
bool	disable_scroll_to_bottom_
int32_t	error_image_id_
int32_t	fatal_image_id_
int32_t	info_image_id_
int32_t	last_selection_
RosoutPanel *	model_
bool	scrollbar_at_bottom_
S_int32	selection_
int32_t	warning_image_id_

Detailed Description

Custom list control for displaying large numbers of constantly changing messages.

wxListCtrl provides a special "virtual" mode that allows it to work with as much data as you can handle. Virtual list controls must at least override the OnGetItemText function, which returns the text to display inside a specific cell. For more information, see http://docs.wxwidgets.org/stable/wx_wxlistctrl.html

Definition at line 70 of file rosout_list_control.h.

Constructor & Destructor Documentation

rxtools::RosoutListControl::RosoutListControl	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `wxLC_ICON`,
		const wxValidator &	validator = `wxDefaultValidator`,
		const wxString &	name = `wxListCtrlNameStr`
	)

Standard wxListCtrl constructor.

Definition at line 36 of file rosout_list_control.cpp.

rxtools::RosoutListControl::~RosoutListControl ( ) [virtual]

Destructor.

Definition at line 83 of file rosout_list_control.cpp.

Member Function Documentation

void rxtools::RosoutListControl::copySelectionToClipboard ( bool message_only )

Definition at line 507 of file rosout_list_control.cpp.

rosgraph_msgs::LogConstPtr rxtools::RosoutListControl::getSelectedMessage ( ) [protected]

Definition at line 393 of file rosout_list_control.cpp.

const S_int32& rxtools::RosoutListControl::getSelection ( ) [inline]

Get the index of the currently selected item.

Returns:: The index of the currently selected item

Definition at line 95 of file rosout_list_control.h.

wxString rxtools::RosoutListControl::getSeverityText ( const rosgraph_msgs::LogConstPtr & message ) const

Get a text representation of the severity level of a message.

Parameters:

message

The message

Returns:: A text representation of the severity (ie, "Debug", "Info"...)

Definition at line 92 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onChar ( wxKeyEvent & event ) [protected]

Definition at line 554 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onCopy ( wxCommandEvent & event ) [protected]

Definition at line 544 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onCopyMessageOnly ( wxCommandEvent & event ) [protected]

Definition at line 549 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onExcludeLocation ( wxCommandEvent & event ) [protected]

Definition at line 403 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onExcludeLocationNewWindow ( wxCommandEvent & event ) [protected]

Definition at line 429 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onExcludeMessage ( wxCommandEvent & event ) [protected]

Definition at line 421 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onExcludeMessageNewWindow ( wxCommandEvent & event ) [protected]

Definition at line 447 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onExcludeNode ( wxCommandEvent & event ) [protected]

Definition at line 413 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onExcludeNodeNewWindow ( wxCommandEvent & event ) [protected]

Definition at line 439 of file rosout_list_control.cpp.

wxListItemAttr * rxtools::RosoutListControl::OnGetItemAttr ( long item ) const [protected, virtual]

Definition at line 138 of file rosout_list_control.cpp.

int rxtools::RosoutListControl::OnGetItemImage ( long item ) const [protected, virtual]

Definition at line 111 of file rosout_list_control.cpp.

wxString rxtools::RosoutListControl::OnGetItemText	(	long	item,
		long	column
	)			const `[protected, virtual]`

Definition at line 170 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onIncludeLocation ( wxCommandEvent & event ) [protected]

Definition at line 455 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onIncludeLocationNewWindow ( wxCommandEvent & event ) [protected]

Definition at line 481 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onIncludeMessage ( wxCommandEvent & event ) [protected]

Definition at line 473 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onIncludeMessageNewWindow ( wxCommandEvent & event ) [protected]

Definition at line 499 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onIncludeNode ( wxCommandEvent & event ) [protected]

Definition at line 465 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onIncludeNodeNewWindow ( wxCommandEvent & event ) [protected]

Definition at line 491 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onItemActivated ( wxListEvent & event ) [protected]

Definition at line 290 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onItemRightClick ( wxListEvent & event ) [protected]

Definition at line 565 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::onItemSelected ( wxListEvent & event ) [protected]

Definition at line 653 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::postItemChanges ( )

Definition at line 705 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::preItemChanges ( )

Todo:: wxListCtrl::GetScrollRange doesn't work, so I have to work around it. Switch to use GetScrollPos and GetScrollRange once Bug #10155 in the wxWidgets trac is fixed.

Definition at line 672 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::setModel ( RosoutPanel * model )

Definition at line 87 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::setSelection ( const S_int32 & sel )

Definition at line 728 of file rosout_list_control.cpp.

void rxtools::RosoutListControl::updateSelection ( ) [protected]

Definition at line 636 of file rosout_list_control.cpp.