SCHLIB_FILTER Class Reference

#include <symbol_library.h>

Public Member Functions
	SCHLIB_FILTER ()
void	AddLib (const wxString &aLibName)
	add a lib name to the allowed libraries More...
void	LoadFrom (const wxString &aLibName)
	add a lib name to the allowed libraries More...
void	ClearLibList ()
	Clear the allowed libraries list (allows all libs) More...
void	FilterPowerSymbols (bool aFilterEnable)
	Set the filtering of power symbols. More...
bool	GetFilterPowerSymbols () const
const wxArrayString &	GetAllowedLibList () const
const wxString &	GetLibSource () const

Private Attributes
wxArrayString	m_allowedLibs
	a list of lib names to list some libraries if empty: no filter More...
bool	m_filterPowerSymbols
	true to filter (show only) power symbols More...
bool	m_forceLoad

Detailed Description

Definition at line 86 of file symbol_library.h.

Constructor & Destructor Documentation

SCHLIB_FILTER()

SCHLIB_FILTER::SCHLIB_FILTER ( )

inline

Definition at line 89 of file symbol_library.h.

 {
 m_filterPowerSymbols = false;
 m_forceLoad = false;
 }

References m_filterPowerSymbols, and m_forceLoad.

Member Function Documentation

AddLib()

void SCHLIB_FILTER::AddLib ( const wxString &  aLibName )

inline

add a lib name to the allowed libraries

Definition at line 98 of file symbol_library.h.

 {
 m_allowedLibs.Add( aLibName );
 m_forceLoad = false;
 }

References m_allowedLibs, and m_forceLoad.

ClearLibList()

void SCHLIB_FILTER::ClearLibList ( )

inline

Clear the allowed libraries list (allows all libs)

Definition at line 118 of file symbol_library.h.

 {
 m_allowedLibs.Clear();
 m_forceLoad = false;
 }

References m_allowedLibs, and m_forceLoad.

FilterPowerSymbols()

void SCHLIB_FILTER::FilterPowerSymbols ( bool  aFilterEnable )

inline

Set the filtering of power symbols.

Definition at line 127 of file symbol_library.h.

 {
 m_filterPowerSymbols = aFilterEnable;
 }

References m_filterPowerSymbols.

GetAllowedLibList()

const wxArrayString& SCHLIB_FILTER::GetAllowedLibList ( ) const

inline

Returns

am wxArrayString of the names of allowed libs

Definition at line 143 of file symbol_library.h.

{ return m_allowedLibs; }

References m_allowedLibs.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree(), and SYMBOL_VIEWER_FRAME::SetFilter().

GetFilterPowerSymbols()

bool SCHLIB_FILTER::GetFilterPowerSymbols ( ) const

inline

Returns

true if the filtering of power symbols is on

Definition at line 137 of file symbol_library.h.

{ return m_filterPowerSymbols; }

References m_filterPowerSymbols.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree(), and SYMBOL_VIEWER_FRAME::SetFilter().

GetLibSource()

const wxString& SCHLIB_FILTER::GetLibSource ( ) const

inline

Returns

the name of the lib to use to load a symbol, or an a empty string Useful to load (in lib editor or lib viewer) a symbol from a given library

Definition at line 149 of file symbol_library.h.

 {
 static wxString dummy;

 if( m_forceLoad && m_allowedLibs.GetCount() > 0 )
 return m_allowedLibs[0];
 else
 return dummy;
 }

References dummy(), m_allowedLibs, and m_forceLoad.

LoadFrom()

void SCHLIB_FILTER::LoadFrom ( const wxString &  aLibName )

inline

add a lib name to the allowed libraries

Definition at line 108 of file symbol_library.h.

 {
 m_allowedLibs.Clear();
 m_allowedLibs.Add( aLibName );
 m_forceLoad = true;
 }

References m_allowedLibs, and m_forceLoad.

Member Data Documentation

m_allowedLibs

wxArrayString SCHLIB_FILTER::m_allowedLibs

private

a list of lib names to list some libraries if empty: no filter

Definition at line 160 of file symbol_library.h.

Referenced by AddLib(), ClearLibList(), GetAllowedLibList(), GetLibSource(), and LoadFrom().

m_filterPowerSymbols

bool SCHLIB_FILTER::m_filterPowerSymbols

private

true to filter (show only) power symbols

Definition at line 162 of file symbol_library.h.

Referenced by FilterPowerSymbols(), GetFilterPowerSymbols(), and SCHLIB_FILTER().

m_forceLoad

bool SCHLIB_FILTER::m_forceLoad

private

Definition at line 163 of file symbol_library.h.

Referenced by AddLib(), ClearLibList(), GetLibSource(), LoadFrom(), and SCHLIB_FILTER().

---

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

• symbol_library.h