SYMBOLS_LISTBOX Class Reference

#include <listboxes.h>

Inheritance diagram for SYMBOLS_LISTBOX:

Public Member Functions
	SYMBOLS_LISTBOX (CVPCB_MAINFRAME *parent, wxWindowID id)
virtual	~SYMBOLS_LISTBOX ()=default
void	Clear ()
int	GetCount ()
wxString	OnGetItemText (long item, long column) const override
	This overloaded function MUST be provided for the wxLC_VIRTUAL mode because real data is not handled by ITEMS_LISTBOX_BASE.
wxListItemAttr *	OnGetItemAttr (long item) const override
void	SetSelection (int index, bool State=true)
void	SetString (unsigned linecount, const wxString &text)
void	AppendLine (const wxString &text)
void	AppendWarning (int index)
void	RemoveWarning (int index)
void	OnChar (wxKeyEvent &event)
	Called on a key press.
void	OnSelectComponent (wxListEvent &event)
	DECLARE_EVENT_TABLE ()
int	GetSelection ()
void	DeselectAll ()
	Remove all selection in lists which can have more than one item selected.
virtual CVPCB_MAINFRAME *	GetParent () const
void	UpdateWidth (int aLine=-1)
	Update the width of the column based on its contents.
void	Shutdown ()

Public Attributes
wxArrayString	m_SymbolList

Protected Attributes
bool	m_isClosing

Private Member Functions
void	UpdateLineWidth (unsigned aLine, wxClientDC &dc)
	Calculate the width of the given line, and increase the column width if needed.

Private Attributes
std::vector< long >	m_symbolWarning
std::unique_ptr< wxListItemAttr >	m_warningAttr
int	m_columnWidth

Detailed Description

Definition at line 186 of file listboxes.h.

Constructor & Destructor Documentation

SYMBOLS_LISTBOX()

SYMBOLS_LISTBOX::SYMBOLS_LISTBOX	(	CVPCB_MAINFRAME *	parent,
		wxWindowID	id )

Definition at line 37 of file symbols_listbox.cpp.

References KIPLATFORM::UI::IsDarkTheme(), ITEMS_LISTBOX_BASE::ITEMS_LISTBOX_BASE(), and m_warningAttr.

Referenced by Clear().

~SYMBOLS_LISTBOX()

virtual SYMBOLS_LISTBOX::~SYMBOLS_LISTBOX ( )

virtualdefault

References text.

Member Function Documentation

AppendLine()

void SYMBOLS_LISTBOX::AppendLine

(

const wxString &

text

)

Definition at line 78 of file symbols_listbox.cpp.

References m_SymbolList, text, and ITEMS_LISTBOX_BASE::UpdateWidth().

AppendWarning()

void SYMBOLS_LISTBOX::AppendWarning

(

int

index

)

Definition at line 87 of file symbols_listbox.cpp.

References m_symbolWarning.

Clear()

void SYMBOLS_LISTBOX::Clear

(

)

Definition at line 52 of file symbols_listbox.cpp.

References Clear(), m_SymbolList, and SYMBOLS_LISTBOX().

Referenced by Clear().

DECLARE_EVENT_TABLE()

SYMBOLS_LISTBOX::DECLARE_EVENT_TABLE

(

)

DeselectAll()

void ITEMS_LISTBOX_BASE::DeselectAll ( )

inherited

Remove all selection in lists which can have more than one item selected.

Definition at line 98 of file listbox_base.cpp.

Referenced by FOOTPRINTS_LISTBOX::SetFootprints().

GetCount()

int SYMBOLS_LISTBOX::GetCount

(

)

Definition at line 59 of file symbols_listbox.cpp.

References m_SymbolList.

Referenced by SetSelection().

GetParent()

CVPCB_MAINFRAME * ITEMS_LISTBOX_BASE::GetParent ( ) const

virtualinherited

Definition at line 107 of file listbox_base.cpp.

Referenced by FOOTPRINTS_LISTBOX::OnLeftClick(), FOOTPRINTS_LISTBOX::OnLeftDClick(), SYMBOLS_LISTBOX::OnSelectComponent(), and LIBRARY_LISTBOX::OnSelectLibrary().

GetSelection()

int ITEMS_LISTBOX_BASE::GetSelection ( )

inherited

Returns

the index of the selected item in lists allowing only one item selected and the index of the first selected item in lists allowing many selection

Definition at line 92 of file listbox_base.cpp.

Referenced by FOOTPRINTS_LISTBOX::SetFootprints().

OnChar()

void SYMBOLS_LISTBOX::OnChar

(

wxKeyEvent &

event

)

Called on a key press.

Call default handler for some special keys, and for "ASCII" keys, select the first component that the name starts by the letter.

This is the default behavior of a listbox, but because we use virtual lists, the listbox does not know anything to what is displayed, we must handle this behavior here. Furthermore the reference of components is not at the beginning of displayed lines (the first word is the line number).

Definition at line 138 of file symbols_listbox.cpp.

References dump(), kicadTraceKeyEvent, ITEMS_LISTBOX_BASE::m_isClosing, m_SymbolList, SetSelection(), and text.

OnGetItemAttr()

wxListItemAttr * SYMBOLS_LISTBOX::OnGetItemAttr ( long item ) const

override

Definition at line 112 of file symbols_listbox.cpp.

References m_symbolWarning, and m_warningAttr.

OnGetItemText()

wxString SYMBOLS_LISTBOX::OnGetItemText ( long item, long column ) const

override

This overloaded function MUST be provided for the wxLC_VIRTUAL mode because real data is not handled by ITEMS_LISTBOX_BASE.

Definition at line 106 of file symbols_listbox.cpp.

References m_SymbolList.

OnSelectComponent()

void SYMBOLS_LISTBOX::OnSelectComponent

(

wxListEvent &

event

)

Definition at line 199 of file symbols_listbox.cpp.

References ITEMS_LISTBOX_BASE::GetParent(), ITEMS_LISTBOX_BASE::m_isClosing, and CVPCB_MAINFRAME::OnSelectComponent().

RemoveWarning()

void SYMBOLS_LISTBOX::RemoveWarning

(

int

index

)

Definition at line 96 of file symbols_listbox.cpp.

References m_symbolWarning.

SetSelection()

void SYMBOLS_LISTBOX::SetSelection	(	int	index,
		bool	State = true )

Definition at line 121 of file symbols_listbox.cpp.

References GetCount().

Referenced by OnChar().

SetString()

void SYMBOLS_LISTBOX::SetString	(	unsigned	linecount,
		const wxString &	text )

Definition at line 65 of file symbols_listbox.cpp.

References m_SymbolList, text, and ITEMS_LISTBOX_BASE::UpdateWidth().

Shutdown()

void ITEMS_LISTBOX_BASE::Shutdown ( )

inlineinherited

Definition at line 73 of file listboxes.h.

References m_isClosing.

UpdateLineWidth()

void ITEMS_LISTBOX_BASE::UpdateLineWidth ( unsigned aLine, wxClientDC & dc )

privateinherited

Calculate the width of the given line, and increase the column width if needed.

This is effectively the wxListCtrl code for autosizing. NB. it relies on the caller checking the given line number is valid.

Definition at line 67 of file listbox_base.cpp.

References m_columnWidth.

Referenced by UpdateWidth().

UpdateWidth()

void ITEMS_LISTBOX_BASE::UpdateWidth ( int aLine = -1 )

inherited

Update the width of the column based on its contents.

Parameters

aLine

is the line to calculate the width from. If positive, the width will only be increased if needed. If negative, we start from scratch and all lines are considered, i.e., the column may be shrunk.

Definition at line 45 of file listbox_base.cpp.

References m_columnWidth, and UpdateLineWidth().

Referenced by SYMBOLS_LISTBOX::AppendLine(), LIBRARY_LISTBOX::Finish(), FOOTPRINTS_LISTBOX::SetFootprints(), FOOTPRINTS_LISTBOX::SetString(), LIBRARY_LISTBOX::SetString(), and SYMBOLS_LISTBOX::SetString().

Member Data Documentation

m_columnWidth

int ITEMS_LISTBOX_BASE::m_columnWidth

privateinherited

Definition at line 87 of file listboxes.h.

Referenced by ITEMS_LISTBOX_BASE(), UpdateLineWidth(), and UpdateWidth().

m_isClosing

bool ITEMS_LISTBOX_BASE::m_isClosing

protectedinherited

Definition at line 84 of file listboxes.h.

Referenced by ITEMS_LISTBOX_BASE(), FOOTPRINTS_LISTBOX::OnChar(), SYMBOLS_LISTBOX::OnChar(), FOOTPRINTS_LISTBOX::OnLeftClick(), FOOTPRINTS_LISTBOX::OnLeftDClick(), SYMBOLS_LISTBOX::OnSelectComponent(), and Shutdown().

m_SymbolList

wxArrayString SYMBOLS_LISTBOX::m_SymbolList

Definition at line 231 of file listboxes.h.

Referenced by AppendLine(), Clear(), GetCount(), OnChar(), OnGetItemText(), and SetString().

m_symbolWarning

std::vector<long> SYMBOLS_LISTBOX::m_symbolWarning

private

Definition at line 234 of file listboxes.h.

Referenced by AppendWarning(), OnGetItemAttr(), and RemoveWarning().

m_warningAttr

std::unique_ptr<wxListItemAttr> SYMBOLS_LISTBOX::m_warningAttr

private

Definition at line 235 of file listboxes.h.

Referenced by OnGetItemAttr(), and SYMBOLS_LISTBOX().

---

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

• listboxes.h
• symbols_listbox.cpp