QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Types | Public Member Functions | List of all members
QgsAdvancedDigitizingDockWidget::CadConstraint Class Reference

The CadConstraint is an abstract class for all basic constraints (angle/distance/x/y). More...

#include <qgsadvanceddigitizingdockwidget.h>

Public Types

enum  LockMode { NoLock , SoftLock , HardLock }
 The lock mode. More...
 

Public Member Functions

 CadConstraint (QLineEdit *lineEdit, QToolButton *lockerButton, QToolButton *relativeButton=nullptr, QToolButton *repeatingLockButton=nullptr)
 Constructor for CadConstraint. More...
 
bool isLocked () const
 Is any kind of lock mode enabled. More...
 
bool isRepeatingLock () const
 Returns true if a repeating lock is set for the constraint. More...
 
QLineEdit * lineEdit () const
 The line edit that manages the value of the constraint. More...
 
LockMode lockMode () const
 The current lock mode of this constraint. More...
 
int precision () const
 Returns the numeric precision (decimal places) to show in the associated widget. More...
 
bool relative () const
 Is the constraint in relative mode. More...
 
void setLockMode (LockMode mode)
 Set the lock mode. More...
 
void setPrecision (int precision)
 Sets the numeric precision (decimal places) to show in the associated widget. More...
 
void setRelative (bool relative)
 Set if the constraint should be treated relative. More...
 
void setRepeatingLock (bool repeating)
 Sets whether a repeating lock is set for the constraint. More...
 
void setValue (double value, bool updateWidget=true)
 Set the value of the constraint. More...
 
void toggleLocked ()
 Toggle lock mode. More...
 
void toggleRelative ()
 Toggle relative mode. More...
 
double value () const
 The value of the constraint. More...
 

Detailed Description

The CadConstraint is an abstract class for all basic constraints (angle/distance/x/y).

It contains all values (locked, value, relative) and pointers to corresponding widgets.

Note
Relative is not mandatory since it is not used for distance.

Definition at line 88 of file qgsadvanceddigitizingdockwidget.h.

Member Enumeration Documentation

◆ LockMode

The lock mode.

Enumerator
NoLock 
SoftLock 
HardLock 

Definition at line 95 of file qgsadvanceddigitizingdockwidget.h.

Constructor & Destructor Documentation

◆ CadConstraint()

QgsAdvancedDigitizingDockWidget::CadConstraint::CadConstraint ( QLineEdit *  lineEdit,
QToolButton *  lockerButton,
QToolButton *  relativeButton = nullptr,
QToolButton *  repeatingLockButton = nullptr 
)
inline

Constructor for CadConstraint.

Parameters
lineEditassociated line edit for constraint value
lockerButtonassociated button for locking constraint
relativeButtonoptional button for toggling relative constraint mode
repeatingLockButtonoptional button for toggling repeating lock mode

Definition at line 109 of file qgsadvanceddigitizingdockwidget.h.

Member Function Documentation

◆ isLocked()

bool QgsAdvancedDigitizingDockWidget::CadConstraint::isLocked ( ) const
inline

Is any kind of lock mode enabled.

Definition at line 129 of file qgsadvanceddigitizingdockwidget.h.

◆ isRepeatingLock()

bool QgsAdvancedDigitizingDockWidget::CadConstraint::isRepeatingLock ( ) const
inline

Returns true if a repeating lock is set for the constraint.

Repeating locks are not automatically cleared after a new point is added.

See also
setRepeatingLock()
Since
QGIS 2.16

Definition at line 137 of file qgsadvanceddigitizingdockwidget.h.

◆ lineEdit()

QLineEdit * QgsAdvancedDigitizingDockWidget::CadConstraint::lineEdit ( ) const
inline

The line edit that manages the value of the constraint.

Definition at line 152 of file qgsadvanceddigitizingdockwidget.h.

◆ lockMode()

LockMode QgsAdvancedDigitizingDockWidget::CadConstraint::lockMode ( ) const
inline

The current lock mode of this constraint.

Returns
Lock mode

Definition at line 124 of file qgsadvanceddigitizingdockwidget.h.

◆ precision()

int QgsAdvancedDigitizingDockWidget::CadConstraint::precision ( ) const
inline

Returns the numeric precision (decimal places) to show in the associated widget.

See also
setPrecision()
Since
QGIS 3.22

Definition at line 196 of file qgsadvanceddigitizingdockwidget.h.

◆ relative()

bool QgsAdvancedDigitizingDockWidget::CadConstraint::relative ( ) const
inline

Is the constraint in relative mode.

Definition at line 142 of file qgsadvanceddigitizingdockwidget.h.

◆ setLockMode()

void QgsAdvancedDigitizingDockWidget::CadConstraint::setLockMode ( LockMode  mode)

Set the lock mode.

Definition at line 1754 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setPrecision()

void QgsAdvancedDigitizingDockWidget::CadConstraint::setPrecision ( int  precision)

Sets the numeric precision (decimal places) to show in the associated widget.

See also
precision()
Since
QGIS 3.22

Definition at line 1811 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setRelative()

void QgsAdvancedDigitizingDockWidget::CadConstraint::setRelative ( bool  relative)

Set if the constraint should be treated relative.

Definition at line 1785 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setRepeatingLock()

void QgsAdvancedDigitizingDockWidget::CadConstraint::setRepeatingLock ( bool  repeating)

Sets whether a repeating lock is set for the constraint.

Repeating locks are not automatically cleared after a new point is added.

Parameters
repeatingset to true to set the lock to repeat automatically
See also
isRepeatingLock()
Since
QGIS 2.16

Definition at line 1778 of file qgsadvanceddigitizingdockwidget.cpp.

◆ setValue()

void QgsAdvancedDigitizingDockWidget::CadConstraint::setValue ( double  value,
bool  updateWidget = true 
)

Set the value of the constraint.

Parameters
valuenew value for constraint
updateWidgetset to false to prevent automatically updating the associated widget's value

Definition at line 1794 of file qgsadvanceddigitizingdockwidget.cpp.

◆ toggleLocked()

void QgsAdvancedDigitizingDockWidget::CadConstraint::toggleLocked ( )

Toggle lock mode.

Definition at line 1801 of file qgsadvanceddigitizingdockwidget.cpp.

◆ toggleRelative()

void QgsAdvancedDigitizingDockWidget::CadConstraint::toggleRelative ( )

Toggle relative mode.

Definition at line 1806 of file qgsadvanceddigitizingdockwidget.cpp.

◆ value()

double QgsAdvancedDigitizingDockWidget::CadConstraint::value ( ) const
inline

The value of the constraint.

Definition at line 147 of file qgsadvanceddigitizingdockwidget.h.


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