BattleListCtrl Class Reference

The ListCtrll contained in BattleListTab dispalying all currently active battles with their infos. More...

#include <battlelistctrl.h>

Inherits CustomVirtListCtrl< IBattle *, BattleListCtrl >.

Collaboration diagram for BattleListCtrl:

Public Types
enum	{ BLIST_LIST = wxID_HIGHEST, BLIST_DLMOD, BLIST_DLMAP }
typedef IBattle *	DataType
Public Member Functions
	BattleListCtrl (wxWindow *parent)
	~BattleListCtrl ()
void	AddBattle (IBattle &battle)
void	RemoveBattle (IBattle &battle)
void	UpdateBattle (IBattle &battle)
void	OnListRightClick (wxListEvent &event)
void	OnDLMap (wxCommandEvent &event)
void	OnDLMod (wxCommandEvent &event)
virtual void	SetTipWindowText (const long item_hit, const wxPoint &position)
wxString	GetItemText (long item, long column) const
int	GetItemImage (long item) const
int	GetItemColumnImage (long item, long column) const
wxListItemAttr *	GetItemAttr (long item) const
void	OnSelected (wxListEvent &event)
void	OnDeselected (wxListEvent &event)
void	AddColumn (long i, int width, const wxString &label, const wxString &tip, bool=true)
virtual void	OnTimer (wxTimerEvent &event)
	this event is triggered when delay timer (set in mousemotion) ended
void	OnStartResizeCol (wxListEvent &event)
	prohibits resizin if so set in columnInfo
virtual void	OnEndResizeCol (wxListEvent &event)
	we use this to automatically save column width after resizin
virtual void	OnMouseMotion (wxMouseEvent &event)
	starts timer, sets tooltiptext
void	CancelTooltipTimer ()
	stop timer (before displaying popup f.e.)
bool	PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition)
	Override to have tooltip timer cancelled automatically.
void	noOp (wxMouseEvent &event)
	does nothing
virtual bool	SetColumnWidth (int col, int &width)
	automatically get saved column width if already saved, otherwise use parameter and save new width
void	ResetColumnSizes ()
	reset columns with current set size (only effects columns with auto-size)
wxListItemAttr *	HighlightItemUser (const wxString &name) const
	all that needs to be implemented in child class for UpdateHighlights to work
void	SetHighLightAction (UserActions::ActionType action)
void	RefreshVisibleItems ()
void	SelectNone ()
void	MarkDirtySort ()
	marks the items in the control to be sorted
virtual void	Clear ()
void	OnColClick (wxListEvent &event)
	handle sort order updates
void	ReverseOrder ()
void	OnQuit (GlobalEvents::GlobalEventData data)
void	OnQuit (EventDataType data)
void	StartTimer ()
void	StopTimer ()
Single Selection methods
using these funcs in a multi selection list is meaningless at best, harmful in the worst case Todo: insert debug asserts to catch that
long	GetSelectedIndex () const
void	SetSelectedIndex (const long newindex)
DataType	GetDataFromIndex (const long index)
const DataType	GetDataFromIndex (const long index) const
DataType	GetSelectedData ()
Multi Selection methods
using these funcs in a single selection list is meaingless at best, harmful in the worst case Todo: insert debug asserts to catch that
void	SaveSelection ()
void	ResetSelection ()
void	RestoreSelection ()
	and this afterwards
void	SelectAll ()
void	SelectInverse ()
overloaded wxFunctions
these are used to display items in virtual lists
wxString	OnGetItemText (long item, long column) const
int	OnGetItemColumnImage (long item, long column) const
wxListItemAttr *	OnGetItemAttr (long item) const
bool	GetColumn (int col, wxListItem &item) const
	when using the dummy column, we provide diff impl that adjust for that
bool	SetColumn (int col, wxListItem &item)
Protected Types
typedef CustomVirtListCtrl < IBattle *, BattleListCtrl >	BaseType
typedef UserActions::ActionType	ActionType
typedef std::vector< colInfo >	colInfoVec
typedef std::map< unsigned int, unsigned int >	ColumnMap
	maps outward column index to internal
