BattleroomListCtrl Class Reference

display participants of battle and their info (ally,team,color,cpu. More...

#include <battleroomlistctrl.h>

Inherits CustomVirtListCtrl< User *, BattleroomListCtrl >.

Collaboration diagram for BattleroomListCtrl:
Collaboration graph
[legend]

Public Types

typedef UserDataType

Public Member Functions

 BattleroomListCtrl (wxWindow *parent, IBattle *battle, bool readonly, bool showingame)
 ~BattleroomListCtrl ()
void SetBattle (IBattle *battle)
IBattleGetBattle ()
void AddUser (User &user)
void RemoveUser (User &user)
void UpdateUser (const int &index)
void UpdateUser (User &user)
void UpdateList ()
int GetIndexFromData (const DataType &data) const
void OnListRightClick (wxListEvent &event)
void OnColClick (wxListEvent &event)
 handle sort order updates
void OnTeamSelect (wxCommandEvent &event)
void OnAllySelect (wxCommandEvent &event)
void OnColourSelect (wxCommandEvent &event)
void OnSideSelect (wxCommandEvent &event)
void OnHandicapSelect (wxCommandEvent &event)
void OnSpecSelect (wxCommandEvent &event)
void OnActivateItem (wxListEvent &event)
void OnKickPlayer (wxCommandEvent &event)
void OnRingPlayer (wxCommandEvent &event)
void OnUserMenuCreateGroup (wxCommandEvent &event)
void OnUserMenuDeleteFromGroup (wxCommandEvent &event)
void OnUserMenuAddToGroup (wxCommandEvent &event)
virtual void SetTipWindowText (const long item_hit, const wxPoint &position)
wxString GetItemText (long item, long column) 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 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

enum  {
  BRLIST_LIST = wxID_HIGHEST, BRLIST_TEAM, BRLIST_ALLY = BRLIST_TEAM + 1000, BRLIST_COLOUR = BRLIST_ALLY + 1000,
  BRLIST_SIDE = BRLIST_COLOUR +1000, BRLIST_HANDICAP = BRLIST_SIDE +1000, BRLIST_SPEC, BRLIST_KICK,
  BRLIST_RING, BRLIST_ADDTOGROUP
}
typedef SL_GENERIC::UserMenu
< BattleroomListCtrl
UserMenu
typedef CustomVirtListCtrl
< User *, BattleroomListCtrl
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< User * > 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

wxString GetSelectedUserNick ()
int CompareOneCrit (DataType u1, DataType u2, int col, int dir) 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 User *&item)
bool AddItem (const User *&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 CompareLobbyStatus (const DataType user1, const DataType user2)
static int CompareStatus (const DataType user1, const DataType user2, const IBattle *m_battle)
static int CompareSide (const DataType user1, const DataType user2)
static int CompareColor (const DataType user1, const DataType user2)
static int CompareRank (const DataType user1, const DataType user2)
static int CompareTeam (const DataType user1, const DataType user2)
static int CompareAlly (const DataType user1, const DataType user2)
static int CompareCpu (const DataType user1, const DataType user2)
static int CompareHandicap (const DataType user1, const DataType user2)

Protected Attributes

IBattlem_battle
UserMenum_popup
Userm_sel_user
wxMenu * m_sides
std::vector< wxMenuItem * > side_vector
wxMenuItem * m_spec_item
wxMenuItem * m_handicap_item
bool m_ro
bool m_showingame
int m_status_column_index
int m_ingame_column_index
int m_faction_column_index
int m_colour_column_index
int m_country_column_index
int m_rank_column_index
int m_nick_column_index
int m_team_column_index
int m_ally_column_index
int m_cpu_column_index
int m_resourcebonus_column_index
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< DataTypem_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



typedef ItemComparator< User * >
::CmpFunc 
CompareFunction
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 <,>)
static SortOrder m_sortorder = SortOrder()

Detailed Description

display participants of battle and their info (ally,team,color,cpu.

..)

Todo:
DOCMEMORE

Definition at line 15 of file battleroomlistctrl.h.


Member Typedef Documentation

Definition at line 55 of file customvirtlistctrl.h.

Reimplemented from OnQuitSink< Derived, EventDataType >.

Definition at line 53 of file customvirtlistctrl.h.

typedef std::vector<colInfo> CustomVirtListCtrl< User * , BattleroomListCtrl >::colInfoVec [protected, inherited]

Definition at line 90 of file customvirtlistctrl.h.

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

maps outward column index to internal

Definition at line 93 of file customvirtlistctrl.h.

typedef ItemComparator<User * >::CmpFunc CustomVirtListCtrl< User * , BattleroomListCtrl >::CompareFunction [protected, inherited]

Definition at line 200 of file customvirtlistctrl.h.

typedef DataVector::const_iterator CustomVirtListCtrl< User * , BattleroomListCtrl >::DataCIter [protected, inherited]

Definition at line 333 of file customvirtlistctrl.h.

typedef DataVector::iterator CustomVirtListCtrl< User * , BattleroomListCtrl >::DataIter [protected, inherited]

Definition at line 331 of file customvirtlistctrl.h.

typedef DataVector::const_reverse_iterator CustomVirtListCtrl< User * , BattleroomListCtrl >::DataRevCIter [protected, inherited]

Definition at line 337 of file customvirtlistctrl.h.

typedef DataVector::reverse_iterator CustomVirtListCtrl< User * , BattleroomListCtrl >::DataRevIter [protected, inherited]

Definition at line 335 of file customvirtlistctrl.h.

typedef User * CustomVirtListCtrl< User * , BattleroomListCtrl >::DataType [inherited]

Definition at line 49 of file customvirtlistctrl.h.

typedef std::vector< User * > CustomVirtListCtrl< User * , BattleroomListCtrl >::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< User * , BattleroomListCtrl >::SelectedDataType [protected, inherited]

Definition at line 341 of file customvirtlistctrl.h.

typedef std::vector< SelectedDataType > CustomVirtListCtrl< User * , BattleroomListCtrl >::SelectedDataVector [protected, inherited]

Definition at line 343 of file customvirtlistctrl.h.

Definition at line 70 of file battleroomlistctrl.h.

typedef std::map<int,int> CustomVirtListCtrl< User * , BattleroomListCtrl >::VisibilityMap [protected, inherited]

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

Definition at line 115 of file customvirtlistctrl.h.

typedef VisibilityMap::iterator CustomVirtListCtrl< User * , BattleroomListCtrl >::VisibilityMapIter [protected, inherited]

Definition at line 116 of file customvirtlistctrl.h.


Member Enumeration Documentation

anonymous enum [protected]
Enumerator:
BRLIST_LIST 
BRLIST_TEAM 
BRLIST_ALLY 
BRLIST_COLOUR 
BRLIST_SIDE 
BRLIST_HANDICAP 
BRLIST_SPEC 
BRLIST_KICK 
BRLIST_RING 
BRLIST_ADDTOGROUP 

Definition at line 101 of file battleroomlistctrl.h.


Constructor & Destructor Documentation

BattleroomListCtrl::BattleroomListCtrl ( wxWindow *  parent,
IBattle battle,
bool  readonly,
bool  showingame 
)

Definition at line 56 of file battleroomlistctrl.cpp.

BattleroomListCtrl::~BattleroomListCtrl (  ) 

Definition at line 193 of file battleroomlistctrl.cpp.


Member Function Documentation

void CustomVirtListCtrl< User * , BattleroomListCtrl >::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< User * , BattleroomListCtrl >::AddItem ( const User * &  item  )  [protected, inherited]
void BattleroomListCtrl::AddUser ( User user  ) 

Definition at line 232 of file battleroomlistctrl.cpp.

void CustomVirtListCtrl< User * , BattleroomListCtrl >::CancelTooltipTimer (  )  [inherited]

