Base class to display symbol and footprint lists. More...

#include <listboxes.h>

Inheritance diagram for ITEMS_LISTBOX_BASE:

Public Member Functions
	ITEMS_LISTBOX_BASE (CVPCB_MAINFRAME *aParent, wxWindowID aId, const wxPoint &aLocation=wxDefaultPosition, const wxSize &aSize=wxDefaultSize, long aStyle=0)

	~ITEMS_LISTBOX_BASE ()

int	GetSelection ()

void	DeselectAll ()
	Remove all selection in lists which can have more than one item selected. More...

virtual CVPCB_MAINFRAME *	GetParent () const

void	UpdateWidth (int aLine=-1)
	Update the width of the column based on its contents. More...

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

Private Attributes
int	columnWidth

Detailed Description

Base class to display symbol and footprint lists.

Definition at line 42 of file listboxes.h.

Constructor & Destructor Documentation

◆ ITEMS_LISTBOX_BASE()

ITEMS_LISTBOX_BASE::ITEMS_LISTBOX_BASE	(	CVPCB_MAINFRAME *	aParent,
		wxWindowID	aId,
		const wxPoint &	aLocation = `wxDefaultPosition`,
		const wxSize &	aSize = `wxDefaultSize`,
		long	aStyle = `0`
	)

Definition at line 34 of file listbox_base.cpp.

 :
 wxListView( aParent, aId, aLocation, aSize, LISTBOX_STYLE | aStyle ),
 columnWidth( 0 )
{
 InsertColumn( 0, wxEmptyString );
}

◆ ~ITEMS_LISTBOX_BASE()

ITEMS_LISTBOX_BASE::~ITEMS_LISTBOX_BASE ( )

Definition at line 44 of file listbox_base.cpp.

45{

46}

Member Function Documentation

◆ DeselectAll()

void ITEMS_LISTBOX_BASE::DeselectAll ( )

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

Definition at line 104 of file listbox_base.cpp.

{
 for( int i = GetFirstSelected(); i >= 0; i = GetNextSelected(i))
 {
 Select( i, false );
 }
}

Referenced by FOOTPRINTS_LISTBOX::SetFootprints(), and CVPCB_MAINFRAME::SetSelectedComponent().

◆ GetParent()

CVPCB_MAINFRAME * ITEMS_LISTBOX_BASE::GetParent ( void ) const

virtual

Definition at line 113 of file listbox_base.cpp.

{
 return (CVPCB_MAINFRAME*) wxListView::GetParent();
}

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

◆ GetSelection()

int ITEMS_LISTBOX_BASE::GetSelection ( )

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 98 of file listbox_base.cpp.

{
 return GetFirstSelected();
}

Referenced by CVPCB_MAINFRAME::GetSelectedComponent(), CVPCB_MAINFRAME::OnSelectComponent(), CVPCB_MAINFRAME::onTextFilterChangedTimer(), CVPCB_MAINFRAME::refreshAfterSymbolSearch(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), and FOOTPRINTS_LISTBOX::SetFootprints().

◆ UpdateLineWidth()

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

private

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 73 of file listbox_base.cpp.

{
 wxCoord w;
 int newWidth = 10; // Value of AUTOSIZE_COL_MARGIN from wxWidgets source.
 wxString str;
 
 dc.SetFont( GetFont() );
 
 if( IsVirtual() )
 str = OnGetItemText( aLine, 0 );
 else
 str = GetItemText( aLine, 0 );
 str += wxS( " " );
 
 dc.GetTextExtent( str, &w, nullptr );
 newWidth += w;
 
 if( newWidth > columnWidth )
 {
 columnWidth = newWidth;
 SetColumnWidth( 0, columnWidth );
 }
}

References columnWidth.

Referenced by UpdateWidth().

◆ UpdateWidth()

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

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 49 of file listbox_base.cpp.

{
 wxClientDC dc( this );
 int itemCount = GetItemCount();
 
 // Less than zero: recalculate width of all items.
 if( aLine < 0 )
 {
 columnWidth = 0;
 for( int ii = 0; ii < itemCount; ii++ )
 {
 UpdateLineWidth( (unsigned)ii, dc );
 }
 }
 
 // Zero or above: update from a single line.
 else
 {
 if( aLine < itemCount )
 UpdateLineWidth( (unsigned)aLine, dc );
 }
}

References columnWidth, and UpdateLineWidth().

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

Member Data Documentation

◆ columnWidth

int ITEMS_LISTBOX_BASE::columnWidth

private

Definition at line 81 of file listboxes.h.

Referenced by UpdateLineWidth(), and UpdateWidth().

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

Public Member Functions

Private Member Functions

Private Attributes