KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Private Attributes | Friends | List of all members
LIBRARY_TABLE_ROW Class Reference

#include <library_table.h>

Public Member Functions

 LIBRARY_TABLE_ROW ()=default
 
bool operator== (const LIBRARY_TABLE_ROW &aOther) const
 
void SetNickname (const wxString &aNickname)
 
const wxString & Nickname () const
 
void SetURI (const wxString &aUri)
 
const wxString & URI () const
 
void SetType (const wxString &aType)
 
const wxString & Type () const
 
void SetOptions (const wxString &aOptions)
 
const wxString & Options () const
 
void SetDescription (const wxString &aDescription)
 
const wxString & Description () const
 
void SetScope (LIBRARY_TABLE_SCOPE aScope)
 
LIBRARY_TABLE_SCOPE Scope () const
 
void SetDisabled (bool aDisabled=true)
 
bool Disabled () const
 
void SetHidden (bool aHidden=true)
 
bool Hidden () const
 
std::map< std::string, UTF8 > GetOptionsMap () const
 
void SetOk (bool aOk=true)
 
bool IsOk () const
 
void SetErrorDescription (const wxString &aDescription)
 
const wxString & ErrorDescription () const
 

Static Public Attributes

static const wxString TABLE_TYPE_NAME = wxT( "Table" )
 

Private Attributes

wxString m_nickname
 
wxString m_uri
 
wxString m_type
 
wxString m_options
 
wxString m_description
 
bool m_disabled = false
 
bool m_hidden = false
 
bool m_ok = false
 
wxString m_errorDescription
 
LIBRARY_TABLE_SCOPE m_scope = LIBRARY_TABLE_SCOPE::UNINITIALIZED
 

Friends

class LIBRARY_TABLE
 

Detailed Description

Definition at line 55 of file library_table.h.

Constructor & Destructor Documentation

◆ LIBRARY_TABLE_ROW()

LIBRARY_TABLE_ROW::LIBRARY_TABLE_ROW ( )
default

References LIBRARY_TABLE_ROW().

Referenced by LIBRARY_TABLE_ROW(), and operator==().

Member Function Documentation

◆ Description()

const wxString & LIBRARY_TABLE_ROW::Description ( ) const
inline

Definition at line 79 of file library_table.h.

References m_description.

Referenced by LIB_TABLE_GRID::GetValue(), and SCH_EDIT_FRAME::LoadSheetFromFile().

◆ Disabled()

bool LIBRARY_TABLE_ROW::Disabled ( ) const
inline

Definition at line 85 of file library_table.h.

References m_disabled.

Referenced by LIB_TABLE_GRID::GetValue(), and LIB_TABLE_GRID::GetValueAsBool().

◆ ErrorDescription()

const wxString & LIBRARY_TABLE_ROW::ErrorDescription ( ) const
inline

Definition at line 96 of file library_table.h.

References m_errorDescription.

Referenced by LIB_TABLE_GRID::GetValue(), and SYMBOL_GRID_TRICKS::onGridCellLeftClick().

◆ GetOptionsMap()

std::map< std::string, UTF8 > LIBRARY_TABLE_ROW::GetOptionsMap ( ) const

Definition at line 49 of file library_table.cpp.

References m_options, LIB_TABLE::ParseOptions(), and TO_UTF8.

