Base class for DRC rule editor panels that display input fields overlaid on a bitmap. More...

#include <drc_re_bitmap_overlay_panel.h>

Inheritance diagram for DRC_RE_BITMAP_OVERLAY_PANEL:

Public Member Functions
	DRC_RE_BITMAP_OVERLAY_PANEL (wxWindow *aParent, wxWindowID aId=wxID_ANY)

virtual	~DRC_RE_BITMAP_OVERLAY_PANEL ()

void	SetBackgroundBitmap (BITMAPS aBitmap)
	Set the background bitmap for this panel.

bool	TransferDataToWindow () override

bool	TransferDataFromWindow () override

void	ClearFieldErrors ()
	Clear error indicators from all fields.

void	ShowFieldError (const wxString &aFieldId)
	Show an error indicator on the specified field.

virtual bool	ValidateInputs (int aErrorCount, wxString aValidationMessage)=0

virtual wxString	GenerateRule (const RULE_GENERATION_CONTEXT &aContext)=0

Protected Member Functions
template<typename T>
DRC_RE_OVERLAY_FIELD *	AddField (const wxString &aId, const DRC_RE_FIELD_POSITION &aPosition, long aStyle=0)
	Create and position a field control on the bitmap overlay.

template<typename T>
DRC_RE_OVERLAY_FIELD *	AddFieldWithUnits (const wxString &aId, const DRC_RE_FIELD_POSITION &aPosition, UNIT_BINDER *aUnitBinder, long aStyle=0)
	Create and position a field control with unit binding.

DRC_RE_OVERLAY_FIELD *	AddCheckbox (const wxString &aId, const DRC_RE_FIELD_POSITION &aPosition)
	Create and position a checkbox control on the bitmap overlay.

void	LoadBitmap ()
	Load the appropriate bitmap variant for the current theme and DPI.

void	PositionFields ()
	Position all fields based on the current scale factor.

void	SetupFieldStyling (wxControl *aControl)
	Apply transparent styling to a field control.

wxString	buildRule (const RULE_GENERATION_CONTEXT &aContext, const std::vector< wxString > &aConstraintClauses) const

Static Protected Member Functions
static wxString	sanitizeRuleName (const wxString &aRuleName)

static wxString	escapeCondition (const wxString &aCondition)

static wxString	trimTrailingZeros (const wxString &aValue)

static wxString	formatDouble (double aValue, int aPrecision=6)

Private Member Functions
void	OnPaint (wxPaintEvent &aEvent)

void	OnDPIChanged (wxDPIChangedEvent &aEvent)

void	OnThemeChange (wxSysColourChangedEvent &aEvent)

void	OnFieldFocus (wxFocusEvent &aEvent)

void	OnFieldBlur (wxFocusEvent &aEvent)

void	PositionLabel (DRC_RE_OVERLAY_FIELD *aField)
	Position a label relative to its field control based on the label position setting.

Private Attributes
wxBitmap	m_bitmap
	Current background bitmap.

BITMAPS	m_bitmapId
	BITMAPS enum value.

wxSize	m_baseBitmapSize
	Bitmap size at 1x scale.

std::vector< std::unique_ptr< DRC_RE_OVERLAY_FIELD > >	m_fields
	All overlay fields.

std::map< wxString, DRC_RE_OVERLAY_FIELD * >	m_fieldIdMap
	Field ID to field lookup.

Detailed Description

Base class for DRC rule editor panels that display input fields overlaid on a bitmap.

This class provides infrastructure for creating constraint editor panels where input fields are precisely positioned over explanatory constraint diagrams. The bitmap serves as a visual guide showing what each field value represents.

Derived classes should:

Call SetBackgroundBitmap() in their constructor to set the diagram
Create fields using AddField(), AddFieldWithUnits(), or AddCheckbox()
Override TransferDataToWindow/FromWindow to populate/read field values

Definition at line 60 of file drc_re_bitmap_overlay_panel.h.

Constructor & Destructor Documentation

◆ DRC_RE_BITMAP_OVERLAY_PANEL()

DRC_RE_BITMAP_OVERLAY_PANEL::DRC_RE_BITMAP_OVERLAY_PANEL	(	wxWindow *	aParent,
		wxWindowID	aId = wxID_ANY )

Definition at line 36 of file drc_re_bitmap_overlay_panel.cpp.

References INVALID_BITMAP, m_baseBitmapSize, m_bitmapId, OnDPIChanged(), OnPaint(), and OnThemeChange().

◆ ~DRC_RE_BITMAP_OVERLAY_PANEL()

DRC_RE_BITMAP_OVERLAY_PANEL::~DRC_RE_BITMAP_OVERLAY_PANEL ( )

virtual

Definition at line 51 of file drc_re_bitmap_overlay_panel.cpp.

Member Function Documentation

◆ AddCheckbox()

DRC_RE_OVERLAY_FIELD * DRC_RE_BITMAP_OVERLAY_PANEL::AddCheckbox	(	const wxString &	aId,
		const DRC_RE_FIELD_POSITION &	aPosition )

protected

Create and position a checkbox control on the bitmap overlay.

Parameters

aId	String identifier for this checkbox.
aPosition	Position specification in 1x bitmap coordinates.

Returns: Pointer to the created field wrapper.

Definition at line 248 of file drc_re_bitmap_overlay_panel.cpp.

References DRC_RE_OVERLAY_FIELD::CreateLabel(), DRC_RE_OVERLAY_FIELD::HasLabel(), m_fieldIdMap, m_fields, PositionLabel(), SetupFieldStyling(), DRC_RE_FIELD_POSITION::xStart, and DRC_RE_FIELD_POSITION::yTop.

Referenced by DRC_RE_ALLOWED_ORIENTATION_OVERLAY_PANEL::DRC_RE_ALLOWED_ORIENTATION_OVERLAY_PANEL(), DRC_RE_BOOL_INPUT_OVERLAY_PANEL::DRC_RE_BOOL_INPUT_OVERLAY_PANEL(), and DRC_RE_PERMITTED_LAYERS_OVERLAY_PANEL::DRC_RE_PERMITTED_LAYERS_OVERLAY_PANEL().

◆ AddField()

template<typename T>

DRC_RE_OVERLAY_FIELD * DRC_RE_BITMAP_OVERLAY_PANEL::AddField	(	const wxString &	aId,
		const DRC_RE_FIELD_POSITION &	aPosition,
		long	aStyle = 0 )

protected

Create and position a field control on the bitmap overlay.

Template Parameters

T	The wxWindow-derived control type to create.

Parameters

aId	String identifier for this field (used for error display and lookup).
aPosition	Position specification in 1x bitmap coordinates.
aStyle	Window style flags passed to the control constructor

Returns: Pointer to the created field wrapper.

Definition at line 169 of file drc_re_bitmap_overlay_panel.h.

References DRC_RE_OVERLAY_FIELD::CreateLabel(), DRC_RE_OVERLAY_FIELD::HasLabel(), m_fieldIdMap, m_fields, PositionLabel(), SetupFieldStyling(), T, DRC_RE_FIELD_POSITION::xEnd, DRC_RE_FIELD_POSITION::xStart, and DRC_RE_FIELD_POSITION::yTop.

Referenced by AddFieldWithUnits(), DRC_RE_ABS_LENGTH_TWO_OVERLAY_PANEL::DRC_RE_ABS_LENGTH_TWO_OVERLAY_PANEL(), DRC_RE_MIN_TXT_HT_TH_OVERLAY_PANEL::DRC_RE_MIN_TXT_HT_TH_OVERLAY_PANEL(), DRC_RE_NUMERIC_INPUT_OVERLAY_PANEL::DRC_RE_NUMERIC_INPUT_OVERLAY_PANEL(), DRC_RE_ROUTING_DIFF_PAIR_OVERLAY_PANEL::DRC_RE_ROUTING_DIFF_PAIR_OVERLAY_PANEL(), DRC_RE_ROUTING_WIDTH_OVERLAY_PANEL::DRC_RE_ROUTING_WIDTH_OVERLAY_PANEL(), and DRC_RE_VIA_STYLE_OVERLAY_PANEL::DRC_RE_VIA_STYLE_OVERLAY_PANEL().

◆ AddFieldWithUnits()

template<typename T>

DRC_RE_OVERLAY_FIELD * DRC_RE_BITMAP_OVERLAY_PANEL::AddFieldWithUnits	(	const wxString &	aId,
		const DRC_RE_FIELD_POSITION &	aPosition,
		UNIT_BINDER *	aUnitBinder,
		long	aStyle = 0 )

protected

Create and position a field control with unit binding.

Template Parameters

T	The wxWindow-derived control type to create.

Parameters

aId	String identifier for this field.
aPosition	Position specification in 1x bitmap coordinates.
aUnitBinder	UNIT_BINDER to associate with this field for unit conversion.
aStyle	Window style flags passed to the control constructor

Returns: Pointer to the created field wrapper.

Definition at line 205 of file drc_re_bitmap_overlay_panel.h.

References AddField(), and DRC_RE_OVERLAY_FIELD::SetUnitBinder().

◆ buildRule()

wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::buildRule	(	const RULE_GENERATION_CONTEXT &	aContext,
		const std::vector< wxString > &	aConstraintClauses ) const

inlineprotectedinherited

Definition at line 121 of file drc_re_content_panel_base.h.

References RULE_GENERATION_CONTEXT::comment, RULE_GENERATION_CONTEXT::conditionExpression, escapeCondition(), RULE_GENERATION_CONTEXT::layerClause, RULE_GENERATION_CONTEXT::ruleName, and sanitizeRuleName().

◆ ClearFieldErrors()

void DRC_RE_BITMAP_OVERLAY_PANEL::ClearFieldErrors ( )

Clear error indicators from all fields.

Definition at line 232 of file drc_re_bitmap_overlay_panel.cpp.

References m_fields.

◆ escapeCondition()

static wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::escapeCondition ( const wxString & aCondition )

inlinestaticprotectedinherited

Definition at line 94 of file drc_re_content_panel_base.h.

References CTX_QUOTED_STR, and EscapeString().

Referenced by buildRule().

◆ formatDouble()

static wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::formatDouble	(	double	aValue,
		int	aPrecision = 6 )

inlinestaticprotectedinherited

Definition at line 115 of file drc_re_content_panel_base.h.

References trimTrailingZeros().

◆ GenerateRule()

virtual wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::GenerateRule ( const RULE_GENERATION_CONTEXT & aContext )

pure virtualinherited

Implemented in DRC_RE_ABS_LENGTH_TWO_OVERLAY_PANEL, DRC_RE_ALLOWED_ORIENTATION_OVERLAY_PANEL, DRC_RE_BOOL_INPUT_OVERLAY_PANEL, DRC_RE_CUSTOM_RULE_PANEL, DRC_RE_MIN_TXT_HT_TH_OVERLAY_PANEL, DRC_RE_NUMERIC_INPUT_OVERLAY_PANEL, DRC_RE_PERMITTED_LAYERS_OVERLAY_PANEL, DRC_RE_ROUTING_DIFF_PAIR_OVERLAY_PANEL, DRC_RE_ROUTING_WIDTH_OVERLAY_PANEL, DRC_RE_VIA_STYLE_OVERLAY_PANEL, and PANEL_DRC_RULE_EDITOR.

◆ LoadBitmap()

void DRC_RE_BITMAP_OVERLAY_PANEL::LoadBitmap ( )

protected

Load the appropriate bitmap variant for the current theme and DPI.

Definition at line 110 of file drc_re_bitmap_overlay_panel.cpp.

References INVALID_BITMAP, KiBitmapBundle(), m_baseBitmapSize, m_bitmap, m_bitmapId, and Refresh().

Referenced by OnDPIChanged(), OnThemeChange(), and SetBackgroundBitmap().

◆ OnDPIChanged()

void DRC_RE_BITMAP_OVERLAY_PANEL::OnDPIChanged ( wxDPIChangedEvent & aEvent )

private

Definition at line 67 of file drc_re_bitmap_overlay_panel.cpp.

References LoadBitmap(), PositionFields(), and Refresh().

Referenced by DRC_RE_BITMAP_OVERLAY_PANEL().

◆ OnFieldBlur()

void DRC_RE_BITMAP_OVERLAY_PANEL::OnFieldBlur ( wxFocusEvent & aEvent )

private

Definition at line 92 of file drc_re_bitmap_overlay_panel.cpp.

Referenced by SetupFieldStyling().

◆ OnFieldFocus()

void DRC_RE_BITMAP_OVERLAY_PANEL::OnFieldFocus ( wxFocusEvent & aEvent )

private

Definition at line 84 of file drc_re_bitmap_overlay_panel.cpp.

Referenced by SetupFieldStyling().

◆ OnPaint()

void DRC_RE_BITMAP_OVERLAY_PANEL::OnPaint ( wxPaintEvent & aEvent )

private

Definition at line 56 of file drc_re_bitmap_overlay_panel.cpp.

References m_bitmap.

Referenced by DRC_RE_BITMAP_OVERLAY_PANEL().

◆ OnThemeChange()

void DRC_RE_BITMAP_OVERLAY_PANEL::OnThemeChange ( wxSysColourChangedEvent & aEvent )

private

Definition at line 76 of file drc_re_bitmap_overlay_panel.cpp.

References LoadBitmap(), and Refresh().

Referenced by DRC_RE_BITMAP_OVERLAY_PANEL().

◆ PositionFields()

void DRC_RE_BITMAP_OVERLAY_PANEL::PositionFields ( )

protected

Position all fields based on the current scale factor.

Definition at line 134 of file drc_re_bitmap_overlay_panel.cpp.

References m_bitmap, m_fields, PositionLabel(), DRC_RE_FIELD_POSITION::xEnd, DRC_RE_FIELD_POSITION::xStart, and DRC_RE_FIELD_POSITION::yTop.

◆ PositionLabel()

void DRC_RE_BITMAP_OVERLAY_PANEL::PositionLabel ( DRC_RE_OVERLAY_FIELD * aField )

private

Position a label relative to its field control based on the label position setting.

Parameters

aField The overlay field containing the label to position.

Definition at line 171 of file drc_re_bitmap_overlay_panel.cpp.

References BOTTOM, GAP, DRC_RE_OVERLAY_FIELD::GetControl(), DRC_RE_OVERLAY_FIELD::GetLabel(), DRC_RE_OVERLAY_FIELD::GetPosition(), DRC_RE_FIELD_POSITION::labelPosition, LEFT, NONE, RIGHT, and TOP.

Referenced by AddCheckbox(), AddField(), and PositionFields().

◆ sanitizeRuleName()

static wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::sanitizeRuleName ( const wxString & aRuleName )

inlinestaticprotectedinherited

Definition at line 63 of file drc_re_content_panel_base.h.

References result.

Referenced by buildRule().

◆ SetBackgroundBitmap()

void DRC_RE_BITMAP_OVERLAY_PANEL::SetBackgroundBitmap ( BITMAPS aBitmap )

Set the background bitmap for this panel.

Parameters

aBitmap The BITMAPS enum value identifying the constraint diagram.

Definition at line 124 of file drc_re_bitmap_overlay_panel.cpp.

References LoadBitmap(), m_baseBitmapSize, m_bitmap, and m_bitmapId.

◆ SetupFieldStyling()

void DRC_RE_BITMAP_OVERLAY_PANEL::SetupFieldStyling ( wxControl * aControl )

protected

Apply transparent styling to a field control.

Parameters

aControl The control to style.

Definition at line 99 of file drc_re_bitmap_overlay_panel.cpp.

References OnFieldBlur(), and OnFieldFocus().

Referenced by AddCheckbox(), and AddField().

◆ ShowFieldError()

void DRC_RE_BITMAP_OVERLAY_PANEL::ShowFieldError ( const wxString & aFieldId )

Show an error indicator on the specified field.

Parameters

aFieldId The string identifier of the field to highlight.

Definition at line 239 of file drc_re_bitmap_overlay_panel.cpp.

References m_fieldIdMap.

◆ TransferDataFromWindow()

bool DRC_RE_BITMAP_OVERLAY_PANEL::TransferDataFromWindow ( )

overridevirtual

Implements DRC_RULE_EDITOR_CONTENT_PANEL_BASE.

Reimplemented in DRC_RE_BOOL_INPUT_OVERLAY_PANEL, DRC_RE_MIN_TXT_HT_TH_OVERLAY_PANEL, DRC_RE_NUMERIC_INPUT_OVERLAY_PANEL, DRC_RE_PERMITTED_LAYERS_OVERLAY_PANEL, DRC_RE_ROUTING_DIFF_PAIR_OVERLAY_PANEL, DRC_RE_ROUTING_WIDTH_OVERLAY_PANEL, and DRC_RE_VIA_STYLE_OVERLAY_PANEL.

Definition at line 225 of file drc_re_bitmap_overlay_panel.cpp.

◆ TransferDataToWindow()

bool DRC_RE_BITMAP_OVERLAY_PANEL::TransferDataToWindow ( )

overridevirtual

Implements DRC_RULE_EDITOR_CONTENT_PANEL_BASE.

Reimplemented in DRC_RE_BOOL_INPUT_OVERLAY_PANEL, DRC_RE_MIN_TXT_HT_TH_OVERLAY_PANEL, DRC_RE_NUMERIC_INPUT_OVERLAY_PANEL, DRC_RE_PERMITTED_LAYERS_OVERLAY_PANEL, DRC_RE_ROUTING_DIFF_PAIR_OVERLAY_PANEL, DRC_RE_ROUTING_WIDTH_OVERLAY_PANEL, and DRC_RE_VIA_STYLE_OVERLAY_PANEL.