stop timer (before displaying popup f.e.)

virtual void CustomVirtListCtrl< User * , BattleroomListCtrl >::Clear (  )  [virtual, inherited]

delete all data, selections, and whatnot

int BattleroomListCtrl::CompareAlly ( const DataType  user1,
const DataType  user2 
) [static, protected]

Definition at line 691 of file battleroomlistctrl.cpp.

int BattleroomListCtrl::CompareColor ( const DataType  user1,
const DataType  user2 
) [static, protected]

Definition at line 610 of file battleroomlistctrl.cpp.

int BattleroomListCtrl::CompareCpu ( const DataType  user1,
const DataType  user2 
) [static, protected]

Definition at line 717 of file battleroomlistctrl.cpp.

int BattleroomListCtrl::CompareHandicap ( const DataType  user1,
const DataType  user2 
) [static, protected]

Definition at line 755 of file battleroomlistctrl.cpp.

int BattleroomListCtrl::CompareLobbyStatus ( const DataType  user1,
const DataType  user2 
) [static, protected]

Definition at line 504 of file battleroomlistctrl.cpp.

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

Definition at line 488 of file battleroomlistctrl.cpp.

int BattleroomListCtrl::CompareRank ( const DataType  user1,
const DataType  user2 
) [static, protected]

Definition at line 639 of file battleroomlistctrl.cpp.

int BattleroomListCtrl::CompareSide ( const DataType  user1,
const DataType  user2 
) [static, protected]

Definition at line 584 of file battleroomlistctrl.cpp.

static int CustomVirtListCtrl< User * , BattleroomListCtrl >::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 BattleroomListCtrl::CompareStatus ( const DataType  user1,
const DataType  user2,
const IBattle m_battle 
) [static, protected]

Definition at line 534 of file battleroomlistctrl.cpp.

int BattleroomListCtrl::CompareTeam ( const DataType  user1,
const DataType  user2 
) [static, protected]

Definition at line 665 of file battleroomlistctrl.cpp.

IBattle & BattleroomListCtrl::GetBattle (  ) 

Definition at line 226 of file battleroomlistctrl.cpp.

bool CustomVirtListCtrl< User * , BattleroomListCtrl >::GetColumn ( int  col,
wxListItem &  item 
) const [inherited]

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

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

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

const DataType CustomVirtListCtrl< User * , BattleroomListCtrl >::GetDataFromIndex ( const long  index  )  const [inherited]
DataType CustomVirtListCtrl< User * , BattleroomListCtrl >::GetDataFromIndex ( const long  index  )  [inherited]
int BattleroomListCtrl::GetIndexFromData ( const DataType data  )  const [virtual]
wxListItemAttr * BattleroomListCtrl::GetItemAttr ( long  item  )  const

Definition at line 262 of file battleroomlistctrl.cpp.

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

Definition at line 277 of file battleroomlistctrl.cpp.

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

TODO could prolly be cached

Definition at line 310 of file battleroomlistctrl.cpp.

DataType CustomVirtListCtrl< User * , BattleroomListCtrl >::GetSelectedData (  )  [inherited]
long CustomVirtListCtrl< User * , BattleroomListCtrl >::GetSelectedIndex (  )  const [inherited]
wxString BattleroomListCtrl::GetSelectedUserNick (  )  [protected]

Definition at line 936 of file battleroomlistctrl.cpp.

wxListItemAttr* CustomVirtListCtrl< User * , BattleroomListCtrl >::HighlightItemUser ( const wxString name  )  const [inherited]

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

void CustomVirtListCtrl< User * , BattleroomListCtrl >::MarkDirtySort (  )  [inherited]

marks the items in the control to be sorted

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

does nothing

void BattleroomListCtrl::OnActivateItem ( wxListEvent &  event  ) 

Definition at line 944 of file battleroomlistctrl.cpp.

void BattleroomListCtrl::OnAllySelect ( wxCommandEvent &  event  ) 

Definition at line 418 of file battleroomlistctrl.cpp.

