QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsVectorLayerToolsContext Class Reference

Contains settings which reflect the context in which vector layer tool operations should consider. More...

#include <qgsvectorlayertoolscontext.h>

Public Member Functions

 QgsVectorLayerToolsContext ()=default
 Constructor for QgsVectorLayerToolsContext.
 
 QgsVectorLayerToolsContext (const QgsVectorLayerToolsContext &other)
 Copy constructor.
 
const QgsExpressionContextScopeadditionalExpressionContextScope () const
 Returns an additional expression context scope to be made available when calculating expressions.
 
QgsExpressionContextexpressionContext () const
 Returns the optional expression context used by the vector layer tools.
 
bool hideParent () const
 Returns whether the parent widget should be hidden when showing tools' dialogues.
 
QgsVectorLayerToolsContextoperator= (const QgsVectorLayerToolsContext &other)
 
QWidget * parentWidget () const
 Returns the widget which should be parented to tools dialogues.
 
void setAdditionalExpressionContextScope (const QgsExpressionContextScope *scope)
 Sets an additional expression context scope to be made available when calculating expressions.
 
void setExpressionContext (const QgsExpressionContext *context)
 Sets the optional expression context used by the vector layer tools.
 
void setHideParent (bool hide)
 Sets whether the parent widget should be hidden when showing tools' dialogues.
 
void setParentWidget (QWidget *parent)
 Sets the widget which should be parented to tools' dialogues.
 
void setShowModal (bool modal)
 Sets whether tools' dialogues should be modal.
 
bool showModal () const
 Returns whether tools' dialogues should be modal.
 

Detailed Description

Contains settings which reflect the context in which vector layer tool operations should consider.

Since
QGIS 3.38

Definition at line 31 of file qgsvectorlayertoolscontext.h.

Constructor & Destructor Documentation

◆ QgsVectorLayerToolsContext() [1/2]

QgsVectorLayerToolsContext::QgsVectorLayerToolsContext ( )
default

Constructor for QgsVectorLayerToolsContext.

◆ QgsVectorLayerToolsContext() [2/2]

QgsVectorLayerToolsContext::QgsVectorLayerToolsContext ( const QgsVectorLayerToolsContext other)

Copy constructor.

Parameters
othersource QgsVectorLayerToolsContext

Definition at line 19 of file qgsvectorlayertoolscontext.cpp.

Member Function Documentation

◆ additionalExpressionContextScope()

const QgsExpressionContextScope * QgsVectorLayerToolsContext::additionalExpressionContextScope ( ) const

Returns an additional expression context scope to be made available when calculating expressions.

See also
setAdditionalExpressionContextScope()

Definition at line 75 of file qgsvectorlayertoolscontext.cpp.

◆ expressionContext()

QgsExpressionContext * QgsVectorLayerToolsContext::expressionContext ( ) const

Returns the optional expression context used by the vector layer tools.

See also
setExpressionContext()
additionalExpressionContextScope()

Definition at line 62 of file qgsvectorlayertoolscontext.cpp.

◆ hideParent()

bool QgsVectorLayerToolsContext::hideParent ( ) const
inline

Returns whether the parent widget should be hidden when showing tools' dialogues.

Definition at line 100 of file qgsvectorlayertoolscontext.h.

◆ operator=()

QgsVectorLayerToolsContext & QgsVectorLayerToolsContext::operator= ( const QgsVectorLayerToolsContext other)

Definition at line 34 of file qgsvectorlayertoolscontext.cpp.

◆ parentWidget()

QWidget * QgsVectorLayerToolsContext::parentWidget ( ) const
inline

Returns the widget which should be parented to tools dialogues.

Definition at line 79 of file qgsvectorlayertoolscontext.h.

◆ setAdditionalExpressionContextScope()

void QgsVectorLayerToolsContext::setAdditionalExpressionContextScope ( const QgsExpressionContextScope scope)

Sets an additional expression context scope to be made available when calculating expressions.

Parameters
scopeadditional scope. Ownership is not transferred and a copy will be made.
See also
additionalExpressionContextScope()

Definition at line 67 of file qgsvectorlayertoolscontext.cpp.

◆ setExpressionContext()

void QgsVectorLayerToolsContext::setExpressionContext ( const QgsExpressionContext context)

Sets the optional expression context used by the vector layer tools.

Parameters
contextexpression context pointer. Ownership is not transferred.
See also
expressionContext()
setAdditionalExpressionContextScope()

Definition at line 54 of file qgsvectorlayertoolscontext.cpp.

◆ setHideParent()

void QgsVectorLayerToolsContext::setHideParent ( bool  hide)
inline

Sets whether the parent widget should be hidden when showing tools' dialogues.

Definition at line 105 of file qgsvectorlayertoolscontext.h.

◆ setParentWidget()

void QgsVectorLayerToolsContext::setParentWidget ( QWidget *  parent)
inline

Sets the widget which should be parented to tools' dialogues.

Parameters
parentthe widget actign as parent

Definition at line 85 of file qgsvectorlayertoolscontext.h.

◆ setShowModal()

void QgsVectorLayerToolsContext::setShowModal ( bool  modal)
inline

Sets whether tools' dialogues should be modal.

Definition at line 95 of file qgsvectorlayertoolscontext.h.

◆ showModal()

bool QgsVectorLayerToolsContext::showModal ( ) const
inline

Returns whether tools' dialogues should be modal.

Definition at line 90 of file qgsvectorlayertoolscontext.h.


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