BattleListFilter Class Reference

The panel contained in BattleListTab used to filter for diff info of battles. More...

#include <battlelistfilter.h>

Collaboration diagram for BattleListFilter:

Public Types
enum	ButtonMode { BUTTON_MODE_EQUAL, BUTTON_MODE_BIGGER, BUTTON_MODE_SMALLER }
Public Member Functions
	BattleListFilter (wxWindow parent, wxWindowID id, BattleListTab parentBattleListTab, const wxPoint &pos, const wxSize &size, long style)
void	OnRankButton (wxCommandEvent &event)
void	OnPlayerButton (wxCommandEvent &event)
void	OnMaxPlayerButton (wxCommandEvent &event)
void	OnSpectatorButton (wxCommandEvent &event)
void	OnActivate (wxCommandEvent &event)
void	SetActiv (bool state)
void	OnChange (wxCommandEvent &event)
void	OnChangeMap (wxCommandEvent &event)
void	OnChangeMod (wxCommandEvent &event)
void	OnChangeDescription (wxCommandEvent &event)
void	OnChangeHost (wxCommandEvent &event)
void	OnRankChange (wxCommandEvent &event)
void	OnPlayerChange (wxCommandEvent &event)
void	OnMaxPlayerChange (wxCommandEvent &event)
void	OnSpectatorChange (wxCommandEvent &event)
bool	FilterBattle (IBattle &battle)
bool	GetActiv () const
void	SetFilterHighlighted (bool state)
void	SaveFilterValues ()
Static Public Member Functions
static bool	StringMatches (const wxString &input, const wxString &filter_string, const wxRegEx *filter_regex=NULL, StringTransformFunction additional_transform=NULL, bool case_sensitive=false)
	Test whether an input string matches a filter string.
Protected Types
typedef wxString(*	StringTransformFunction )(const wxString &input)
	A function callback used to transform an input string.
Protected Member Functions
wxString	_GetButtonSign (ButtonMode value)
ButtonMode	_GetNextMode (ButtonMode value)
ButtonMode	_GetButtonMode (const wxString &sign)
bool	_IntCompare (int a, int b, ButtonMode mode)
Protected Attributes
bool	m_activ
BattleListTab *	m_parent_battlelisttab
wxCheckBox *	m_filter_show
wxStaticText *	m_filter_text
wxCheckBox *	m_filter_activ
wxStaticText *	m_filter_host_text
wxTextCtrl *	m_filter_host_edit
wxRegEx *	m_filter_host_expression
wxStaticText *	m_filter_status_text
wxStaticText *	m_filter_status_text1
wxCheckBox *	m_filter_status_locked
wxCheckBox *	m_filter_status_pass
wxCheckBox *	m_filter_status_start
wxCheckBox *	m_filter_status_full
wxCheckBox *	m_filter_status_open
wxStaticText *	m_filter_rank_text
ButtonMode	m_filter_rank_mode
wxButton *	m_filter_rank_button
wxChoice *	m_filter_rank_choice
int	m_filter_rank_choice_value
wxStaticText *	m_filter_description_text
wxTextCtrl *	m_filter_description_edit
wxRegEx *	m_filter_description_expression
wxStaticText *	m_filter_player_text
wxButton *	m_filter_player_button
ButtonMode	m_filter_player_mode
wxChoice *	m_filter_player_choice
int	m_filter_player_choice_value
wxStaticText *	m_filter_map_text
wxTextCtrl *	m_filter_map_edit
wxCheckBox *	m_filter_map_show
wxRegEx *	m_filter_map_expression
wxStaticText *	m_filter_maxplayer_text
wxButton *	m_filter_maxplayer_button
ButtonMode	m_filter_maxplayer_mode
wxChoice *	m_filter_maxplayer_choice
int	m_filter_maxplayer_choice_value
wxStaticText *	m_filter_mod_text
wxTextCtrl *	m_filter_mod_edit
wxCheckBox *	m_filter_mod_show
wxRegEx *	m_filter_mod_expression
wxStaticText *	m_filter_spectator_text
wxButton *	m_filter_spectator_button
ButtonMode	m_filter_spectator_mode
wxChoice *	m_filter_spectator_choice
int	m_filter_spectator_choice_value
wxCheckBox *	m_filter_highlighted

Detailed Description

The panel contained in BattleListTab used to filter for diff info of battles.

Todo:: DOCMEMORE

Definition at line 24 of file battlelistfilter.h.

Member Typedef Documentation

typedef wxString(* BattleListFilter::StringTransformFunction)(const wxString &input) [protected]

