LibrePCB Developers Documentation
RuleCheckDock Class Referencefinal

The RuleCheckDock class. More...

#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. 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
 
RuleCheckDockoperator= (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
 
virtual bool ruleCheckFixAvailable (std::shared_ptr< const RuleCheckMessage > msg) noexcept=0
 
virtual void ruleCheckFixRequested (std::shared_ptr< const RuleCheckMessage > msg) noexcept=0
 
virtual void ruleCheckDescriptionRequested (std::shared_ptr< const RuleCheckMessage > msg) noexcept=0
 
virtual void ruleCheckApproveRequested (std::shared_ptr< const RuleCheckMessage > msg, bool approve) noexcept=0
 
virtual void ruleCheckMessageSelected (std::shared_ptr< const RuleCheckMessage > msg) noexcept=0
 
virtual void ruleCheckMessageDoubleClicked (std::shared_ptr< const RuleCheckMessage > msg) noexcept=0
 
 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

◆ 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
interactiveTrue 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 tl::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 ( tl::optional< int >  unapprovedMessages)
privatenoexcept

◆ 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.

◆ 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.

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: