DESIGN_BLOCK_PREVIEW_WIDGET Class Reference

#include <design_block_preview_widget.h>

Inheritance diagram for DESIGN_BLOCK_PREVIEW_WIDGET:

Public Member Functions
	DESIGN_BLOCK_PREVIEW_WIDGET (wxWindow *aParent)
	Construct a design block preview widget.
	~DESIGN_BLOCK_PREVIEW_WIDGET ()=default
virtual bool	IsInitialized () const =0
	Return whether the widget initialized properly.
virtual void	SetStatusText (const wxString &aText)=0
	Set the contents of the status label and display it.
virtual void	DisplayDesignBlock (DESIGN_BLOCK *aDesignBlock)=0
	Set the currently displayed design block.

Protected Member Functions
void	onSize (wxSizeEvent &aEvent)
void	fitOnDrawArea ()

Detailed Description

Definition at line 37 of file design_block_preview_widget.h.

Constructor & Destructor Documentation

DESIGN_BLOCK_PREVIEW_WIDGET()

DESIGN_BLOCK_PREVIEW_WIDGET::DESIGN_BLOCK_PREVIEW_WIDGET ( wxWindow * aParent )

inline

Construct a design block preview widget.

Parameters

aParent

- parent window

Definition at line 45 of file design_block_preview_widget.h.

Referenced by PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), and SCH_DESIGN_BLOCK_PREVIEW_WIDGET::SCH_DESIGN_BLOCK_PREVIEW_WIDGET().

~DESIGN_BLOCK_PREVIEW_WIDGET()

DESIGN_BLOCK_PREVIEW_WIDGET::~DESIGN_BLOCK_PREVIEW_WIDGET ( )

default

Member Function Documentation

DisplayDesignBlock()

virtual void DESIGN_BLOCK_PREVIEW_WIDGET::DisplayDesignBlock ( DESIGN_BLOCK * aDesignBlock )

pure virtual

Set the currently displayed design block.

Implemented in PCB_DESIGN_BLOCK_PREVIEW_WIDGET, and SCH_DESIGN_BLOCK_PREVIEW_WIDGET.

fitOnDrawArea()

void DESIGN_BLOCK_PREVIEW_WIDGET::fitOnDrawArea ( )

protected

IsInitialized()

virtual bool DESIGN_BLOCK_PREVIEW_WIDGET::IsInitialized ( ) const

pure virtual

Return whether the widget initialized properly.

This could return false if Kiway is not available. If this returns false, no other methods should be called.

Implemented in PCB_DESIGN_BLOCK_PREVIEW_WIDGET, and SCH_DESIGN_BLOCK_PREVIEW_WIDGET.

onSize()

void DESIGN_BLOCK_PREVIEW_WIDGET::onSize ( wxSizeEvent & aEvent )

protected

SetStatusText()

virtual void DESIGN_BLOCK_PREVIEW_WIDGET::SetStatusText ( const wxString & aText )

pure virtual

Set the contents of the status label and display it.

Implemented in PCB_DESIGN_BLOCK_PREVIEW_WIDGET, and SCH_DESIGN_BLOCK_PREVIEW_WIDGET.

---

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

• design_block_preview_widget.h