#include <rulecheckdock.h>

Inheritance diagram for RuleCheckDock:

Collaboration diagram for RuleCheckDock:

Public Types
enum class	Mode

Signals
void	settingsDialogRequested ()

void	runDrcRequested ()

void	runQuickCheckRequested ()

void	messageApprovalRequested (const RuleCheckMessage &msg, bool approve)

void	messageSelected (const RuleCheckMessage &msg, bool zoomTo)

Public Member Functions
	RuleCheckDock (Mode mode, QWidget *parent=nullptr) noexcept

	RuleCheckDock (const RuleCheckDock &other)=delete

	~RuleCheckDock () noexcept

bool	setInteractive (bool interactive) noexcept
	Set whether the dock widget should be interactive or not.

void	setProgressPercent (int percent) noexcept

void	setProgressStatus (const QString &status) noexcept

void	setMessages (const std::optional< RuleCheckMessageList > &messages) noexcept

void	setApprovals (const QSet< SExpression > &approvals) noexcept

RuleCheckDock &	operator= (const RuleCheckDock &rhs)=delete

Private Member Functions
void	updateTitle (std::optional< int > unapprovedMessages) noexcept

virtual bool	ruleCheckFixAvailable (std::shared_ptr< const RuleCheckMessage > msg) noexcept override

virtual void	ruleCheckFixRequested (std::shared_ptr< const RuleCheckMessage > msg) noexcept override

virtual void	ruleCheckDescriptionRequested (std::shared_ptr< const RuleCheckMessage > msg) noexcept override

virtual void	ruleCheckApproveRequested (std::shared_ptr< const RuleCheckMessage > msg, bool approve) noexcept override

virtual void	ruleCheckMessageSelected (std::shared_ptr< const RuleCheckMessage > msg) noexcept override

virtual void	ruleCheckMessageDoubleClicked (std::shared_ptr< const RuleCheckMessage > msg) noexcept override

	IF_RuleCheckHandler () noexcept

	IF_RuleCheckHandler (const IF_RuleCheckHandler &) noexcept

virtual	~IF_RuleCheckHandler () noexcept

Private Attributes
const Mode	mMode

QScopedPointer< Ui::RuleCheckDock >	mUi

Detailed Description

The RuleCheckDock class.

Member Enumeration Documentation

◆ Mode

enum class Mode

strong

Enumerator
ElectricalRuleCheck
BoardDesignRuleCheck

Constructor & Destructor Documentation

◆ RuleCheckDock() [1/2]

RuleCheckDock	(	Mode	mode,
		QWidget *	parent = `nullptr`
	)

explicitnoexcept

Here is the call graph for this function:

◆ RuleCheckDock() [2/2]

RuleCheckDock ( const RuleCheckDock & other )

delete

◆ ~RuleCheckDock()

~RuleCheckDock ( )

noexcept

Member Function Documentation

◆ setInteractive()

bool setInteractive ( bool interactive )

noexcept

Set whether the dock widget should be interactive or not.

Parameters

interactive True if enabled, false if disabled.

Returns: Whether the widget was interactive before calling this method. Useful to temporarily disable widget & restore previous state.

◆ setProgressPercent()

void setProgressPercent ( int percent )

noexcept

◆ setProgressStatus()

void setProgressStatus ( const QString & status )

noexcept

◆ setMessages()

void setMessages ( const std::optional< RuleCheckMessageList > & messages )

noexcept

◆ setApprovals()

void setApprovals ( const QSet< SExpression > & approvals )

noexcept

◆ operator=()

RuleCheckDock & operator= ( const RuleCheckDock & rhs )

delete

◆ settingsDialogRequested

void settingsDialogRequested ( )

signal

Here is the caller graph for this function:

◆ runDrcRequested

void runDrcRequested ( )

signal

Here is the caller graph for this function:

◆ runQuickCheckRequested

void runQuickCheckRequested ( )

signal

Here is the caller graph for this function:

◆ messageApprovalRequested

void messageApprovalRequested	(	const RuleCheckMessage &	msg,
		bool	approve
	)

signal

◆ messageSelected

void messageSelected	(	const RuleCheckMessage &	msg,
		bool	zoomTo
	)

signal

◆ updateTitle()

void updateTitle ( std::optional< int > unapprovedMessages )

privatenoexcept