A function callback used to transform an input string.

Definition at line 69 of file battlelistfilter.h.

Member Enumeration Documentation

enum BattleListFilter::ButtonMode

Enumerator:

BUTTON_MODE_EQUAL
BUTTON_MODE_BIGGER
BUTTON_MODE_SMALLER

Definition at line 55 of file battlelistfilter.h.

Constructor & Destructor Documentation

BattleListFilter::BattleListFilter	(	wxWindow *	parent,
		wxWindowID	id,
		BattleListTab *	parentBattleListTab,
		const wxPoint &	pos,
		const wxSize &	size,
		long	style
	)

Definition at line 59 of file battlelistfilter.cpp.

Member Function Documentation

BattleListFilter::ButtonMode BattleListFilter::_GetButtonMode ( const wxString & sign ) [protected]

Definition at line 371 of file battlelistfilter.cpp.

wxString BattleListFilter::_GetButtonSign ( const BattleListFilter::ButtonMode value ) [protected]

Definition at line 380 of file battlelistfilter.cpp.

BattleListFilter::ButtonMode BattleListFilter::_GetNextMode ( const BattleListFilter::ButtonMode value ) [protected]

Definition at line 394 of file battlelistfilter.cpp.

bool BattleListFilter::_IntCompare	(	int	a,
		int	b,
		const BattleListFilter::ButtonMode	mode
	)			`[protected]`

Definition at line 407 of file battlelistfilter.cpp.

bool BattleListFilter::FilterBattle ( IBattle & battle )

Is `nonsenserank' useful, or can it be removed? Why is it here in the first place?

TODO

Definition at line 491 of file battlelistfilter.cpp.

bool BattleListFilter::GetActiv ( ) const

Definition at line 677 of file battlelistfilter.cpp.

void BattleListFilter::OnActivate ( wxCommandEvent & event )

void BattleListFilter::OnChange ( wxCommandEvent & event )

Definition at line 593 of file battlelistfilter.cpp.

void BattleListFilter::OnChangeDescription ( wxCommandEvent & event )

Definition at line 624 of file battlelistfilter.cpp.

void BattleListFilter::OnChangeHost ( wxCommandEvent & event )

Definition at line 636 of file battlelistfilter.cpp.

void BattleListFilter::OnChangeMap ( wxCommandEvent & event )

Definition at line 600 of file battlelistfilter.cpp.

void BattleListFilter::OnChangeMod ( wxCommandEvent & event )

Definition at line 612 of file battlelistfilter.cpp.

void BattleListFilter::OnMaxPlayerButton ( wxCommandEvent & event )

Definition at line 468 of file battlelistfilter.cpp.

void BattleListFilter::OnMaxPlayerChange ( wxCommandEvent & event )

Definition at line 663 of file battlelistfilter.cpp.

void BattleListFilter::OnPlayerButton ( wxCommandEvent & event )

Definition at line 460 of file battlelistfilter.cpp.

void BattleListFilter::OnPlayerChange ( wxCommandEvent & event )

Definition at line 656 of file battlelistfilter.cpp.

void BattleListFilter::OnRankButton ( wxCommandEvent & event )

Definition at line 453 of file battlelistfilter.cpp.

void BattleListFilter::OnRankChange ( wxCommandEvent & event )

Definition at line 649 of file battlelistfilter.cpp.

void BattleListFilter::OnSpectatorButton ( wxCommandEvent & event )

Definition at line 476 of file battlelistfilter.cpp.

void BattleListFilter::OnSpectatorChange ( wxCommandEvent & event )

Definition at line 670 of file battlelistfilter.cpp.

void BattleListFilter::SaveFilterValues ( )

Definition at line 682 of file battlelistfilter.cpp.

void BattleListFilter::SetActiv ( bool state )

Definition at line 483 of file battlelistfilter.cpp.

void BattleListFilter::SetFilterHighlighted ( bool state )

bool BattleListFilter::StringMatches	(	const wxString &	input,
		const wxString &	filter_string,
		const wxRegEx *	filter_regex = `NULL`,
		StringTransformFunction	additional_transform = `NULL`,
		bool	case_sensitive = `false`
	)			`[static]`

Test whether an input string matches a filter string.

The filter will be tried as both a fixed string, and as a regular expression.

Parameters:

	input	The input string to test.
	filter_string	A fixed string to match against.
	filter_regex	A regular expression object pointer. If the expression is valid, it will be used to match the input if the fixed string does not.
	additional_transform	A function that should be called to generate an additional input string.
	case_sensitive	`true` if the comparison should be done case-sensitively.