KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_base_frame.h File Reference
#include <eda_draw_frame.h>
#include <frame_type.h>
#include <sch_draw_panel.h>
#include <sch_screen.h>
#include <schematic_settings.h>
#include <stddef.h>
#include <utility>
#include <vector>
#include <wx/event.h>
#include <wx/fswatcher.h>
#include <wx/datetime.h>
#include <wx/gdicmn.h>
#include <wx/string.h>
#include <wx/timer.h>
#include <template_fieldnames.h>

Go to the source code of this file.

Classes

class  SCH_BASE_FRAME
 A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME, SYMBOL_VIEWER_FRAME, and SCH_EDIT_FRAME, and it brings in a common way of handling the provided virtual functions for the derived classes. More...
 

Functions

LIB_SYMBOLSchGetLibSymbol (const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, SYMBOL_LIB *aCacheLib=nullptr, wxWindow *aParent=nullptr, bool aShowErrorMsg=false)
 Load symbol from symbol library table.
 

Function Documentation

◆ SchGetLibSymbol()

LIB_SYMBOL * SchGetLibSymbol ( const LIB_ID aLibId,
SYMBOL_LIB_TABLE aLibTable,
SYMBOL_LIB aCacheLib = nullptr,
wxWindow *  aParent = nullptr,
bool  aShowErrorMsg = false 
)

Load symbol from symbol library table.

Check the symbol library table for the part defined by aLibId and optionally check the optional cache library.

Parameters
aLibIdis the symbol library identifier to load.
aLibTableis the #SYMBOL_LIBRARY_TABLE to load the alias from.
aCacheLibis an optional cache library.
aParentis an optional parent window when displaying an error message.
aShowErrorMessageset to true to show any error messages.
Returns
The symbol found in the library or NULL if the symbol was not found.

Definition at line 55 of file sch_base_frame.cpp.

References _, DisplayErrorMessage(), SYMBOL_LIB::FindSymbol(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_LIB::IsCache(), SYMBOL_LIB_TABLE::LoadSymbol(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), SCH_BASE_FRAME::GetLibSymbol(), SCH_DRAWING_TOOLS::PlaceSymbol(), and ERC_TESTER::TestLibSymbolIssues().