RuleCheckDock Class Reference

The RuleCheckDock class. More...

#include <rulecheckdock.h>

Inheritance diagram for RuleCheckDock:

Collaboration diagram for RuleCheckDock:

Public Types
enum	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. More...
void	setProgressPercent (int percent) noexcept
void	setProgressStatus (const QString &status) noexcept
void	setMessages (const tl::optional< RuleCheckMessageList > &messages) noexcept
void	setApprovals (const QSet< SExpression > &approvals) noexcept
RuleCheckDock &	operator= (const RuleCheckDock &rhs)=delete

Private Member Functions
void	updateTitle (tl::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 Mode

strong

Enumerator
ElectricalRuleCheck
BoardDesignRuleCheck

Constructor & Destructor Documentation

RuleCheckDock() [1/2]

RuleCheckDock ( Mode  mode, QWidget *  parent = nullptr  )

explicitnoexcept

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

Here is the caller graph for this function:

setProgressStatus()

void setProgressStatus ( const QString &  status )

noexcept

Here is the caller graph for this function:

setMessages()

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

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

setApprovals()

void setApprovals ( const QSet< SExpression > &  approvals )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

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

Here is the caller graph for this function:

messageSelected

void messageSelected ( const RuleCheckMessage &  msg, bool  zoomTo  )

signal

Here is the caller graph for this function:

updateTitle()

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

privatenoexcept

Here is the caller graph for this function:

ruleCheckFixAvailable()

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

overrideprivatevirtualnoexcept

Implements IF_RuleCheckHandler.

ruleCheckFixRequested()

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

overrideprivatevirtualnoexcept

Implements IF_RuleCheckHandler.

ruleCheckDescriptionRequested()

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

overrideprivatevirtualnoexcept

Implements IF_RuleCheckHandler.

Here is the caller graph for this function:

ruleCheckApproveRequested()

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

overrideprivatevirtualnoexcept

Implements IF_RuleCheckHandler.

ruleCheckMessageSelected()

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

overrideprivatevirtualnoexcept

Implements IF_RuleCheckHandler.

ruleCheckMessageDoubleClicked()

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

overrideprivatevirtualnoexcept

Implements IF_RuleCheckHandler.

Here is the call graph for this function:

Member Data Documentation

mMode

const Mode mMode

private

mUi

QScopedPointer<Ui::RuleCheckDock> mUi

private

---

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

• /__w/1/s/libs/librepcb/editor/widgets/rulecheckdock.h
• /__w/1/s/libs/librepcb/editor/widgets/rulecheckdock.cpp