void BattleroomListCtrl::OnColClick ( wxListEvent &  event  ) 

handle sort order updates

Reimplemented from CustomVirtListCtrl< User *, BattleroomListCtrl >.

void BattleroomListCtrl::OnColourSelect ( wxCommandEvent &  event  ) 

Definition at line 426 of file battleroomlistctrl.cpp.

void CustomVirtListCtrl< User * , BattleroomListCtrl >::OnDeselected ( wxListEvent &  event  )  [inherited]
virtual void CustomVirtListCtrl< User * , BattleroomListCtrl >::OnEndResizeCol ( wxListEvent &  event  )  [virtual, inherited]

we use this to automatically save column width after resizin

wxListItemAttr* CustomVirtListCtrl< User * , BattleroomListCtrl >::OnGetItemAttr ( long  item  )  const [inherited]
int CustomVirtListCtrl< User * , BattleroomListCtrl >::OnGetItemColumnImage ( long  item,
long  column 
) const [inherited]
wxString CustomVirtListCtrl< User * , BattleroomListCtrl >::OnGetItemText ( long  item,
long  column 
) const [inherited]
void BattleroomListCtrl::OnHandicapSelect ( wxCommandEvent &  event  ) 

Definition at line 446 of file battleroomlistctrl.cpp.

void BattleroomListCtrl::OnKickPlayer ( wxCommandEvent &  event  ) 

Definition at line 465 of file battleroomlistctrl.cpp.

void BattleroomListCtrl::OnListRightClick ( wxListEvent &  event  ) 

Definition at line 365 of file battleroomlistctrl.cpp.

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

starts timer, sets tooltiptext

void CustomVirtListCtrl< User * , BattleroomListCtrl >::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< User * , BattleroomListCtrl >::OnQuit ( GlobalEvents::GlobalEventData  data  )  [inherited]
void BattleroomListCtrl::OnRingPlayer ( wxCommandEvent &  event  ) 

Definition at line 472 of file battleroomlistctrl.cpp.

void CustomVirtListCtrl< User * , BattleroomListCtrl >::OnSelected ( wxListEvent &  event  )  [inherited]
void BattleroomListCtrl::OnSideSelect ( wxCommandEvent &  event  ) 

Definition at line 438 of file battleroomlistctrl.cpp.

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

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

void BattleroomListCtrl::OnSpecSelect ( wxCommandEvent &  event  ) 

Definition at line 458 of file battleroomlistctrl.cpp.

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

prohibits resizin if so set in columnInfo

void BattleroomListCtrl::OnTeamSelect ( wxCommandEvent &  event  ) 

Definition at line 410 of file battleroomlistctrl.cpp.

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

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

void BattleroomListCtrl::OnUserMenuAddToGroup ( wxCommandEvent &  event  ) 

Definition at line 907 of file battleroomlistctrl.cpp.

void BattleroomListCtrl::OnUserMenuCreateGroup ( wxCommandEvent &  event  ) 

Definition at line 922 of file battleroomlistctrl.cpp.

void BattleroomListCtrl::OnUserMenuDeleteFromGroup ( wxCommandEvent &  event  ) 

Definition at line 916 of file battleroomlistctrl.cpp.

bool CustomVirtListCtrl< User * , BattleroomListCtrl >::PopupMenu ( wxMenu *  menu,
const wxPoint pos = wxDefaultPosition 
) [inherited]

Override to have tooltip timer cancelled automatically.

void CustomVirtListCtrl< User * , BattleroomListCtrl >::RefreshVisibleItems (  )  [inherited]
bool CustomVirtListCtrl< User * , BattleroomListCtrl >::RemoveItem ( const User * &  item  )  [protected, inherited]
void BattleroomListCtrl::RemoveUser ( User user  ) 

Definition at line 243 of file battleroomlistctrl.cpp.

void CustomVirtListCtrl< User * , BattleroomListCtrl >::ResetColumnSizes (  )  [inherited]

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