typedef std::map< int, int >	VisibilityMap
	map: index in visible list <--> index in data vector
typedef VisibilityMap::iterator	VisibilityMapIter
typedef std::vector< IBattle * >	DataVector
typedef DataVector::iterator	DataIter
typedef DataVector::const_iterator	DataCIter
typedef DataVector::reverse_iterator	DataRevIter
typedef DataVector::const_reverse_iterator	DataRevCIter
typedef DataType	SelectedDataType
typedef std::vector < SelectedDataType >	SelectedDataVector
typedef EventReceiverFunc < OnQuitSink, EventDataType,&OnQuitSink::OnQuit >	EventReceiverFunction
Protected Member Functions
int	CompareOneCrit (DataType u1, DataType u2, int col, int dir) const
int	GetIndexFromData (const DataType &data) const
virtual void	Sort ()
	must be implemented in derived classes, should call the actual sorting on data and refreshitems
int	getColumnFromPosition (wxPoint pos)
	primarily used to get coulumn index in mousevents (from cur. mouse pos)
bool	RemoveItem (const IBattle *&item)
bool	AddItem (const IBattle *&item)
void	OnPeriodicSort (wxTimerEvent &evt)
void	OnSortEvent (wxCommandEvent &evt)
	this is the sink for a custom event that can be used for async sort
Static Protected Member Functions
static int	CompareStatus (DataType u1, DataType u2)
static int	ComparePlayer (DataType u1, DataType u2)
Protected Attributes
wxMenu *	m_popup
wxTimer	m_tiptimer
	used to display tooltips for a certain amount of time
wxTimer	m_sort_timer
	used to block sorting while mouse is moving
wxString	m_tiptext
	always set to the currrently displayed tooltip text
unsigned int	m_columnCount
long	m_selected_index
	index of curently selected data
long	m_prev_selected_index
	index of previously selected data
colInfoVec	m_colinfovec
	stores info about the columns (wxString name,bool isResizable) - pairs