Definition at line 218 of file drc_re_bitmap_overlay_panel.cpp.

◆ trimTrailingZeros()

static wxString DRC_RULE_EDITOR_CONTENT_PANEL_BASE::trimTrailingZeros ( const wxString & aValue )

inlinestaticprotectedinherited

Definition at line 99 of file drc_re_content_panel_base.h.

References result.

Referenced by formatDouble().

◆ ValidateInputs()

virtual bool DRC_RULE_EDITOR_CONTENT_PANEL_BASE::ValidateInputs	(	int *	aErrorCount,
		wxString *	aValidationMessage )

pure virtualinherited

Implemented in DRC_RE_ABS_LENGTH_TWO_OVERLAY_PANEL, DRC_RE_ALLOWED_ORIENTATION_OVERLAY_PANEL, DRC_RE_BOOL_INPUT_OVERLAY_PANEL, DRC_RE_CUSTOM_RULE_PANEL, DRC_RE_MIN_TXT_HT_TH_OVERLAY_PANEL, DRC_RE_NUMERIC_INPUT_OVERLAY_PANEL, DRC_RE_PERMITTED_LAYERS_OVERLAY_PANEL, DRC_RE_ROUTING_DIFF_PAIR_OVERLAY_PANEL, DRC_RE_ROUTING_WIDTH_OVERLAY_PANEL, DRC_RE_VIA_STYLE_OVERLAY_PANEL, and PANEL_DRC_RULE_EDITOR.

Member Data Documentation

◆ m_baseBitmapSize

wxSize DRC_RE_BITMAP_OVERLAY_PANEL::m_baseBitmapSize

private

Bitmap size at 1x scale.

Definition at line 162 of file drc_re_bitmap_overlay_panel.h.

Referenced by DRC_RE_BITMAP_OVERLAY_PANEL(), LoadBitmap(), and SetBackgroundBitmap().

◆ m_bitmap

wxBitmap DRC_RE_BITMAP_OVERLAY_PANEL::m_bitmap

private

Current background bitmap.

Definition at line 160 of file drc_re_bitmap_overlay_panel.h.

Referenced by LoadBitmap(), OnPaint(), PositionFields(), and SetBackgroundBitmap().

◆ m_bitmapId

BITMAPS DRC_RE_BITMAP_OVERLAY_PANEL::m_bitmapId

private

BITMAPS enum value.

Definition at line 161 of file drc_re_bitmap_overlay_panel.h.

Referenced by DRC_RE_BITMAP_OVERLAY_PANEL(), LoadBitmap(), and SetBackgroundBitmap().

◆ m_fieldIdMap

std::map<wxString, DRC_RE_OVERLAY_FIELD*> DRC_RE_BITMAP_OVERLAY_PANEL::m_fieldIdMap

private

Field ID to field lookup.

Definition at line 164 of file drc_re_bitmap_overlay_panel.h.

Referenced by AddCheckbox(), AddField(), and ShowFieldError().

◆ m_fields

std::vector<std::unique_ptr<DRC_RE_OVERLAY_FIELD> > DRC_RE_BITMAP_OVERLAY_PANEL::m_fields

private

All overlay fields.

Definition at line 163 of file drc_re_bitmap_overlay_panel.h.

Referenced by AddCheckbox(), AddField(), ClearFieldErrors(), and PositionFields().

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DRC_RE_BITMAP_OVERLAY_PANEL()

◆ ~DRC_RE_BITMAP_OVERLAY_PANEL()

Member Function Documentation

◆ AddCheckbox()

◆ AddField()

◆ AddFieldWithUnits()

◆ buildRule()

◆ ClearFieldErrors()

◆ escapeCondition()

◆ formatDouble()

◆ GenerateRule()

◆ LoadBitmap()

◆ OnDPIChanged()

◆ OnFieldBlur()

◆ OnFieldFocus()

◆ OnPaint()

◆ OnThemeChange()

◆ PositionFields()

◆ PositionLabel()

◆ sanitizeRuleName()

◆ SetBackgroundBitmap()

◆ SetupFieldStyling()

◆ ShowFieldError()

◆ TransferDataFromWindow()

◆ TransferDataToWindow()

◆ trimTrailingZeros()

◆ ValidateInputs()

Member Data Documentation

◆ m_baseBitmapSize

◆ m_bitmap

◆ m_bitmapId

◆ m_fieldIdMap

◆ m_fields