KiCad PCB EDA Suite: SYMBOL_DIFF_WIDGET Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

#include <symbol_diff_widget.h>

Inheritance diagram for SYMBOL_DIFF_WIDGET:

Public Member Functions
	SYMBOL_DIFF_WIDGET (wxWindow *aParent, EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
	Construct a symbol diff widget, consisting on a canvas for displaying a schematic and a library symbol, and a slider for fading between the two.

	~SYMBOL_DIFF_WIDGET () override

void	DisplayDiff (LIB_SYMBOL aSchSymbol, LIB_SYMBOL aLibSymbol, int aUnit, int aBodyStyle)
	Set the currently displayed symbol.

void	ToggleAB ()
	Toggle between full-A and full-B display.

void	SetStatusText (const wxString &aText)
	Set the contents of the status label and display it.

void	DisplaySymbol (const LIB_ID &aSymbolID, int aUnit, int aBodyStyle=0)
	Set the currently displayed symbol.

void	DisplayPart (LIB_SYMBOL *aSymbol, int aUnit, int aBodyStyle=0)

EDA_DRAW_PANEL_GAL *	GetCanvas () const

SCH_RENDER_SETTINGS *	GetRenderSettings ()

Protected Member Functions
void	onSize (wxSizeEvent &aEvent)

void	fitOnDrawArea ()

Protected Attributes
KIWAY *	m_kiway

GAL_DISPLAY_OPTIONS_IMPL	m_galDisplayOptions

EDA_DRAW_PANEL_GAL *	m_preview

wxStaticText *	m_status

wxPanel *	m_statusPanel

wxSizer *	m_statusSizer

wxSizer *	m_outerSizer

LIB_SYMBOL *	m_previewItem
	A local copy of the LIB_SYMBOL to display on the canvas.

SCH_RENDER_SETTINGS *	m_renderSettings

BOX2I	m_itemBBox
	The bounding box of the current item.

Private Member Functions
void	onSlider (wxScrollEvent &aEvent)

void	onCharHook (wxKeyEvent &aEvent)

Private Attributes
LIB_SYMBOL *	m_libraryItem

wxSlider *	m_slider

wxBitmapButton *	m_toggleButton

Detailed Description

Definition at line 31 of file symbol_diff_widget.h.

Constructor & Destructor Documentation

◆ SYMBOL_DIFF_WIDGET()

SYMBOL_DIFF_WIDGET::SYMBOL_DIFF_WIDGET	(	wxWindow *	aParent,
		EDA_DRAW_PANEL_GAL::GAL_TYPE	aCanvasType )

Construct a symbol diff widget, consisting on a canvas for displaying a schematic and a library symbol, and a slider for fading between the two.

Parameters

aParent	- parent window
aCanvasType	= the type of canvas (GAL_TYPE_OPENGL or GAL_TYPE_CAIRO only)

Definition at line 36 of file symbol_diff_widget.cpp.

References _, AddHotkeyName(), IS_COMMENT, KiBitmapBundle(), m_libraryItem, SYMBOL_PREVIEW_WIDGET::m_outerSizer, m_slider, m_toggleButton, onCharHook(), onSlider(), swap, SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), and ToggleAB().

◆ ~SYMBOL_DIFF_WIDGET()

SYMBOL_DIFF_WIDGET::~SYMBOL_DIFF_WIDGET ( )

override

Definition at line 83 of file symbol_diff_widget.cpp.

References m_libraryItem.

Member Function Documentation

◆ DisplayDiff()

void SYMBOL_DIFF_WIDGET::DisplayDiff	(	LIB_SYMBOL *	aSchSymbol,
		LIB_SYMBOL *	aLibSymbol,
		int	aUnit,
		int	aBodyStyle )

Set the currently displayed symbol.

Definition at line 89 of file symbol_diff_widget.cpp.

References KIGFX::VIEW::Add(), dummy, SYMBOL_PREVIEW_WIDGET::fitOnDrawArea(), KIGFX::VIEW::GetPainter(), SYMBOL_PREVIEW_WIDGET::m_itemBBox, m_libraryItem, SYMBOL_PREVIEW_WIDGET::m_preview, SYMBOL_PREVIEW_WIDGET::m_previewItem, SCH_RENDER_SETTINGS::m_ShowUnit, onSlider(), and KIGFX::VIEW::Remove().