void CustomVirtListCtrl< User * , BattleroomListCtrl >::ResetSelection (  )  [inherited]
void CustomVirtListCtrl< User * , BattleroomListCtrl >::RestoreSelection (  )  [inherited]

and this afterwards

void CustomVirtListCtrl< User * , BattleroomListCtrl >::ReverseOrder (  )  [inherited]
void CustomVirtListCtrl< User * , BattleroomListCtrl >::SaveSelection (  )  [inherited]
void CustomVirtListCtrl< User * , BattleroomListCtrl >::SelectAll (  )  [inherited]
void CustomVirtListCtrl< User * , BattleroomListCtrl >::SelectInverse (  )  [inherited]
void CustomVirtListCtrl< User * , BattleroomListCtrl >::SelectNone (  )  [inherited]

sets selected index to -1

void BattleroomListCtrl::SetBattle ( IBattle battle  ) 

Definition at line 198 of file battleroomlistctrl.cpp.

bool CustomVirtListCtrl< User * , BattleroomListCtrl >::SetColumn ( int  col,
wxListItem &  item 
) [inherited]
virtual bool CustomVirtListCtrl< User * , BattleroomListCtrl >::SetColumnWidth ( int  col,
int &  width 
) [virtual, inherited]

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

void CustomVirtListCtrl< User * , BattleroomListCtrl >::SetHighLightAction ( UserActions::ActionType  action  )  [inherited]
void CustomVirtListCtrl< User * , BattleroomListCtrl >::SetSelectedIndex ( const long  newindex  )  [inherited]
void BattleroomListCtrl::SetTipWindowText ( const long  item_hit,
const wxPoint position 
) [virtual]

Reimplemented from CustomVirtListCtrl< User *, BattleroomListCtrl >.

Definition at line 777 of file battleroomlistctrl.cpp.

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

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

Implements CustomVirtListCtrl< User *, BattleroomListCtrl >.

Definition at line 478 of file battleroomlistctrl.cpp.

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

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

void CustomVirtListCtrl< User * , BattleroomListCtrl >::StartTimer (  )  [inherited]
void CustomVirtListCtrl< User * , BattleroomListCtrl >::StopTimer (  )  [inherited]
void BattleroomListCtrl::UpdateList (  ) 
void BattleroomListCtrl::UpdateUser ( User user  ) 

Definition at line 251 of file battleroomlistctrl.cpp.

void BattleroomListCtrl::UpdateUser ( const int &  index  ) 

Definition at line 358 of file battleroomlistctrl.cpp.


Field Documentation

Definition at line 97 of file battleroomlistctrl.h.

Definition at line 68 of file battleroomlistctrl.h.

const wxColour CustomVirtListCtrl< User * , BattleroomListCtrl >::m_bg_color [protected, inherited]

Definition at line 137 of file customvirtlistctrl.h.

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

Definition at line 110 of file customvirtlistctrl.h.

Definition at line 92 of file battleroomlistctrl.h.

Definition at line 144 of file customvirtlistctrl.h.

unsigned int CustomVirtListCtrl< User * , BattleroomListCtrl >::m_columnCount [protected, inherited]

Definition at line 67 of file customvirtlistctrl.h.

ItemComparator<DataType> CustomVirtListCtrl< User * , BattleroomListCtrl >::m_comparator [protected, inherited]

the Comparator object passed to the SLInsertionSort function

Definition at line 347 of file customvirtlistctrl.h.

Definition at line 93 of file battleroomlistctrl.h.

Definition at line 98 of file battleroomlistctrl.h.

Definition at line 338 of file customvirtlistctrl.h.

bool CustomVirtListCtrl< User * , BattleroomListCtrl >::m_dirty_sort [protected, inherited]

list should be sorted

Definition at line 140 of file customvirtlistctrl.h.

Definition at line 91 of file battleroomlistctrl.h.

wxMenuItem* BattleroomListCtrl::m_handicap_item [protected]