Referenced by SYMBOL_LIBRARY_ADAPTER::CreateLibrary(), DESIGN_BLOCK_LIBRARY_ADAPTER::DeleteDesignBlock(), LIBRARY_MANAGER_ADAPTER::DeleteLibrary(), DESIGN_BLOCK_LIBRARY_ADAPTER::DesignBlockExists(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetDesignBlockNames(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetDesignBlocks(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetEnumeratedDesignBlock(), SYMBOL_LIBRARY_ADAPTER::GetSymbolNames(), SYMBOL_LIBRARY_ADAPTER::GetSymbols(), DESIGN_BLOCK_LIBRARY_ADAPTER::LoadDesignBlock(), SYMBOL_LIBRARY_ADAPTER::LoadOne(), and DESIGN_BLOCK_LIBRARY_ADAPTER::SaveDesignBlock().

◆ Hidden()

bool LIBRARY_TABLE_ROW::Hidden ( ) const
inline

Definition at line 88 of file library_table.h.

References m_hidden.

Referenced by LIB_TABLE_GRID::GetValue(), LIB_TABLE_GRID::GetValueAsBool(), and SYMBOL_VIEWER_FRAME::ReCreateLibList().

◆ IsOk()

bool LIBRARY_TABLE_ROW::IsOk ( ) const
inline

Definition at line 93 of file library_table.h.

References m_ok.

Referenced by SYMBOL_GRID_TRICKS::onGridCellLeftClick(), and PANEL_SYM_LIB_TABLE::setupGrid().

◆ Nickname()

const wxString & LIBRARY_TABLE_ROW::Nickname ( ) const
inline

Definition at line 67 of file library_table.h.

References m_nickname.

Referenced by LIB_TABLE_GRID::ContainsNickname(), SYMBOL_LIBRARY_ADAPTER::createPlugin(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), DESIGN_BLOCK_LIBRARY_ADAPTER::GetDesignBlocks(), SYMBOL_LIBRARY_ADAPTER::GetSymbols(), LIB_TABLE_GRID::GetValue(), LIBRARY_MANAGER_ADAPTER::loadIfNeeded(), SYMBOL_GRID_TRICKS::onGridCellLeftClick(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), and SYMBOL_GRID_TRICKS::optionsEditor().

◆ operator==()

bool LIBRARY_TABLE_ROW::operator== ( const LIBRARY_TABLE_ROW & aOther) const

Definition at line 36 of file library_table.cpp.

References LIBRARY_TABLE_ROW(), m_description, m_disabled, m_hidden, m_nickname, m_options, m_scope, m_type, and m_uri.

◆ Options()

const wxString & LIBRARY_TABLE_ROW::Options ( ) const
inline

Definition at line 76 of file library_table.h.

References m_options.

Referenced by LIB_TABLE_GRID::GetValue(), SCH_EDIT_FRAME::LoadSheetFromFile(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), and SYMBOL_GRID_TRICKS::optionsEditor().

◆ Scope()

LIBRARY_TABLE_SCOPE LIBRARY_TABLE_ROW::Scope ( ) const
inline

Definition at line 82 of file library_table.h.

References m_scope.

Referenced by SYMBOL_LIBRARY_ADAPTER::createPlugin(), and SCH_EDITOR_CONTROL::ExportSymbolsToLibrary().

◆ SetDescription()

void LIBRARY_TABLE_ROW::SetDescription ( const wxString & aDescription)
inline

Definition at line 78 of file library_table.h.

References m_description.

Referenced by DESIGN_BLOCK_PANE::AddDesignBlockLibrary(), PCM_LIB_TRAVERSER::addRowIfNecessary(), LIBRARY_MANAGER::CreateGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), and LIB_TABLE_GRID::SetValue().

◆ SetDisabled()

void LIBRARY_TABLE_ROW::SetDisabled ( bool aDisabled = true)
inline

Definition at line 84 of file library_table.h.

References m_disabled.

Referenced by LIB_TABLE_GRID::SetValue(), and LIB_TABLE_GRID::SetValueAsBool().

◆ SetErrorDescription()

void LIBRARY_TABLE_ROW::SetErrorDescription ( const wxString & aDescription)
inline

Definition at line 95 of file library_table.h.

References m_errorDescription.

◆ SetHidden()

void LIBRARY_TABLE_ROW::SetHidden ( bool aHidden = true)
inline

Definition at line 87 of file library_table.h.

References m_hidden.

Referenced by LIB_TABLE_GRID::SetValue(), and LIB_TABLE_GRID::SetValueAsBool().

◆ SetNickname()

void LIBRARY_TABLE_ROW::SetNickname ( const wxString & aNickname)
inline

Definition at line 66 of file library_table.h.

References m_nickname.

Referenced by DESIGN_BLOCK_PANE::AddDesignBlockLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PCM_LIB_TRAVERSER::addRowIfNecessary(), LIBRARY_MANAGER::CreateGlobalTable(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::KiwayMailIn(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), LIB_TABLE_GRID::SetValue(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ SetOk()

void LIBRARY_TABLE_ROW::SetOk ( bool aOk = true)
inline

Definition at line 92 of file library_table.h.

References m_ok.

Referenced by LIBRARY_TABLE::MakeRow().

◆ SetOptions()

void LIBRARY_TABLE_ROW::SetOptions ( const wxString & aOptions)
inline

Definition at line 75 of file library_table.h.

References m_options.

Referenced by SCH_EDIT_FRAME::LoadSheetFromFile(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), SYMBOL_GRID_TRICKS::optionsEditor(), and LIB_TABLE_GRID::SetValue().

◆ SetScope()

void LIBRARY_TABLE_ROW::SetScope ( LIBRARY_TABLE_SCOPE aScope)
inline

Definition at line 81 of file library_table.h.

References m_scope.

Referenced by LIBRARY_TABLE::MakeRow().

◆ SetType()

void LIBRARY_TABLE_ROW::SetType ( const wxString & aType)
inline

Definition at line 72 of file library_table.h.

References m_type.

Referenced by DESIGN_BLOCK_PANE::AddDesignBlockLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PCM_LIB_TRAVERSER::addRowIfNecessary(), LIBRARY_MANAGER::CreateGlobalTable(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::KiwayMailIn(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), LIB_TABLE_GRID::SetValue(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ SetURI()

void LIBRARY_TABLE_ROW::SetURI ( const wxString & aUri)
inline

Definition at line 69 of file library_table.h.

References m_uri.

Referenced by DESIGN_BLOCK_PANE::AddDesignBlockLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PCM_LIB_TRAVERSER::addRowIfNecessary(), LIBRARY_MANAGER::CreateGlobalTable(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::KiwayMailIn(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), LIB_TABLE_GRID::SetValue(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ Type()

const wxString & LIBRARY_TABLE_ROW::Type ( ) const
inline

Definition at line 73 of file library_table.h.

References m_type.

Referenced by DESIGN_BLOCK_LIBRARY_ADAPTER::createPlugin(), SYMBOL_LIBRARY_ADAPTER::createPlugin(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), LIB_TABLE_GRID::GetValue(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_GRID_TRICKS::onGridCellLeftClick(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), and SYMBOL_GRID_TRICKS::optionsEditor().

◆ URI()

const wxString & LIBRARY_TABLE_ROW::URI ( ) const
inline

Definition at line 70 of file library_table.h.

References m_uri.

Referenced by LIBRARY_MANAGER::GetFullURI(), LIBRARY_MANAGER_ADAPTER::getUri(), LIB_TABLE_GRID::GetValue(), DESIGN_BLOCK_LIB_TABLE_GRID::SetValue(), FP_LIB_TABLE_GRID::SetValue(), and SYMBOL_LIB_TABLE_GRID::SetValue().

Friends And Related Symbol Documentation

◆ LIBRARY_TABLE

friend class LIBRARY_TABLE
friend

Definition at line 58 of file library_table.h.

References LIBRARY_TABLE.

Referenced by LIBRARY_TABLE.

Member Data Documentation

◆ m_description

wxString LIBRARY_TABLE_ROW::m_description
private

Definition at line 103 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), Description(), operator==(), and SetDescription().

◆ m_disabled

bool LIBRARY_TABLE_ROW::m_disabled = false
private

Definition at line 104 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), Disabled(), operator==(), and SetDisabled().

◆ m_errorDescription

wxString LIBRARY_TABLE_ROW::m_errorDescription
private

Definition at line 108 of file library_table.h.

Referenced by ErrorDescription(), and SetErrorDescription().

◆ m_hidden

bool LIBRARY_TABLE_ROW::m_hidden = false
private

Definition at line 105 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), Hidden(), operator==(), and SetHidden().

◆ m_nickname

wxString LIBRARY_TABLE_ROW::m_nickname
private

Definition at line 99 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), Nickname(), operator==(), and SetNickname().

◆ m_ok

bool LIBRARY_TABLE_ROW::m_ok = false
private

Definition at line 107 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), IsOk(), and SetOk().

◆ m_options

wxString LIBRARY_TABLE_ROW::m_options
private

Definition at line 102 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), GetOptionsMap(), operator==(), Options(), and SetOptions().

◆ m_scope

LIBRARY_TABLE_SCOPE LIBRARY_TABLE_ROW::m_scope = LIBRARY_TABLE_SCOPE::UNINITIALIZED
private

Definition at line 109 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), operator==(), Scope(), and SetScope().

◆ m_type

wxString LIBRARY_TABLE_ROW::m_type
private

Definition at line 101 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), operator==(), SetType(), and Type().

◆ m_uri

wxString LIBRARY_TABLE_ROW::m_uri
private

Definition at line 100 of file library_table.h.

Referenced by LIBRARY_TABLE::addRowFromIR(), operator==(), SetURI(), and URI().

◆ TABLE_TYPE_NAME

const wxString LIBRARY_TABLE_ROW::TABLE_TYPE_NAME = wxT( "Table" )
static

Definition at line 60 of file library_table.h.

Referenced by LIBRARY_MANAGER::CreateGlobalTable(), LIBRARY_MANAGER::loadNestedTables(), LIBRARY_MANAGER::Rows(), and PANEL_SYM_LIB_TABLE::setupGrid().

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