VisibilityMap	m_visible_idxs
	list indexes of not-filtered items use like this: when adding items set identity mapping m_visible_idxs[m_data.size() -1] = ( m_data.size() -1 ); when filtering clear the map, iterate thru data and only set mapping for matching items in data when acessing data (getColoumText etc.
wxPoint	m_last_mouse_pos
wxString	m_name
	used as label for saving column widths
bool	m_highlight
	controls if highlighting should be considered
ActionType	m_highlightAction
	which action should be considered?
const wxColour	m_bg_color
bool	m_dirty_sort
	list should be sorted
ColumnMap	m_column_map
DataVector	m_data
SelectedDataVector	m_selected_data
ItemComparator< DataType >	m_comparator
	the Comparator object passed to the SLInsertionSort function
long	m_periodic_sort_timer_id
wxTimer	m_periodic_sort_timer
bool	m_periodic_sort
unsigned int	m_periodic_sort_interval
EventReceiverFunction	m_OnQuitSink
Static Protected Attributes
static const unsigned int	m_tooltip_delay
	global Tooltip thingies (ms)
static const unsigned int	m_tooltip_duration
static const unsigned int	m_sort_block_time
Sort functionality

unsigned int	m_sort_criteria_count
void	SortList (bool force=false)
	only sorts if data is marked dirty, or force is true calls Freeze(), Sort(), Thaw()
static int	compareSimple (Type o1, Type o2)
	compare func usable for types with well-defined ordering (and implemented ops <,>)
typedef ItemComparator < IBattle * >::CmpFunc	CompareFunction
static SortOrder	m_sortorder = SortOrder()

Detailed Description

The ListCtrll contained in BattleListTab dispalying all currently active battles with their infos.

Todo:: DOCMEMORE

Definition at line 17 of file battlelistctrl.h.

Member Typedef Documentation

typedef UserActions::ActionType CustomVirtListCtrl< IBattle * , BattleListCtrl >::ActionType [protected, inherited]

Definition at line 55 of file customvirtlistctrl.h.

typedef CustomVirtListCtrl< IBattle * , BattleListCtrl > CustomVirtListCtrl< IBattle * , BattleListCtrl >::BaseType [protected, inherited]

Reimplemented from OnQuitSink< Derived, EventDataType >.

Definition at line 53 of file customvirtlistctrl.h.

typedef std::vector<colInfo> CustomVirtListCtrl< IBattle * , BattleListCtrl >::colInfoVec [protected, inherited]

Definition at line 90 of file customvirtlistctrl.h.

typedef std::map<unsigned int,unsigned int> CustomVirtListCtrl< IBattle * , BattleListCtrl >::ColumnMap [protected, inherited]

maps outward column index to internal

Definition at line 93 of file customvirtlistctrl.h.

typedef ItemComparator<IBattle * >::CmpFunc CustomVirtListCtrl< IBattle * , BattleListCtrl >::CompareFunction [protected, inherited]

Definition at line 200 of file customvirtlistctrl.h.

typedef DataVector::const_iterator CustomVirtListCtrl< IBattle * , BattleListCtrl >::DataCIter [protected, inherited]

Definition at line 333 of file customvirtlistctrl.h.

typedef DataVector::iterator CustomVirtListCtrl< IBattle * , BattleListCtrl >::DataIter [protected, inherited]

Definition at line 331 of file customvirtlistctrl.h.

typedef DataVector::const_reverse_iterator CustomVirtListCtrl< IBattle * , BattleListCtrl >::DataRevCIter [protected, inherited]

Definition at line 337 of file customvirtlistctrl.h.

typedef DataVector::reverse_iterator CustomVirtListCtrl< IBattle * , BattleListCtrl >::DataRevIter [protected, inherited]

Definition at line 335 of file customvirtlistctrl.h.

typedef IBattle * CustomVirtListCtrl< IBattle * , BattleListCtrl >::DataType [inherited]

Definition at line 49 of file customvirtlistctrl.h.

typedef std::vector< IBattle * > CustomVirtListCtrl< IBattle * , BattleListCtrl >::DataVector [protected, inherited]

Definition at line 329 of file customvirtlistctrl.h.

template<class Derived, class EventDataType = GlobalEvents::GlobalEventData>

typedef EventReceiverFunc<OnQuitSink, EventDataType, &OnQuitSink::OnQuit> OnQuitSink< Derived, EventDataType >::EventReceiverFunction [protected, inherited]

Definition at line 65 of file isink.h.

typedef DataType CustomVirtListCtrl< IBattle * , BattleListCtrl >::SelectedDataType [protected, inherited]

Definition at line 341 of file customvirtlistctrl.h.

typedef std::vector< SelectedDataType > CustomVirtListCtrl< IBattle * , BattleListCtrl >::SelectedDataVector [protected, inherited]

Definition at line 343 of file customvirtlistctrl.h.

typedef std::map<int,int> CustomVirtListCtrl< IBattle * , BattleListCtrl >::VisibilityMap [protected, inherited]

map: index in visible list <--> index in data vector

Definition at line 115 of file customvirtlistctrl.h.

typedef VisibilityMap::iterator CustomVirtListCtrl< IBattle * , BattleListCtrl >::VisibilityMapIter [protected, inherited]

Definition at line 116 of file customvirtlistctrl.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

BLIST_LIST
BLIST_DLMOD
BLIST_DLMAP

Definition at line 39 of file battlelistctrl.h.

Constructor & Destructor Documentation

BattleListCtrl::BattleListCtrl ( wxWindow * parent )

Definition at line 35 of file battlelistctrl.cpp.

BattleListCtrl::~BattleListCtrl ( )

Definition at line 80 of file battlelistctrl.cpp.

Member Function Documentation

void BattleListCtrl::AddBattle ( IBattle & battle )

Definition at line 170 of file battlelistctrl.cpp.

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::AddColumn	(	long	i,
		int	width,
		const wxString &	label,
		const wxString &	tip,
		bool	= `true`
	)			`[inherited]`

intermediate function to add info to m_colinfovec after calling base class function

bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::AddItem ( const IBattle * & item ) [protected, inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::CancelTooltipTimer ( ) [inherited]

stop timer (before displaying popup f.e.)

virtual void CustomVirtListCtrl< IBattle * , BattleListCtrl >::Clear ( ) [virtual, inherited]

delete all data, selections, and whatnot

int BattleListCtrl::CompareOneCrit	(	DataType	u1,
		DataType	u2,
		int	col,
		int	dir
	)			const `[protected]`

Definition at line 241 of file battlelistctrl.cpp.

int BattleListCtrl::ComparePlayer	(	DataType	u1,
		DataType	u2
	)			`[static, protected]`

Definition at line 312 of file battlelistctrl.cpp.

static int CustomVirtListCtrl< IBattle * , BattleListCtrl >::compareSimple	(	Type	o1,
		Type	o2
	)			`[inline, static, protected, inherited]`

compare func usable for types with well-defined ordering (and implemented ops <,>)

Definition at line 204 of file customvirtlistctrl.h.

int BattleListCtrl::CompareStatus	(	DataType	u1,
		DataType	u2
	)			`[static, protected]`

Definition at line 274 of file battlelistctrl.cpp.

bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::GetColumn	(	int	col,
		wxListItem &	item
	)			const `[inherited]`

when using the dummy column, we provide diff impl that adjust for that

int CustomVirtListCtrl< IBattle * , BattleListCtrl >::getColumnFromPosition ( wxPoint pos ) [protected, inherited]

primarily used to get coulumn index in mousevents (from cur. mouse pos)

const DataType CustomVirtListCtrl< IBattle * , BattleListCtrl >::GetDataFromIndex ( const long index ) const [inherited]

DataType CustomVirtListCtrl< IBattle * , BattleListCtrl >::GetDataFromIndex ( const long index ) [inherited]

int BattleListCtrl::GetIndexFromData ( const DataType & data ) const [protected, virtual]

Implements CustomVirtListCtrl< IBattle *, BattleListCtrl >.

Definition at line 387 of file battlelistctrl.cpp.

wxListItemAttr * BattleListCtrl::GetItemAttr ( long item ) const

Definition at line 144 of file battlelistctrl.cpp.

int BattleListCtrl::GetItemColumnImage	(	long	item,
		long	column
	)			const

Definition at line 118 of file battlelistctrl.cpp.

int BattleListCtrl::GetItemImage ( long item ) const

Definition at line 110 of file battlelistctrl.cpp.

wxString BattleListCtrl::GetItemText	(	long	item,
		long	column
	)			const

Definition at line 85 of file battlelistctrl.cpp.

DataType CustomVirtListCtrl< IBattle * , BattleListCtrl >::GetSelectedData ( ) [inherited]

long CustomVirtListCtrl< IBattle * , BattleListCtrl >::GetSelectedIndex ( ) const [inherited]

wxListItemAttr* CustomVirtListCtrl< IBattle * , BattleListCtrl >::HighlightItemUser ( const wxString & name ) const [inherited]

all that needs to be implemented in child class for UpdateHighlights to work

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::MarkDirtySort ( ) [inherited]

marks the items in the control to be sorted

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::noOp ( wxMouseEvent & event ) [inherited]

does nothing

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnColClick ( wxListEvent & event ) [inherited]

handle sort order updates

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnDeselected ( wxListEvent & event ) [inherited]

void BattleListCtrl::OnDLMap ( wxCommandEvent & event )

Definition at line 215 of file battlelistctrl.cpp.

void BattleListCtrl::OnDLMod ( wxCommandEvent & event )

Definition at line 223 of file battlelistctrl.cpp.

virtual void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnEndResizeCol ( wxListEvent & event ) [virtual, inherited]

we use this to automatically save column width after resizin

wxListItemAttr* CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnGetItemAttr ( long item ) const [inherited]

int CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnGetItemColumnImage	(	long	item,
		long	column
	)			const `[inherited]`

wxString CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnGetItemText	(	long	item,
		long	column
	)			const `[inherited]`

void BattleListCtrl::OnListRightClick ( wxListEvent & event )

Definition at line 194 of file battlelistctrl.cpp.

virtual void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnMouseMotion ( wxMouseEvent & event ) [virtual, inherited]

starts timer, sets tooltiptext

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnPeriodicSort ( wxTimerEvent & evt ) [protected, inherited]

template<class Derived, class EventDataType = GlobalEvents::GlobalEventData>

void OnQuitSink< Derived, EventDataType >::OnQuit ( EventDataType data ) [inline, inherited]

Reimplemented in CustomVirtListCtrl< DataImp, ListCtrlImp >, NotificationManager, and SpringLobbyApp.

Definition at line 61 of file isink.h.

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnQuit ( GlobalEvents::GlobalEventData data ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnSelected ( wxListEvent & event ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnSortEvent ( wxCommandEvent & evt ) [protected, inherited]

this is the sink for a custom event that can be used for async sort

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnStartResizeCol ( wxListEvent & event ) [inherited]

prohibits resizin if so set in columnInfo

virtual void CustomVirtListCtrl< IBattle * , BattleListCtrl >::OnTimer ( wxTimerEvent & event ) [virtual, inherited]

this event is triggered when delay timer (set in mousemotion) ended

bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::PopupMenu	(	wxMenu *	menu,
		const wxPoint &	pos = `wxDefaultPosition`
	)			`[inherited]`

Override to have tooltip timer cancelled automatically.

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::RefreshVisibleItems ( ) [inherited]

void BattleListCtrl::RemoveBattle ( IBattle & battle )

Definition at line 178 of file battlelistctrl.cpp.

bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::RemoveItem ( const IBattle * & item ) [protected, inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::ResetColumnSizes ( ) [inherited]

reset columns with current set size (only effects columns with auto-size)

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::ResetSelection ( ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::RestoreSelection ( ) [inherited]

and this afterwards

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::ReverseOrder ( ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::SaveSelection ( ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::SelectAll ( ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::SelectInverse ( ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::SelectNone ( ) [inherited]

sets selected index to -1

bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::SetColumn	(	int	col,
		wxListItem &	item
	)			`[inherited]`

virtual bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::SetColumnWidth	(	int	col,
		int &	width
	)			`[virtual, inherited]`

automatically get saved column width if already saved, otherwise use parameter and save new width

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::SetHighLightAction ( UserActions::ActionType action ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::SetSelectedIndex ( const long newindex ) [inherited]

void BattleListCtrl::SetTipWindowText	(	const long	item_hit,
		const wxPoint &	position
	)			`[virtual]`

Reimplemented from CustomVirtListCtrl< IBattle *, BattleListCtrl >.

Definition at line 322 of file battlelistctrl.cpp.

void BattleListCtrl::Sort ( ) [protected, virtual]

must be implemented in derived classes, should call the actual sorting on data and refreshitems

Implements CustomVirtListCtrl< IBattle *, BattleListCtrl >.

Definition at line 231 of file battlelistctrl.cpp.

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::SortList ( bool force = false ) [inherited]

only sorts if data is marked dirty, or force is true calls Freeze(), Sort(), Thaw()

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::StartTimer ( ) [inherited]

void CustomVirtListCtrl< IBattle * , BattleListCtrl >::StopTimer ( ) [inherited]

void BattleListCtrl::UpdateBattle ( IBattle & battle )

Definition at line 186 of file battlelistctrl.cpp.

Field Documentation

const wxColour CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_bg_color [protected, inherited]

Definition at line 137 of file customvirtlistctrl.h.

colInfoVec CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_colinfovec [protected, inherited]

stores info about the columns (wxString name,bool isResizable) - pairs

Definition at line 110 of file customvirtlistctrl.h.

ColumnMap CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_column_map [protected, inherited]

Definition at line 144 of file customvirtlistctrl.h.

unsigned int CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_columnCount [protected, inherited]

Definition at line 67 of file customvirtlistctrl.h.

ItemComparator<DataType> CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_comparator [protected, inherited]

the Comparator object passed to the SLInsertionSort function

Definition at line 347 of file customvirtlistctrl.h.

DataVector CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_data [protected, inherited]

Definition at line 338 of file customvirtlistctrl.h.

bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_dirty_sort [protected, inherited]

list should be sorted

Definition at line 140 of file customvirtlistctrl.h.

bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_highlight [protected, inherited]

controls if highlighting should be considered

Definition at line 132 of file customvirtlistctrl.h.

ActionType CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_highlightAction [protected, inherited]

which action should be considered?

Definition at line 135 of file customvirtlistctrl.h.

wxPoint CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_last_mouse_pos [protected, inherited]

Definition at line 126 of file customvirtlistctrl.h.

wxString CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_name [protected, inherited]

used as label for saving column widths

Definition at line 129 of file customvirtlistctrl.h.

template<class Derived, class EventDataType = GlobalEvents::GlobalEventData>

EventReceiverFunction OnQuitSink< Derived, EventDataType >::m_OnQuitSink [protected, inherited]

Definition at line 66 of file isink.h.

bool CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_periodic_sort [protected, inherited]

Definition at line 354 of file customvirtlistctrl.h.

unsigned int CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_periodic_sort_interval [protected, inherited]

Definition at line 355 of file customvirtlistctrl.h.

wxTimer CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_periodic_sort_timer [protected, inherited]

Definition at line 353 of file customvirtlistctrl.h.

long CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_periodic_sort_timer_id [protected, inherited]

Definition at line 352 of file customvirtlistctrl.h.

wxMenu* BattleListCtrl::m_popup [protected]

Definition at line 53 of file battlelistctrl.h.

long CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_prev_selected_index [protected, inherited]

index of previously selected data

Definition at line 106 of file customvirtlistctrl.h.

SelectedDataVector CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_selected_data [protected, inherited]

Definition at line 344 of file customvirtlistctrl.h.

long CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_selected_index [protected, inherited]

index of curently selected data

Definition at line 103 of file customvirtlistctrl.h.

const unsigned int CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_sort_block_time [static, protected, inherited]

Definition at line 99 of file customvirtlistctrl.h.

unsigned int CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_sort_criteria_count [protected, inherited]

Definition at line 152 of file customvirtlistctrl.h.

wxTimer CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_sort_timer [protected, inherited]

used to block sorting while mouse is moving

Definition at line 59 of file customvirtlistctrl.h.

SortOrder CustomVirtListCtrl< IBattle *, BattleListCtrl >::m_sortorder = SortOrder() [inline, static, protected, inherited]

Definition at line 151 of file customvirtlistctrl.h.

wxString CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_tiptext [protected, inherited]

always set to the currrently displayed tooltip text

Definition at line 61 of file customvirtlistctrl.h.

wxTimer CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_tiptimer [protected, inherited]

used to display tooltips for a certain amount of time

Definition at line 57 of file customvirtlistctrl.h.

const unsigned int CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_tooltip_delay [static, protected, inherited]

global Tooltip thingies (ms)

Definition at line 97 of file customvirtlistctrl.h.

const unsigned int CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_tooltip_duration [static, protected, inherited]

Definition at line 98 of file customvirtlistctrl.h.

VisibilityMap CustomVirtListCtrl< IBattle * , BattleListCtrl >::m_visible_idxs [protected, inherited]

list indexes of not-filtered items use like this: when adding items set identity mapping
m_visible_idxs[m_data.size() -1] = ( m_data.size() -1 );
when filtering clear the map, iterate thru data and only set mapping for matching items in data
when acessing data (getColoumText etc.

) always access data's index thru this map

Definition at line 123 of file customvirtlistctrl.h.

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

/home/buildbot/slaves/docs/docs/build/src/battlelistctrl.h
/home/buildbot/slaves/docs/docs/build/src/battlelistctrl.cpp

BattleListCtrl Class Reference

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Sort functionality

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation