KiCad PCB EDA Suite
Loading...
Searching...
No Matches
FP_TREE_MODEL_ADAPTER Class Reference

#include <fp_tree_model_adapter.h>

Inheritance diagram for FP_TREE_MODEL_ADAPTER:
LIB_TREE_MODEL_ADAPTER FP_TREE_SYNCHRONIZING_ADAPTER

Public Types

enum  TREE_COLS { NAME_COL = 0 , DESC_COL , NUM_COLS }
 This enum defines the order of the default columns in the tree view. More...
 
enum  SORT_MODE { BEST_MATCH = 0 , ALPHABETIC }
 

Public Member Functions

void AddLibraries (EDA_BASE_FRAME *aParent)
 
wxString GenerateInfo (LIB_ID const &aLibId, int aUnit) override
 
void SaveSettings ()
 Save the column widths to the config file.
 
void SetFilter (std::function< bool(LIB_TREE_NODE &aNode)> *aFilter)
 Set the symbol filter type.
 
std::function< bool(LIB_TREE_NODE &aNode)> * GetFilter () const
 Return the active filter.
 
void SetSortMode (SORT_MODE aMode)
 
SORT_MODE GetSortMode () const
 
void ShowUnits (bool aShow)
 Whether or not to show units.
 
void SetPreselectNode (const LIB_ID &aLibId, int aUnit)
 Set the symbol name to be selected if there are no search results.
 
void DoAddLibrary (const wxString &aNodeName, const wxString &aDesc, const std::vector< LIB_TREE_ITEM * > &aItemList, bool pinned, bool presorted)
 Add the given list of symbols by alias.
 
void DoRemoveLibrary (const wxString &aNodeName)
 Remove the library by name.
 
std::vector< wxString > GetAvailableColumns () const
 
std::vector< wxString > GetShownColumns () const
 
std::vector< wxString > GetOpenLibs () const
 
void OpenLibs (const std::vector< wxString > &aLibs)
 
void SetShownColumns (const std::vector< wxString > &aColumnNames)
 Sets which columns are shown in the widget.
 
void AssignIntrinsicRanks ()
 Sort the tree and assign ranks after adding libraries.
 
void UpdateSearchString (const wxString &aSearch, bool aState)
 Set the search string provided by the user.
 
void AttachTo (wxDataViewCtrl *aDataViewCtrl)
 Attach to a wxDataViewCtrl and initialize it.
 
void FinishTreeInitialization ()
 A final-stage initialization to be called after the window hierarchy has been realized and the window sizes set.
 
LIB_ID GetAliasFor (const wxDataViewItem &aSelection) const
 Return the alias for the given item.
 
int GetUnitFor (const wxDataViewItem &aSelection) const
 Return the unit for the given item.
 
LIB_TREE_NODE::TYPE GetTypeFor (const wxDataViewItem &aSelection) const
 Return node type for the given item.
 
LIB_TREE_NODEGetTreeNodeFor (const wxDataViewItem &aSelection) const
 
virtual bool HasPreview (const wxDataViewItem &aItem)
 
virtual void ShowPreview (wxWindow *aParent, const wxDataViewItem &aItem)
 
TOOL_DISPATCHERGetToolDispatcher () const
 
int GetItemCount () const
 Return the number of symbols loaded in the tree.
 
virtual int GetLibrariesCount () const
 Return the number of libraries loaded in the tree.
 
wxDataViewItem FindItem (const LIB_ID &aLibId)
 Returns tree item corresponding to part.
 
virtual wxDataViewItem GetCurrentDataViewItem ()
 
unsigned int GetChildren (const wxDataViewItem &aItem, wxDataViewItemArray &aChildren) const override
 Populate a list of all the children of an item.
 
void Freeze ()
 
void Thaw ()
 
bool IsFrozen () const
 
void RefreshTree ()
 
virtual TOOL_INTERACTIVEGetContextMenuTool ()
 
void PinLibrary (LIB_TREE_NODE *aTreeNode)
 
void UnpinLibrary (LIB_TREE_NODE *aTreeNode)
 
void ShowChangedLanguage ()
 

Static Public Member Functions

static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTERCreate (EDA_BASE_FRAME *aParent, LIB_TABLE *aLibs)
 Factory function: create a model adapter in a reference-counting container.
 
static const wxString GetPinningSymbol ()
 

Protected Member Functions

 FP_TREE_MODEL_ADAPTER (EDA_BASE_FRAME *aParent, LIB_TABLE *aLibs)
 Constructor; takes a set of libraries to be included in the search.
 
std::vector< LIB_TREE_ITEM * > getFootprints (const wxString &aLibName)
 
PROJECT::LIB_TYPE_T getLibType () override
 
LIB_TREE_NODE_LIBRARYDoAddLibraryNode (const wxString &aNodeName, const wxString &aDesc, bool pinned)
 
bool HasContainerColumns (const wxDataViewItem &aItem) const override
 Check whether a container has columns too.
 
bool IsContainer (const wxDataViewItem &aItem) const override
 Check whether an item can have children.
 
wxDataViewItem GetParent (const wxDataViewItem &aItem) const override
 Get the parent of an item.
 
unsigned int GetColumnCount () const override
 
wxString GetColumnType (unsigned int aCol) const override
 Return the type of data stored in the column as indicated by wxVariant::GetType()
 
void GetValue (wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) const override
 Get the value of an item.
 
bool SetValue (const wxVariant &aVariant, const wxDataViewItem &aItem, unsigned int aCol) override
 Set the value of an item.
 
bool GetAttr (const wxDataViewItem &aItem, unsigned int aCol, wxDataViewItemAttr &aAttr) const override
 Get any formatting for an item.
 
void resortTree ()
 
void addColumnIfNecessary (const wxString &aHeader)
 
void recreateColumns ()
 

Static Protected Member Functions

static wxDataViewItem ToItem (const LIB_TREE_NODE *aNode)
 Convert #SYM_TREE_NODE -> wxDataViewItem.
 
static LIB_TREE_NODEToNode (wxDataViewItem aItem)
 Convert wxDataViewItem -> #SYM_TREE_NODE.
 

Protected Attributes

FP_LIB_TABLEm_libs
 
LIB_TREE_NODE_ROOT m_tree
 
std::map< unsigned, wxString > m_colIdxMap
 
std::vector< wxString > m_availableColumns
 
wxDataViewCtrl * m_widget
 

Private Member Functions

const LIB_TREE_NODEShowResults ()
 Find and expand successful search results.
 
wxDataViewColumn * doAddColumn (const wxString &aHeader, bool aTranslate=true)
 

Private Attributes

EDA_BASE_FRAMEm_parent
 
SORT_MODE m_sort_mode
 
bool m_show_units
 
LIB_ID m_preselect_lib_id
 
int m_preselect_unit
 
int m_freeze
 
std::function< bool(LIB_TREE_NODE &aNode)> * m_filter
 
std::vector< wxDataViewColumn * > m_columns
 
std::map< wxString, wxDataViewColumn * > m_colNameMap
 
std::map< wxString, int > m_colWidths
 
std::vector< wxString > m_shownColumns
 

Detailed Description

Definition at line 31 of file fp_tree_model_adapter.h.

Member Enumeration Documentation

◆ SORT_MODE

Enumerator
BEST_MATCH 
ALPHABETIC 

Definition at line 131 of file lib_tree_model_adapter.h.

◆ TREE_COLS

This enum defines the order of the default columns in the tree view.

Enumerator
NAME_COL 

Library or library item name column.

DESC_COL 

Library or library description column.

NUM_COLS 

The number of default tree columns.

Definition at line 124 of file lib_tree_model_adapter.h.

Constructor & Destructor Documentation

◆ FP_TREE_MODEL_ADAPTER()

FP_TREE_MODEL_ADAPTER::FP_TREE_MODEL_ADAPTER ( EDA_BASE_FRAME aParent,
LIB_TABLE aLibs 
)
protected

Constructor; takes a set of libraries to be included in the search.

Definition at line 44 of file fp_tree_model_adapter.cpp.

Member Function Documentation

◆ addColumnIfNecessary()

void LIB_TREE_MODEL_ADAPTER::addColumnIfNecessary ( const wxString &  aHeader)
protectedinherited

◆ AddLibraries()

◆ AssignIntrinsicRanks()

void LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks ( )
inlineinherited