Referenced by SCH_INSPECTION_TOOL::DiffSymbol().

◆ DisplayPart()

void SYMBOL_PREVIEW_WIDGET::DisplayPart	(	LIB_SYMBOL *	aSymbol,
		int	aUnit,
		int	aBodyStyle = 0 )

inherited

Definition at line 259 of file symbol_preview_widget.cpp.

References KIGFX::VIEW::Add(), AUTOPLACE_AUTO, fitOnDrawArea(), GetAppSettings(), m_itemBBox, m_preview, m_previewItem, m_renderSettings, m_statusPanel, and KIGFX::VIEW::Remove().

◆ DisplaySymbol()

void SYMBOL_PREVIEW_WIDGET::DisplaySymbol	(	const LIB_ID &	aSymbolID,
		int	aUnit,
		int	aBodyStyle = 0 )

inherited

Set the currently displayed symbol.

Definition at line 188 of file symbol_preview_widget.cpp.

References _, KIGFX::VIEW::Add(), AUTOPLACE_AUTO, fitOnDrawArea(), LIB_SYMBOL::Flatten(), GetAppSettings(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), SYMBOL_LIBRARY_ADAPTER::LoadSymbol(), m_itemBBox, m_kiway, m_preview, m_previewItem, m_renderSettings, m_statusPanel, KIGFX::VIEW::Remove(), PROJECT_SCH::SymbolLibAdapter(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::ShowPreview().

◆ fitOnDrawArea()

void SYMBOL_PREVIEW_WIDGET::fitOnDrawArea ( )

protectedinherited

Definition at line 164 of file symbol_preview_widget.cpp.

References m_itemBBox, m_preview, m_previewItem, scale, KIGFX::VIEW::SetCenter(), KIGFX::VIEW::SetScale(), ToVECTOR2D(), KIGFX::VIEW::ToWorld(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), DisplayPart(), DisplaySymbol(), and onSize().

◆ GetCanvas()

EDA_DRAW_PANEL_GAL * SYMBOL_PREVIEW_WIDGET::GetCanvas ( ) const

inlineinherited

Definition at line 64 of file symbol_preview_widget.h.

References m_preview.

◆ GetRenderSettings()

SCH_RENDER_SETTINGS * SYMBOL_PREVIEW_WIDGET::GetRenderSettings ( )

inlineinherited

Definition at line 66 of file symbol_preview_widget.h.

References m_renderSettings.

◆ onCharHook()

void SYMBOL_DIFF_WIDGET::onCharHook ( wxKeyEvent & aEvent )

private

Definition at line 202 of file symbol_diff_widget.cpp.

References ToggleAB().

Referenced by SYMBOL_DIFF_WIDGET().

◆ onSize()

void SYMBOL_PREVIEW_WIDGET::onSize ( wxSizeEvent & aEvent )

protectedinherited

Definition at line 152 of file symbol_preview_widget.cpp.

References fitOnDrawArea(), m_preview, and m_previewItem.

Referenced by SYMBOL_PREVIEW_WIDGET().

◆ onSlider()

void SYMBOL_DIFF_WIDGET::onSlider ( wxScrollEvent & aEvent )

private

Definition at line 153 of file symbol_diff_widget.cpp.

References m_libraryItem, SYMBOL_PREVIEW_WIDGET::m_preview, SYMBOL_PREVIEW_WIDGET::m_previewItem, m_slider, and KIGFX::VIEW::Update().

Referenced by DisplayDiff(), SYMBOL_DIFF_WIDGET(), and ToggleAB().

◆ SetStatusText()

void SYMBOL_PREVIEW_WIDGET::SetStatusText ( const wxString & aText )

inherited

Set the contents of the status label and display it.

Definition at line 141 of file symbol_preview_widget.cpp.

References m_preview, m_status, and m_statusPanel.

◆ ToggleAB()

void SYMBOL_DIFF_WIDGET::ToggleAB ( )

Toggle between full-A and full-B display.

Definition at line 139 of file symbol_diff_widget.cpp.

References dummy, m_slider, and onSlider().

Referenced by onCharHook(), and SYMBOL_DIFF_WIDGET().

Member Data Documentation

◆ m_galDisplayOptions

GAL_DISPLAY_OPTIONS_IMPL SYMBOL_PREVIEW_WIDGET::m_galDisplayOptions

protectedinherited

Definition at line 75 of file symbol_preview_widget.h.

Referenced by SYMBOL_PREVIEW_WIDGET().

◆ m_itemBBox

BOX2I SYMBOL_PREVIEW_WIDGET::m_itemBBox

protectedinherited

The bounding box of the current item.

Definition at line 90 of file symbol_preview_widget.h.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), DisplayPart(), DisplaySymbol(), and fitOnDrawArea().

◆ m_kiway

KIWAY* SYMBOL_PREVIEW_WIDGET::m_kiway

protectedinherited

Definition at line 73 of file symbol_preview_widget.h.

Referenced by DisplaySymbol(), and SYMBOL_PREVIEW_WIDGET().

◆ m_libraryItem

LIB_SYMBOL* SYMBOL_DIFF_WIDGET::m_libraryItem

private

Definition at line 60 of file symbol_diff_widget.h.

Referenced by DisplayDiff(), onSlider(), SYMBOL_DIFF_WIDGET(), and ~SYMBOL_DIFF_WIDGET().

◆ m_outerSizer

wxSizer* SYMBOL_PREVIEW_WIDGET::m_outerSizer

protectedinherited

Definition at line 81 of file symbol_preview_widget.h.

Referenced by SYMBOL_DIFF_WIDGET::SYMBOL_DIFF_WIDGET(), and SYMBOL_PREVIEW_WIDGET().

◆ m_preview

EDA_DRAW_PANEL_GAL* SYMBOL_PREVIEW_WIDGET::m_preview

protectedinherited

Definition at line 76 of file symbol_preview_widget.h.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), DisplayPart(), DisplaySymbol(), fitOnDrawArea(), GetCanvas(), onSize(), SYMBOL_DIFF_WIDGET::onSlider(), SetStatusText(), SYMBOL_PREVIEW_WIDGET(), and ~SYMBOL_PREVIEW_WIDGET().

◆ m_previewItem

LIB_SYMBOL* SYMBOL_PREVIEW_WIDGET::m_previewItem

protectedinherited

A local copy of the LIB_SYMBOL to display on the canvas.

Definition at line 86 of file symbol_preview_widget.h.

Referenced by SYMBOL_DIFF_WIDGET::DisplayDiff(), DisplayPart(), DisplaySymbol(), fitOnDrawArea(), onSize(), SYMBOL_DIFF_WIDGET::onSlider(), SYMBOL_PREVIEW_WIDGET(), and ~SYMBOL_PREVIEW_WIDGET().

◆ m_renderSettings

SCH_RENDER_SETTINGS* SYMBOL_PREVIEW_WIDGET::m_renderSettings

protectedinherited

Definition at line 87 of file symbol_preview_widget.h.

Referenced by DisplayPart(), DisplaySymbol(), GetRenderSettings(), and SYMBOL_PREVIEW_WIDGET().

◆ m_slider

wxSlider* SYMBOL_DIFF_WIDGET::m_slider

private

Definition at line 61 of file symbol_diff_widget.h.

Referenced by onSlider(), SYMBOL_DIFF_WIDGET(), and ToggleAB().

◆ m_status

wxStaticText* SYMBOL_PREVIEW_WIDGET::m_status

protectedinherited

Definition at line 78 of file symbol_preview_widget.h.

Referenced by SetStatusText(), and SYMBOL_PREVIEW_WIDGET().

◆ m_statusPanel

wxPanel* SYMBOL_PREVIEW_WIDGET::m_statusPanel

protectedinherited

Definition at line 79 of file symbol_preview_widget.h.

Referenced by DisplayPart(), DisplaySymbol(), SetStatusText(), and SYMBOL_PREVIEW_WIDGET().

◆ m_statusSizer

wxSizer* SYMBOL_PREVIEW_WIDGET::m_statusSizer

protectedinherited

Definition at line 80 of file symbol_preview_widget.h.

Referenced by SYMBOL_PREVIEW_WIDGET().

◆ m_toggleButton

wxBitmapButton* SYMBOL_DIFF_WIDGET::m_toggleButton

private

Definition at line 62 of file symbol_diff_widget.h.

Referenced by SYMBOL_DIFF_WIDGET().

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

SYMBOL_DIFF_WIDGET
Generated on Tue Nov 4 2025 00:07:19 for KiCad PCB EDA Suite by 1.13.2