Search Toolkit Book for CSelectionControl

#include <gui/widgets/wx/selection_control.hpp>

Inheritance diagram for CSelectionControl:

Collaboration diagram for CSelectionControl:

Public Types
enum	EItemState { fDefaultState = 0x00 , fItemSelected = 0x01 , fItemFocused = 0x02 , fWidgetFocused = 0x04 }

enum	EStyle { fDefaultStyle = 0x00 , fSingleSelection = 0x01 }

typedef int	TIndex

typedef void *	TItemHandle

typedef vector< TIndex >	TIndexVector

typedef vector< TItemHandle >	TItemHandleVector

Public Member Functions
	CSelectionControl ()

virtual	~CSelectionControl ()

virtual int	GetStyle () const
	Low-level worker functions - implementation dependend. More...

virtual void	SetStyle (int style)

virtual int	GetItemState (TIndex index) const
	Items state and selection. More...

virtual void	SetItemState (TIndex index, int state)

virtual bool	IsItemFocused (TIndex index) const

virtual TIndex	GetFocusedIndex () const

virtual bool	IsItemSelected (TIndex index) const

virtual TIndex	GetSelectedIndex () const

virtual TIndex	GetSelectedCount () const

virtual void	GetSelectedIndexes (TIndexVector &indexes) const

virtual void	FocusItem (TIndex index)

virtual void	SelectItem (TIndex index, bool select=true)

virtual void	SelectItems (TIndexVector &indexes, bool select=true)

virtual void	SelectAll (bool select=true)

void	MoveSelectionBy (int shift, CGUIEvent::EGUIState state)

Protected Types
typedef pair< TItemHandle, bool >	TItemEntry

typedef vector< TItemEntry >	TEntryVector

typedef map< TItemHandle, int >	TItemToIndexMap

Protected Member Functions
bool	x_AssertIndexValid (TIndex index) const
	Protected API -. More...

TIndex	x_GetItemsCount () const

void	x_SetItems (const TItemHandleVector &items, bool b_update, bool keep_selection=false)

bool	x_InsertItem (TIndex index, const TItemHandle &item, bool update)

void	x_InsertItems (const TItemHandleVector &items, const TIndexVector &indices, bool update)

bool	x_DeleteItem (TIndex index, bool update=true)

void	x_DeleteAllItems ()

void	x_Clear ()

virtual void	x_SelectItem (TIndex index, bool select)

virtual void	x_SendSelectionEvent (TIndex index)=0

virtual void	x_SelectSingleItem (TIndex index)
	handles selection of a single item from UI More...

virtual void	x_InvertSingleItem (TIndex index)

virtual void	x_SelectItems (const TIndexVector &vIndexes, bool reset_others=false)
	Select items with given indices. More...

virtual void	x_SelectAll (bool select=true)

virtual void	x_SelectTo (TIndex index)

void	OnMouseDown (wxMouseEvent &event)
	Event handling. More...

void	OnKeyDown (wxKeyEvent &event)

void	x_SelectTo (int index, CGUIEvent::EGUIState state)

void	x_MoveSelectionBy (int shift, CGUIEvent::EGUIState state)

void	x_SelectFocusedItem (bool deselect_en)

void	x_UpdateItemToIndex ()

void	x_DebugValid () const

virtual void	x_UpdateItems (TIndexVector &indexes)=0

virtual void	x_UpdateItemsRange (TIndex start, TIndex end)=0

virtual int	x_GetIndexByWindowPos (int win_x, int win_y, bool clip=false)=0

virtual void	x_MakeVisible (TIndex index)=0

Protected Attributes
TEntryVector	m_Entries

TItemToIndexMap	m_ItemToIndex

int	m_Style

TIndex	m_SelectedCount

TIndex	m_SingleSelected
	number of selected items More...

TIndex	m_FocusedIndex
	index of the selected itme (valid only in fSingleSelection mode) More...

TIndex	m_AnchorIndex

Detailed Description

Definition at line 48 of file selection_control.hpp.

Member Typedef Documentation

◆ TEntryVector

typedef vector<TItemEntry> CSelectionControl::TEntryVector

protected

Definition at line 148 of file selection_control.hpp.

◆ TIndex