Sort the tree and assign ranks after adding libraries.

Definition at line 210 of file lib_tree_model_adapter.h.

References LIB_TREE_NODE::AssignIntrinsicRanks(), and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ AttachTo()

void LIB_TREE_MODEL_ADAPTER::AttachTo ( wxDataViewCtrl *  aDataViewCtrl)
inherited

Attach to a wxDataViewCtrl and initialize it.

This will set up columns and associate the model via the adapter.

Parameters
aDataViewCtrlthe view symbol in the dialog

Definition at line 350 of file lib_tree_model_adapter.cpp.

References kDataViewIndent, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_MODEL_ADAPTER::recreateColumns().

◆ Create()

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > FP_TREE_MODEL_ADAPTER::Create ( EDA_BASE_FRAME aParent,
LIB_TABLE aLibs 
)
static

Factory function: create a model adapter in a reference-counting container.

Parameters
aLibslibrary set from which parts will be loaded

Definition at line 37 of file fp_tree_model_adapter.cpp.

Referenced by PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER().

◆ doAddColumn()

wxDataViewColumn * LIB_TREE_MODEL_ADAPTER::doAddColumn ( const wxString &  aHeader,
bool  aTranslate = true 
)
privateinherited

◆ DoAddLibrary()

void LIB_TREE_MODEL_ADAPTER::DoAddLibrary ( const wxString &  aNodeName,
const wxString &  aDesc,
const std::vector< LIB_TREE_ITEM * > &  aItemList,
bool  pinned,
bool  presorted 
)
inherited

Add the given list of symbols by alias.

To be called in the setup phase.

Parameters
aNodeNamethe parent node the symbols will appear under
aDescthe description field of the parent node
aItemListlist of symbols

Definition at line 237 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE_LIBRARY::AddItem(), LIB_TREE_NODE::AssignIntrinsicRanks(), and LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ DoAddLibraryNode()

LIB_TREE_NODE_LIBRARY & LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode ( const wxString &  aNodeName,
const wxString &  aDesc,
bool  pinned 
)
protectedinherited

◆ DoRemoveLibrary()

void LIB_TREE_MODEL_ADAPTER::DoRemoveLibrary ( const wxString &  aNodeName)
inherited

Remove the library by name.

Parameters
aNodeNamethe name of the library to remove

Definition at line 250 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_tree, and LIB_TREE_NODE_ROOT::RemoveLib().

◆ FindItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::FindItem ( const LIB_ID aLibId)
inherited

Returns tree item corresponding to part.

Parameters
aLibIdspecifies the part and library name to be searched for.
Returns
Tree data item representing the part. Might be invalid if nothings was found.

Definition at line 498 of file lib_tree_model_adapter.cpp.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_TREE_NODE::m_Children, LIB_TREE_MODEL_ADAPTER::m_tree, LIB_TREE_MODEL_ADAPTER::ToItem(), and UTF8::wx_str().

Referenced by LIB_TREE_MODEL_ADAPTER::GetCurrentDataViewItem(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetCurrentDataViewItem(), FP_TREE_SYNCHRONIZING_ADAPTER::GetCurrentDataViewItem(), and LIB_TREE_MODEL_ADAPTER::OpenLibs().

◆ FinishTreeInitialization()

void LIB_TREE_MODEL_ADAPTER::FinishTreeInitialization ( )
inherited

A final-stage initialization to be called after the window hierarchy has been realized and the window sizes set.

Definition at line 552 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_colIdxMap, LIB_TREE_MODEL_ADAPTER::m_columns, LIB_TREE_MODEL_ADAPTER::m_colWidths, and LIB_TREE_MODEL_ADAPTER::m_widget.

◆ Freeze()

void LIB_TREE_MODEL_ADAPTER::Freeze ( )
inlineinherited

◆ GenerateInfo()

wxString FP_TREE_MODEL_ADAPTER::GenerateInfo ( LIB_ID const &  aLibId,
int  aUnit 
)
overridevirtual

Reimplemented from LIB_TREE_MODEL_ADAPTER.

Definition at line 101 of file fp_tree_model_adapter.cpp.

References GenerateFootprintInfo(), and m_libs.

◆ GetAliasFor()

LIB_ID LIB_TREE_MODEL_ADAPTER::GetAliasFor ( const wxDataViewItem &  aSelection) const
inherited

Return the alias for the given item.

Parameters
aSelectionitem from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())
Returns
alias, or nullptr if none is selected

Definition at line 460 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_LibId, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetAttr()

bool LIB_TREE_MODEL_ADAPTER::GetAttr ( const wxDataViewItem &  aItem,
unsigned int  aCol,
wxDataViewItemAttr &  aAttr 
) const
overrideprotectedinherited

Get any formatting for an item.

Parameters
aItemitem to get formatting for
aColcolumn number of interest
aAttrreceiver for attributes
Returns
true if the item has non-default attributes

Definition at line 700 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::IsFrozen(), LIB_TREE_NODE::m_IsRoot, LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetAvailableColumns()

std::vector< wxString > LIB_TREE_MODEL_ADAPTER::GetAvailableColumns ( ) const
inlineinherited

◆ GetChildren()

unsigned int LIB_TREE_MODEL_ADAPTER::GetChildren ( const wxDataViewItem &  aItem,
wxDataViewItemArray &  aChildren 
) const
overrideinherited

◆ GetColumnCount()

unsigned int LIB_TREE_MODEL_ADAPTER::GetColumnCount ( ) const
inlineoverrideprotectedinherited

Definition at line 364 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_columns.

◆ GetColumnType()

wxString LIB_TREE_MODEL_ADAPTER::GetColumnType ( unsigned int  aCol) const
inlineoverrideprotectedinherited

Return the type of data stored in the column as indicated by wxVariant::GetType()

Definition at line 369 of file lib_tree_model_adapter.h.

◆ GetContextMenuTool()

virtual TOOL_INTERACTIVE * LIB_TREE_MODEL_ADAPTER::GetContextMenuTool ( )
inlinevirtualinherited

◆ GetCurrentDataViewItem()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::GetCurrentDataViewItem ( )
virtualinherited

◆ GetFilter()

std::function< bool(LIB_TREE_NODE &aNode)> * LIB_TREE_MODEL_ADAPTER::GetFilter ( ) const
inlineinherited

◆ getFootprints()

std::vector< LIB_TREE_ITEM * > FP_TREE_MODEL_ADAPTER::getFootprints ( const wxString &  aLibName)
protected

◆ GetItemCount()

int LIB_TREE_MODEL_ADAPTER::GetItemCount ( ) const
inherited

Return the number of symbols loaded in the tree.

Definition at line 487 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::m_tree.

◆ GetLibrariesCount()

virtual int LIB_TREE_MODEL_ADAPTER::GetLibrariesCount ( ) const
inlinevirtualinherited

Return the number of libraries loaded in the tree.

Reimplemented in SYMBOL_TREE_SYNCHRONIZING_ADAPTER, and FP_TREE_SYNCHRONIZING_ADAPTER.

Definition at line 282 of file lib_tree_model_adapter.h.

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::m_tree.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount().

◆ getLibType()

PROJECT::LIB_TYPE_T FP_TREE_MODEL_ADAPTER::getLibType ( )
inlineoverrideprotectedvirtual

Implements LIB_TREE_MODEL_ADAPTER.

Definition at line 54 of file fp_tree_model_adapter.h.

References PROJECT::FOOTPRINT_LIB.

◆ GetOpenLibs()

std::vector< wxString > LIB_TREE_MODEL_ADAPTER::GetOpenLibs ( ) const
inherited

◆ GetParent()

wxDataViewItem LIB_TREE_MODEL_ADAPTER::GetParent ( const wxDataViewItem &  aItem) const
overrideprotectedinherited

Get the parent of an item.

Returns
parent of aItem, or an invalid wxDataViewItem if parent is root

Definition at line 637 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_freeze, LIB_TREE_NODE::m_Parent, LIB_TREE_NODE::m_Type, LIB_TREE_MODEL_ADAPTER::ToItem(), and LIB_TREE_MODEL_ADAPTER::ToNode().

Referenced by LIB_TREE_MODEL_ADAPTER::UpdateSearchString().

◆ GetPinningSymbol()

◆ GetShownColumns()

std::vector< wxString > LIB_TREE_MODEL_ADAPTER::GetShownColumns ( ) const
inlineinherited

