QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Signals | Public Member Functions | Protected Member Functions | List of all members
QgsMaskingWidget Class Reference

Main widget for the configuration of mask sources and targets. More...

#include <qgsmaskingwidget.h>

Inheritance diagram for QgsMaskingWidget:
Inheritance graph
[legend]

Signals

void widgetChanged ()
 Emitted when a change is performed. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Public Member Functions

 QgsMaskingWidget (QWidget *parent=nullptr)
 constructor More...
 
void apply ()
 Applies the changes. More...
 
bool hasBeenPopulated ()
 Widget has been populated or not. More...
 
void setLayer (QgsVectorLayer *layer)
 Sets the layer to configure. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
void connectChildPanel (QgsPanelWidget *panel)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
 
void connectChildPanels (const QList< QgsPanelWidget *> &panels)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
 
bool dockMode ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Protected Member Functions

void showEvent (QShowEvent *) override
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

Additional Inherited Members

- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
void openPanel (QgsPanelWidget *panel)
 Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event. More...
 
- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 

Detailed Description

Main widget for the configuration of mask sources and targets.

Note
This class is not a part of public API
Since
QGIS 3.14

Definition at line 37 of file qgsmaskingwidget.h.

Constructor & Destructor Documentation

◆ QgsMaskingWidget()

QgsMaskingWidget::QgsMaskingWidget ( QWidget *  parent = nullptr)

constructor

Definition at line 33 of file qgsmaskingwidget.cpp.

Member Function Documentation

◆ apply()

void QgsMaskingWidget::apply ( )

Applies the changes.

Definition at line 237 of file qgsmaskingwidget.cpp.

◆ hasBeenPopulated()

bool QgsMaskingWidget::hasBeenPopulated ( )

Widget has been populated or not.

Definition at line 336 of file qgsmaskingwidget.cpp.

◆ setLayer()

void QgsMaskingWidget::setLayer ( QgsVectorLayer layer)

Sets the layer to configure.

Definition at line 165 of file qgsmaskingwidget.cpp.

◆ showEvent()

void QgsMaskingWidget::showEvent ( QShowEvent *  event)
overrideprotected

Definition at line 58 of file qgsmaskingwidget.cpp.

◆ widgetChanged

void QgsMaskingWidget::widgetChanged ( )
signal

Emitted when a change is performed.


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