typedef int CSelectionControl::TIndex

Definition at line 51 of file selection_control.hpp.

◆ TIndexVector

typedef vector<TIndex> CSelectionControl::TIndexVector

Definition at line 53 of file selection_control.hpp.

◆ TItemEntry

typedef pair<TItemHandle, bool> CSelectionControl::TItemEntry

protected

Definition at line 147 of file selection_control.hpp.

◆ TItemHandle

typedef void* CSelectionControl::TItemHandle

Definition at line 52 of file selection_control.hpp.

◆ TItemHandleVector

typedef vector<TItemHandle> CSelectionControl::TItemHandleVector

Definition at line 54 of file selection_control.hpp.

◆ TItemToIndexMap

typedef map<TItemHandle, int> CSelectionControl::TItemToIndexMap

protected

Definition at line 149 of file selection_control.hpp.

Member Enumeration Documentation

◆ EItemState

enum CSelectionControl::EItemState

Enumerator
fDefaultState
fItemSelected
fItemFocused
fWidgetFocused

Definition at line 56 of file selection_control.hpp.

◆ EStyle

enum CSelectionControl::EStyle

Enumerator
fDefaultStyle
fSingleSelection

Definition at line 63 of file selection_control.hpp.

Constructor & Destructor Documentation

◆ CSelectionControl()

CSelectionControl::CSelectionControl ( )

Definition at line 46 of file selection_control.cpp.

◆ ~CSelectionControl()

virtual CSelectionControl::~CSelectionControl ( )

inlinevirtual

Definition at line 69 of file selection_control.hpp.

Member Function Documentation

◆ FocusItem()

void CSelectionControl::FocusItem ( TIndex index )

virtual

Definition at line 166 of file selection_control.cpp.

References _ASSERT, m_FocusedIndex, x_DebugValid(), x_GetItemsCount(), and x_UpdateItems().

Referenced by SetItemState(), and x_SelectTo().

◆ GetFocusedIndex()

CSelectionControl::TIndex CSelectionControl::GetFocusedIndex ( ) const

virtual

Definition at line 115 of file selection_control.cpp.

References m_FocusedIndex.

Referenced by CMapControl::x_HorzMoveSelectionBy(), x_MoveSelectionBy(), and x_SelectFocusedItem().

◆ GetItemState()

int CSelectionControl::GetItemState ( TIndex index ) const

virtual

Items state and selection.

Definition at line 70 of file selection_control.cpp.

References fItemFocused, fItemSelected, IsItemFocused(), IsItemSelected(), and x_AssertIndexValid().

Referenced by CMapControl::x_DrawItemsRange().

◆ GetSelectedCount()

CSelectionControl::TIndex CSelectionControl::GetSelectedCount ( ) const

virtual

Definition at line 145 of file selection_control.cpp.

References m_SelectedCount.

◆ GetSelectedIndex()

CSelectionControl::TIndex CSelectionControl::GetSelectedIndex ( ) const

virtual

Reimplemented in CMapControl.

Definition at line 128 of file selection_control.cpp.

References _ASSERT, count, fSingleSelection, GetStyle(), i, m_Entries, m_SelectedCount, and x_GetItemsCount().

Referenced by CMapControl::GetSelectedIndex(), and CRunToolDlg::x_CreateToolItems().

◆ GetSelectedIndexes()

void CSelectionControl::GetSelectedIndexes ( TIndexVector & indexes ) const

virtual

Definition at line 151 of file selection_control.cpp.

References _ASSERT, count, i, m_Entries, m_SelectedCount, x_DebugValid(), and x_GetItemsCount().

Referenced by CMapControl::x_DoDefaultActionOnSelected(), and x_SelectSingleItem().

◆ GetStyle()

int CSelectionControl::GetStyle ( ) const

virtual

Low-level worker functions - implementation dependend.

Definition at line 58 of file selection_control.cpp.

References m_Style.

Referenced by GetSelectedIndex().

◆ IsItemFocused()

bool CSelectionControl::IsItemFocused ( TIndex index ) const

virtual

Definition at line 107 of file selection_control.cpp.

References m_FocusedIndex, and x_AssertIndexValid().

Referenced by GetItemState(), and SetItemState().

◆ IsItemSelected()

bool CSelectionControl::IsItemSelected ( TIndex index ) const

virtual

Definition at line 121 of file selection_control.cpp.

References m_Entries, and x_AssertIndexValid().

Referenced by GetItemState(), SetItemState(), x_DeleteItem(), x_InvertSingleItem(), x_SelectFocusedItem(), x_SelectItems(), x_SelectSingleItem(), and x_SelectTo().

◆ MoveSelectionBy()

void CSelectionControl::MoveSelectionBy	(	int	shift,
		CGUIEvent::EGUIState	state
	)

inline

Definition at line 93 of file selection_control.hpp.

References x_MoveSelectionBy().

Referenced by CMapControl::OnMouseWheel().

◆ OnKeyDown()

void CSelectionControl::OnKeyDown ( wxKeyEvent & event )

protected

Definition at line 502 of file selection_control.cpp.

References CGUIEvent::eSelectIncState, ncbi::grid::netcache::search::fields::key, CGUIEvent::wxGetSelectState(), x_GetItemsCount(), x_MoveSelectionBy(), x_SelectAll(), x_SelectFocusedItem(), and x_SelectTo().

Referenced by CMapControl::OnKeyDown().

◆ OnMouseDown()

void CSelectionControl::OnMouseDown ( wxMouseEvent & event )

protected

Event handling.

Definition at line 473 of file selection_control.cpp.

References CGUIEvent::eSelectExtState, CGUIEvent::eSelectIncState, CGUIEvent::eSelectState, fSingleSelection, m_Style, CGUIEvent::wxGetSelectState(), x_GetIndexByWindowPos(), x_InvertSingleItem(), x_SelectAll(), x_SelectSingleItem(), and x_SelectTo().

Referenced by CMapControl::OnMouseDown().

◆ SelectAll()

void CSelectionControl::SelectAll ( bool select = true )

virtual

Definition at line 202 of file selection_control.cpp.

References x_SelectAll().

◆ SelectItem()

void CSelectionControl::SelectItem	(	TIndex	index,
		bool	select = `true`
	)

virtual

Definition at line 186 of file selection_control.cpp.

References x_AssertIndexValid(), x_SelectItem(), and x_UpdateItemsRange().

Referenced by CGroupMapWidget::Init(), SetItemState(), and CRunToolDlg::x_CreateToolItems().

◆ SelectItems()

void CSelectionControl::SelectItems	(	TIndexVector &	indexes,
		bool	select = `true`
	)

virtual

Definition at line 196 of file selection_control.cpp.

References x_SelectItems().

◆ SetItemState()

void CSelectionControl::SetItemState	(	TIndex	index,
		int	state
	)

virtual

Definition at line 87 of file selection_control.cpp.

References fItemFocused, fItemSelected, FocusItem(), IsItemFocused(), IsItemSelected(), SelectItem(), and x_AssertIndexValid().

◆ SetStyle()

void CSelectionControl::SetStyle ( int style )

virtual

Definition at line 64 of file selection_control.cpp.

References m_Style.

Referenced by CGroupMapWidget::CGroupMapWidget().

◆ x_AssertIndexValid()

bool CSelectionControl::x_AssertIndexValid ( TIndex index ) const

protected

Protected API -.

TODO move up

Definition at line 323 of file selection_control.cpp.

References _ASSERT, and m_Entries.

Referenced by CMapControl::DeleteItem(), CMapControl::GetItem(), GetItemState(), IsItemFocused(), IsItemSelected(), SelectItem(), SetItemState(), x_DeleteItem(), CMapControl::x_GetItem(), x_InvertSingleItem(), CMapControl::x_MakeVisible(), and x_SelectItem().

◆ x_Clear()

void CSelectionControl::x_Clear ( void )

protected

Definition at line 308 of file selection_control.cpp.

References map_checker< Container >::clear(), m_AnchorIndex, m_Entries, m_FocusedIndex, m_ItemToIndex, and m_SelectedCount.

Referenced by x_DeleteAllItems().

◆ x_DebugValid()

void CSelectionControl::x_DebugValid ( ) const

protected

Definition at line 600 of file selection_control.cpp.

References _ASSERT, i, m_Entries, m_ItemToIndex, m_SelectedCount, and map_checker< Container >::size().

Referenced by FocusItem(), GetSelectedIndexes(), x_DeleteItem(), x_InvertSingleItem(), x_SelectAll(), x_SelectFocusedItem(), x_SelectItems(), x_SelectSingleItem(), and x_SelectTo().

◆ x_DeleteAllItems()

void CSelectionControl::x_DeleteAllItems ( )

protected

Definition at line 301 of file selection_control.cpp.

References x_Clear(), and x_UpdateItemsRange().

Referenced by CMapControl::DeleteAllItems().

◆ x_DeleteItem()

bool CSelectionControl::x_DeleteItem	(	TIndex	index,
		bool	update = `true`
	)

protected

Definition at line 271 of file selection_control.cpp.

References count, map_checker< Container >::erase(), IsItemSelected(), m_AnchorIndex, m_Entries, m_FocusedIndex, m_ItemToIndex, m_SelectedCount, max(), x_AssertIndexValid(), x_DebugValid(), x_GetItemsCount(), and x_UpdateItemsRange().

Referenced by CMapControl::DeleteItem().

◆ x_GetIndexByWindowPos()

virtual int CSelectionControl::x_GetIndexByWindowPos	(	int	win_x,
		int	win_y,
		bool	clip = `false`
	)

protectedpure virtual

Implemented in CMapControl.

Referenced by OnMouseDown().

◆ x_GetItemsCount()

CSelectionControl::TIndex CSelectionControl::x_GetItemsCount ( ) const

protected

Definition at line 223 of file selection_control.cpp.

References m_Entries.

Referenced by FocusItem(), GetSelectedIndex(), GetSelectedIndexes(), OnKeyDown(), x_DeleteItem(), x_InsertItem(), x_InsertItems(), x_MoveSelectionBy(), x_SelectAll(), x_SelectItems(), and x_SelectTo().

◆ x_InsertItem()

bool CSelectionControl::x_InsertItem	(	TIndex	index,
		const TItemHandle &	item,
		bool	update
	)

protected

Definition at line 255 of file selection_control.cpp.

References m_Entries, max(), x_GetItemsCount(), x_UpdateItemsRange(), and x_UpdateItemToIndex().

Referenced by CMapControl::AddItem(), and CMapControl::InsertItem().

◆ x_InsertItems()

void CSelectionControl::x_InsertItems	(	const TItemHandleVector &	items,
		const TIndexVector &	indices,
		bool	update
	)

protected

Definition at line 229 of file selection_control.cpp.

References _ASSERT, i, m_Entries, max(), min(), x_GetItemsCount(), x_UpdateItemsRange(), and x_UpdateItemToIndex().

◆ x_InvertSingleItem()

void CSelectionControl::x_InvertSingleItem ( TIndex index )

protectedvirtual

Definition at line 375 of file selection_control.cpp.

References IsItemSelected(), m_AnchorIndex, m_FocusedIndex, m_SelectedCount, x_AssertIndexValid(), x_DebugValid(), x_SelectItem(), and x_UpdateItems().

Referenced by OnMouseDown(), and x_SelectFocusedItem().

◆ x_MakeVisible()

virtual void CSelectionControl::x_MakeVisible ( TIndex index )

protectedpure virtual

Implemented in CMapControl.

Referenced by x_SelectTo().

◆ x_MoveSelectionBy()

void CSelectionControl::x_MoveSelectionBy	(	int	shift,
		CGUIEvent::EGUIState	state
	)

protected

Definition at line 537 of file selection_control.cpp.

References count, GetFocusedIndex(), max(), min(), x_GetItemsCount(), and x_SelectTo().

Referenced by MoveSelectionBy(), and OnKeyDown().

◆ x_SelectAll()

void CSelectionControl::x_SelectAll ( bool select = true )

protectedvirtual

Definition at line 208 of file selection_control.cpp.

References count, i, m_Entries, m_SelectedCount, x_DebugValid(), x_GetItemsCount(), and x_UpdateItemsRange().

Referenced by OnKeyDown(), OnMouseDown(), and SelectAll().

◆ x_SelectFocusedItem()

void CSelectionControl::x_SelectFocusedItem ( bool deselect_en )

protected

Definition at line 578 of file selection_control.cpp.

References GetFocusedIndex(), IsItemSelected(), x_DebugValid(), and x_InvertSingleItem().

Referenced by OnKeyDown().

◆ x_SelectItem()

void CSelectionControl::x_SelectItem	(	TIndex	index,
		bool	select
	)

protectedvirtual

Definition at line 331 of file selection_control.cpp.

References m_Entries, m_SelectedCount, x_AssertIndexValid(), and x_SendSelectionEvent().

Referenced by SelectItem(), x_InvertSingleItem(), x_SelectItems(), x_SelectSingleItem(), and x_SelectTo().

◆ x_SelectItems()

void CSelectionControl::x_SelectItems	(	const TIndexVector &	indexes,
		bool	reset_others = `false`
	)

protectedvirtual

Select items with given indices.

If "invert_others" == "true" - deselects all other items.

Definition at line 400 of file selection_control.cpp.

References i, IsItemSelected(), ITERATE, m_SelectedCount, x_DebugValid(), x_GetItemsCount(), x_SelectItem(), x_UpdateItems(), and x_UpdateItemsRange().

Referenced by SelectItems().

◆ x_SelectSingleItem()

void CSelectionControl::x_SelectSingleItem ( TIndex index )

protectedvirtual

handles selection of a single item from UI

Definition at line 347 of file selection_control.cpp.

References GetSelectedIndexes(), i, IsItemSelected(), m_AnchorIndex, m_FocusedIndex, m_SelectedCount, x_DebugValid(), x_SelectItem(), and x_UpdateItems().

Referenced by OnMouseDown(), and x_SelectTo().

◆ x_SelectTo() [1/2]

void CSelectionControl::x_SelectTo	(	int	index,
		CGUIEvent::EGUIState	state
	)

protected

Definition at line 554 of file selection_control.cpp.

References CGUIEvent::eSelectExtState, CGUIEvent::eSelectIncState, CGUIEvent::eSelectState, FocusItem(), fSingleSelection, m_Style, x_DebugValid(), x_MakeVisible(), x_SelectSingleItem(), and x_SelectTo().

◆ x_SelectTo() [2/2]

void CSelectionControl::x_SelectTo ( TIndex index )

protectedvirtual

Definition at line 436 of file selection_control.cpp.

References count, i, IsItemSelected(), m_AnchorIndex, m_FocusedIndex, max(), min(), x_DebugValid(), x_GetItemsCount(), x_SelectItem(), and x_UpdateItems().

Referenced by OnKeyDown(), OnMouseDown(), CMapControl::x_HorzMoveSelectionBy(), x_MoveSelectionBy(), and x_SelectTo().

◆ x_SendSelectionEvent()

virtual void CSelectionControl::x_SendSelectionEvent ( TIndex index )

protectedpure virtual

Implemented in CMapControl.

Referenced by x_SelectItem().

◆ x_SetItems()

void CSelectionControl::x_SetItems	(	const TItemHandleVector &	items,
		bool	b_update,
		bool	keep_selection = `false`
	)

protected

◆ x_UpdateItems()

virtual void CSelectionControl::x_UpdateItems ( TIndexVector & indexes )

protectedpure virtual

Implemented in CMapControl.

Referenced by FocusItem(), x_InvertSingleItem(), x_SelectItems(), x_SelectSingleItem(), and x_SelectTo().

◆ x_UpdateItemsRange()

virtual void CSelectionControl::x_UpdateItemsRange	(	TIndex	start,
		TIndex	end
	)

protectedpure virtual

Implemented in CMapControl.

Referenced by SelectItem(), x_DeleteAllItems(), x_DeleteItem(), x_InsertItem(), x_InsertItems(), x_SelectAll(), and x_SelectItems().

◆ x_UpdateItemToIndex()

void CSelectionControl::x_UpdateItemToIndex ( )

protected

Definition at line 591 of file selection_control.cpp.

References map_checker< Container >::clear(), i, m_Entries, and m_ItemToIndex.

Referenced by x_InsertItem(), and x_InsertItems().

Member Data Documentation

◆ m_AnchorIndex

TIndex CSelectionControl::m_AnchorIndex

protected

Definition at line 158 of file selection_control.hpp.

Referenced by x_Clear(), x_DeleteItem(), x_InvertSingleItem(), x_SelectSingleItem(), and x_SelectTo().

◆ m_Entries

TEntryVector CSelectionControl::m_Entries

protected

Definition at line 151 of file selection_control.hpp.

Referenced by GetSelectedIndex(), GetSelectedIndexes(), IsItemSelected(), x_AssertIndexValid(), x_Clear(), x_DebugValid(), x_DeleteItem(), x_GetItemsCount(), x_InsertItem(), x_InsertItems(), x_SelectAll(), x_SelectItem(), and x_UpdateItemToIndex().

◆ m_FocusedIndex

TIndex CSelectionControl::m_FocusedIndex

protected

index of the selected itme (valid only in fSingleSelection mode)

Definition at line 157 of file selection_control.hpp.

Referenced by FocusItem(), GetFocusedIndex(), IsItemFocused(), x_Clear(), x_DeleteItem(), x_InvertSingleItem(), x_SelectSingleItem(), and x_SelectTo().

◆ m_ItemToIndex

TItemToIndexMap CSelectionControl::m_ItemToIndex

protected

Definition at line 152 of file selection_control.hpp.

Referenced by x_Clear(), x_DebugValid(), x_DeleteItem(), and x_UpdateItemToIndex().

◆ m_SelectedCount

TIndex CSelectionControl::m_SelectedCount

protected

Definition at line 155 of file selection_control.hpp.

Referenced by GetSelectedCount(), GetSelectedIndex(), GetSelectedIndexes(), x_Clear(), x_DebugValid(), x_DeleteItem(), x_InvertSingleItem(), x_SelectAll(), x_SelectItem(), x_SelectItems(), and x_SelectSingleItem().

◆ m_SingleSelected

TIndex CSelectionControl::m_SingleSelected

protected

number of selected items

Definition at line 156 of file selection_control.hpp.

◆ m_Style

int CSelectionControl::m_Style

protected

Definition at line 154 of file selection_control.hpp.

Referenced by GetStyle(), OnMouseDown(), SetStyle(), and x_SelectTo().

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

include/gui/widgets/wx/selection_control.hpp
src/gui/widgets/wx/selection_control.cpp

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ TEntryVector

◆ TIndex

◆ TIndexVector

◆ TItemEntry

◆ TItemHandle

◆ TItemHandleVector

◆ TItemToIndexMap

Member Enumeration Documentation

◆ EItemState

◆ EStyle

Constructor & Destructor Documentation

◆ CSelectionControl()

◆ ~CSelectionControl()

Member Function Documentation

◆ FocusItem()

◆ GetFocusedIndex()

◆ GetItemState()

◆ GetSelectedCount()

◆ GetSelectedIndex()

◆ GetSelectedIndexes()

◆ GetStyle()

◆ IsItemFocused()

◆ IsItemSelected()

◆ MoveSelectionBy()

◆ OnKeyDown()

◆ OnMouseDown()

◆ SelectAll()

◆ SelectItem()

◆ SelectItems()

◆ SetItemState()

◆ SetStyle()

◆ x_AssertIndexValid()

◆ x_Clear()

◆ x_DebugValid()

◆ x_DeleteAllItems()

◆ x_DeleteItem()

◆ x_GetIndexByWindowPos()

◆ x_GetItemsCount()

◆ x_InsertItem()

◆ x_InsertItems()

◆ x_InvertSingleItem()

◆ x_MakeVisible()

◆ x_MoveSelectionBy()

◆ x_SelectAll()

◆ x_SelectFocusedItem()

◆ x_SelectItem()

◆ x_SelectItems()

◆ x_SelectSingleItem()

◆ x_SelectTo() [1/2]

◆ x_SelectTo() [2/2]

◆ x_SendSelectionEvent()

◆ x_SetItems()

◆ x_UpdateItems()

◆ x_UpdateItemsRange()

◆ x_UpdateItemToIndex()

Member Data Documentation

◆ m_AnchorIndex

◆ m_Entries

◆ m_FocusedIndex

◆ m_ItemToIndex

◆ m_SelectedCount

◆ m_SingleSelected

◆ m_Style