◆ GetSortMode()

SORT_MODE LIB_TREE_MODEL_ADAPTER::GetSortMode ( ) const
inlineinherited

Definition at line 156 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_sort_mode.

◆ GetToolDispatcher()

TOOL_DISPATCHER * LIB_TREE_MODEL_ADAPTER::GetToolDispatcher ( ) const
inlineinherited

◆ GetTreeNodeFor()

LIB_TREE_NODE * LIB_TREE_MODEL_ADAPTER::GetTreeNodeFor ( const wxDataViewItem &  aSelection) const
inherited

Definition at line 481 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetTypeFor()

LIB_TREE_NODE::TYPE LIB_TREE_MODEL_ADAPTER::GetTypeFor ( const wxDataViewItem &  aSelection) const
inherited

Return node type for the given item.

Parameters
aSelectionitem from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())
Returns
Type of the selected node, might be INVALID.

Definition at line 474 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Type, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetUnitFor()

int LIB_TREE_MODEL_ADAPTER::GetUnitFor ( const wxDataViewItem &  aSelection) const
inherited

Return the unit for the given item.

Parameters
aSelectionitem from the wxDataViewCtrl (see wxDataViewCtrl::GetSelection())
Returns
Unit, or zero if the alias itself is selected. Return valid is invalid if GetAliasFor() returns nullptr.

Definition at line 467 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Unit, and LIB_TREE_MODEL_ADAPTER::ToNode().

◆ GetValue()

void LIB_TREE_MODEL_ADAPTER::GetValue ( wxVariant &  aVariant,
const wxDataViewItem &  aItem,
unsigned int  aCol 
) const
overrideprotectedinherited

Get the value of an item.

Parameters
aVariantwxVariant to receive the data
aItemitem whose data will be placed into aVariant
aColcolumn number of the data

Definition at line 654 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::GetPinningSymbol(), LIB_TREE_MODEL_ADAPTER::IsFrozen(), LIB_TREE_MODEL_ADAPTER::m_colIdxMap, LIB_TREE_NODE::m_Desc, LIB_TREE_NODE::m_Fields, LIB_TREE_NODE::m_Name, LIB_TREE_NODE::m_Pinned, LIB_TREE_MODEL_ADAPTER::NAME_COL, LIB_TREE_MODEL_ADAPTER::ToNode(), and UnescapeString().

◆ HasContainerColumns()

bool LIB_TREE_MODEL_ADAPTER::HasContainerColumns ( const wxDataViewItem &  aItem) const
overrideprotectedinherited

Check whether a container has columns too.

Definition at line 624 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::IsContainer().

◆ HasPreview()

virtual bool LIB_TREE_MODEL_ADAPTER::HasPreview ( const wxDataViewItem &  aItem)
inlinevirtualinherited

◆ IsContainer()

bool LIB_TREE_MODEL_ADAPTER::IsContainer ( const wxDataViewItem &  aItem) const
overrideprotectedinherited

Check whether an item can have children.

Definition at line 630 of file lib_tree_model_adapter.cpp.

References LIB_TREE_NODE::m_Children, and LIB_TREE_MODEL_ADAPTER::ToNode().

Referenced by LIB_TREE_MODEL_ADAPTER::HasContainerColumns().

◆ IsFrozen()

◆ OpenLibs()

void LIB_TREE_MODEL_ADAPTER::OpenLibs ( const std::vector< wxString > &  aLibs)
inherited

◆ PinLibrary()

◆ recreateColumns()

◆ RefreshTree()

void LIB_TREE_MODEL_ADAPTER::RefreshTree ( )
inherited

◆ resortTree()

◆ SaveSettings()

◆ SetFilter()

void LIB_TREE_MODEL_ADAPTER::SetFilter ( std::function< bool(LIB_TREE_NODE &aNode)> *  aFilter)
inlineinherited

Set the symbol filter type.

Must be set before adding libraries

Parameters
aFilterif SYM_FILTER_POWER, only power parts are loaded

Definition at line 148 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_filter.

Referenced by PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), and PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER().

◆ SetPreselectNode()

void LIB_TREE_MODEL_ADAPTER::SetPreselectNode ( const LIB_ID aLibId,
int  aUnit 
)
inherited