Definition at line 79 of file battleroomlistctrl.h.

bool CustomVirtListCtrl< User * , BattleroomListCtrl >::m_highlight [protected, inherited]

controls if highlighting should be considered

Definition at line 132 of file customvirtlistctrl.h.

which action should be considered?

Definition at line 135 of file customvirtlistctrl.h.

Definition at line 90 of file battleroomlistctrl.h.

Definition at line 126 of file customvirtlistctrl.h.

wxString CustomVirtListCtrl< User * , BattleroomListCtrl >::m_name [protected, inherited]

used as label for saving column widths

Definition at line 129 of file customvirtlistctrl.h.

Definition at line 95 of file battleroomlistctrl.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< User * , BattleroomListCtrl >::m_periodic_sort [protected, inherited]

Definition at line 354 of file customvirtlistctrl.h.

unsigned int CustomVirtListCtrl< User * , BattleroomListCtrl >::m_periodic_sort_interval [protected, inherited]

Definition at line 355 of file customvirtlistctrl.h.

wxTimer CustomVirtListCtrl< User * , BattleroomListCtrl >::m_periodic_sort_timer [protected, inherited]

Definition at line 353 of file customvirtlistctrl.h.

Definition at line 352 of file customvirtlistctrl.h.

Definition at line 71 of file battleroomlistctrl.h.

long CustomVirtListCtrl< User * , BattleroomListCtrl >::m_prev_selected_index [protected, inherited]

index of previously selected data

Definition at line 106 of file customvirtlistctrl.h.

Definition at line 94 of file battleroomlistctrl.h.

Definition at line 99 of file battleroomlistctrl.h.

bool BattleroomListCtrl::m_ro [protected]

Definition at line 85 of file battleroomlistctrl.h.

Definition at line 73 of file battleroomlistctrl.h.

Definition at line 344 of file customvirtlistctrl.h.

long CustomVirtListCtrl< User * , BattleroomListCtrl >::m_selected_index [protected, inherited]

index of curently selected data

Definition at line 103 of file customvirtlistctrl.h.

Definition at line 86 of file battleroomlistctrl.h.

wxMenu* BattleroomListCtrl::m_sides [protected]

Definition at line 75 of file battleroomlistctrl.h.

const unsigned int CustomVirtListCtrl< User * , BattleroomListCtrl >::m_sort_block_time [static, protected, inherited]

Definition at line 99 of file customvirtlistctrl.h.

unsigned int CustomVirtListCtrl< User * , BattleroomListCtrl >::m_sort_criteria_count [protected, inherited]

Definition at line 152 of file customvirtlistctrl.h.

wxTimer CustomVirtListCtrl< User * , BattleroomListCtrl >::m_sort_timer [protected, inherited]

used to block sorting while mouse is moving

Definition at line 59 of file customvirtlistctrl.h.

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

Definition at line 151 of file customvirtlistctrl.h.

wxMenuItem* BattleroomListCtrl::m_spec_item [protected]

Definition at line 77 of file battleroomlistctrl.h.

Definition at line 89 of file battleroomlistctrl.h.

Definition at line 96 of file battleroomlistctrl.h.

always set to the currrently displayed tooltip text

Definition at line 61 of file customvirtlistctrl.h.

wxTimer CustomVirtListCtrl< User * , BattleroomListCtrl >::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< User * , BattleroomListCtrl >::m_tooltip_delay [static, protected, inherited]

global Tooltip thingies (ms)

Definition at line 97 of file customvirtlistctrl.h.

const unsigned int CustomVirtListCtrl< User * , BattleroomListCtrl >::m_tooltip_duration [static, protected, inherited]

Definition at line 98 of file customvirtlistctrl.h.

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.

std::vector<wxMenuItem*> BattleroomListCtrl::side_vector [protected]

Definition at line 76 of file battleroomlistctrl.h.


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

Generated on Thu Dec 29 00:11:43 2011 for SpringLobby by doxygen 1.6.3