Set the symbol name to be selected if there are no search results.

May be set at any time; updates at the next UpdateSearchString().

Parameters
aLibIdsymbol LIB_ID to be selected
aUnitunit to be selected, if > 0 (0 selects the alias itself)

Definition at line 218 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_preselect_lib_id, and LIB_TREE_MODEL_ADAPTER::m_preselect_unit.

Referenced by PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), and PANEL_DESIGN_BLOCK_CHOOSER::RefreshLibs().

◆ SetShownColumns()

void LIB_TREE_MODEL_ADAPTER::SetShownColumns ( const std::vector< wxString > &  aColumnNames)
inherited

Sets which columns are shown in the widget.

Invalid column names are discarded.

Parameters
aColumnNamesis an ordered list of column names to show

Definition at line 449 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_shownColumns, LIB_TREE_MODEL_ADAPTER::m_widget, and LIB_TREE_MODEL_ADAPTER::recreateColumns().

◆ SetSortMode()

void LIB_TREE_MODEL_ADAPTER::SetSortMode ( SORT_MODE  aMode)
inlineinherited

Definition at line 155 of file lib_tree_model_adapter.h.

References LIB_TREE_MODEL_ADAPTER::m_sort_mode.

◆ SetValue()

bool LIB_TREE_MODEL_ADAPTER::SetValue ( const wxVariant &  aVariant,
const wxDataViewItem &  aItem,
unsigned int  aCol 
)
inlineoverrideprotectedinherited

Set the value of an item.

Does nothing - this model doesn't support editing.

Definition at line 386 of file lib_tree_model_adapter.h.

◆ ShowChangedLanguage()

void LIB_TREE_MODEL_ADAPTER::ShowChangedLanguage ( )
inlineinherited

◆ ShowPreview()

virtual void LIB_TREE_MODEL_ADAPTER::ShowPreview ( wxWindow *  aParent,
const wxDataViewItem &  aItem 
)
inlinevirtualinherited

◆ ShowResults()

◆ ShowUnits()

void LIB_TREE_MODEL_ADAPTER::ShowUnits ( bool  aShow)
inherited

Whether or not to show units.

May be set at any time; updates at the next UpdateSearchString()

Parameters
aShowif true, units are displayed

Definition at line 212 of file lib_tree_model_adapter.cpp.

References LIB_TREE_MODEL_ADAPTER::m_show_units.

◆ Thaw()

void LIB_TREE_MODEL_ADAPTER::Thaw ( )
inlineinherited

◆ ToItem()

◆ ToNode()

◆ UnpinLibrary()

◆ UpdateSearchString()

void LIB_TREE_MODEL_ADAPTER::UpdateSearchString ( const wxString &  aSearch,
bool  aState 
)
inherited

Member Data Documentation

◆ m_availableColumns

◆ m_colIdxMap

◆ m_colNameMap

std::map<wxString, wxDataViewColumn*> LIB_TREE_MODEL_ADAPTER::m_colNameMap
privateinherited

◆ m_columns

◆ m_colWidths

std::map<wxString, int> LIB_TREE_MODEL_ADAPTER::m_colWidths
privateinherited

◆ m_filter

std::function<bool( LIB_TREE_NODE& aNode )>* LIB_TREE_MODEL_ADAPTER::m_filter
privateinherited

◆ m_freeze

int LIB_TREE_MODEL_ADAPTER::m_freeze
privateinherited

◆ m_libs

FP_LIB_TABLE* FP_TREE_MODEL_ADAPTER::m_libs
protected

◆ m_parent

EDA_BASE_FRAME* LIB_TREE_MODEL_ADAPTER::m_parent
privateinherited

◆ m_preselect_lib_id

LIB_ID LIB_TREE_MODEL_ADAPTER::m_preselect_lib_id
privateinherited

◆ m_preselect_unit

int LIB_TREE_MODEL_ADAPTER::m_preselect_unit
privateinherited

◆ m_show_units

bool LIB_TREE_MODEL_ADAPTER::m_show_units
privateinherited

◆ m_shownColumns

std::vector<wxString> LIB_TREE_MODEL_ADAPTER::m_shownColumns
privateinherited

◆ m_sort_mode

◆ m_tree

◆ m_widget


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