QGIS API Documentation 3.39.0-Master (699c004a5df)
Loading...
Searching...
No Matches
Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsRasterTransparencyWidget Class Reference

Widget to control a layers transparency and related options. More...

#include <qgsrastertransparencywidget.h>

Inheritance diagram for QgsRasterTransparencyWidget:
Inheritance graph
[legend]

Public Slots

void apply () override
 Apply any changes on the widget to the set layer.
 
void syncToLayer ()
 Sync the widget state to the layer set for the widget.
 
- Public Slots inherited from QgsMapLayerConfigWidget
virtual void apply ()=0
 Called when changes to the layer need to be made.
 
virtual void focusDefaultWidget ()
 Focuses the default widget for the page.
 
- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel.
 
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.
 

Public Member Functions

 QgsRasterTransparencyWidget (QgsRasterLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
 Widget to control a layers transparency and related options.
 
void applyToRasterProvider (QgsRasterDataProvider *provider) SIP_SKIP
 Applies widget settings to a raster provider.
 
void applyToRasterRenderer (QgsRasterRenderer *renderer) SIP_SKIP
 Applies widget settings to a raster renderer.
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context.
 
QgsMapToolEmitPointpixelSelectorTool () const
 Returns the (possibly nullptr) map pixel selector tool.
 
void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the dialog is shown, e.g., the associated map canvas and expression contexts.
 
- Public Member Functions inherited from QgsMapLayerConfigWidget
 QgsMapLayerConfigWidget (QgsMapLayer *layer, QgsMapCanvas *canvas, QWidget *parent=nullptr)
 A panel widget that can be shown in the map style dock.
 
virtual void setMapLayerConfigWidgetContext (const QgsMapLayerConfigWidgetContext &context)
 Sets the context under which the widget is being shown.
 
virtual bool shouldTriggerLayerRepaint () const
 Whether this config widget changes map layer properties in a way that triggerRepaint() should be called for the layer after applying changes.
 
virtual void syncToLayer (QgsMapLayer *layer)
 Reset to original (vector layer) values.
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel.
 
virtual bool applySizeConstraintsToStack () const
 Returns true if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.
 
bool autoDelete ()
 The the auto delete property on the widget.
 
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.
 
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.
 
bool dockMode ()
 Returns the dock mode state.
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required.
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel.
 
QString panelTitle ()
 The title of the panel.
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget.
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface.
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 

Protected Member Functions

void initializeDataDefinedButton (QgsPropertyOverrideButton *button, QgsRasterPipe::Property key)
 Registers a property override button, setting up its initial value, connections and description.
 
void updateDataDefinedButton (QgsPropertyOverrideButton *button)
 Updates a specific property override button to reflect the widgets's current properties.
 
void updateDataDefinedButtons ()
 Updates all property override buttons to reflect the widgets's current properties.
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget.
 

Protected Attributes

QgsPropertyCollection mPropertyCollection
 Temporary property collection.
 
- Protected Attributes inherited from QgsMapLayerConfigWidget
QgsMapLayermLayer = nullptr
 
QgsMapCanvasmMapCanvas = nullptr
 
QgsMapLayerConfigWidgetContext mMapLayerConfigWidgetContext
 

Additional Inherited Members

- Signals inherited from QgsMapLayerConfigWidget
void dynamicTemporalControlToggled (bool enabled)
 Emitted whenever the dynamic temporal control option is toggled in the associated layer properties dialog.
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user.
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface.
 
void widgetChanged ()
 Emitted when the widget state changes.
 
- 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.
 

Detailed Description

Widget to control a layers transparency and related options.

Definition at line 38 of file qgsrastertransparencywidget.h.

Constructor & Destructor Documentation

◆ QgsRasterTransparencyWidget()

QgsRasterTransparencyWidget::QgsRasterTransparencyWidget ( QgsRasterLayer layer,
QgsMapCanvas canvas,
QWidget *  parent = nullptr 
)

Widget to control a layers transparency and related options.

Definition at line 38 of file qgsrastertransparencywidget.cpp.

Member Function Documentation

◆ apply

void QgsRasterTransparencyWidget::apply ( )
overrideslot

Apply any changes on the widget to the set layer.

Definition at line 472 of file qgsrastertransparencywidget.cpp.

◆ applyToRasterProvider()

void QgsRasterTransparencyWidget::applyToRasterProvider ( QgsRasterDataProvider provider)

Applies widget settings to a raster provider.

Note
Not available in Python bindings
Since
QGIS 3.40

Definition at line 479 of file qgsrastertransparencywidget.cpp.

◆ applyToRasterRenderer()

void QgsRasterTransparencyWidget::applyToRasterRenderer ( QgsRasterRenderer renderer)

Applies widget settings to a raster renderer.

Note
Not available in Python bindings
Since
QGIS 3.40

Definition at line 503 of file qgsrastertransparencywidget.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsRasterTransparencyWidget::createExpressionContext ( ) const
overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Implements QgsExpressionContextGenerator.

Definition at line 82 of file qgsrastertransparencywidget.cpp.

◆ initializeDataDefinedButton()

void QgsRasterTransparencyWidget::initializeDataDefinedButton ( QgsPropertyOverrideButton button,
QgsRasterPipe::Property  key 
)
protected

Registers a property override button, setting up its initial value, connections and description.

Parameters
buttonbutton to register
keycorresponding data defined property key
Note
Not available in Python bindings
Since
QGIS 3.22

Definition at line 561 of file qgsrastertransparencywidget.cpp.

◆ pixelSelectorTool()

QgsMapToolEmitPoint * QgsRasterTransparencyWidget::pixelSelectorTool ( ) const

Returns the (possibly nullptr) map pixel selector tool.

Since
QGIS 3.22

Definition at line 841 of file qgsrastertransparencywidget.cpp.

◆ setContext()

void QgsRasterTransparencyWidget::setContext ( const QgsSymbolWidgetContext context)

Sets the context in which the dialog is shown, e.g., the associated map canvas and expression contexts.

Since
QGIS 3.22

Definition at line 77 of file qgsrastertransparencywidget.cpp.

◆ syncToLayer

void QgsRasterTransparencyWidget::syncToLayer ( )
slot

Sync the widget state to the layer set for the widget.

Definition at line 111 of file qgsrastertransparencywidget.cpp.

◆ updateDataDefinedButton()

void QgsRasterTransparencyWidget::updateDataDefinedButton ( QgsPropertyOverrideButton button)
protected

Updates a specific property override button to reflect the widgets's current properties.

Note
Not available in Python bindings
Since
QGIS 3.22

Definition at line 579 of file qgsrastertransparencywidget.cpp.

◆ updateDataDefinedButtons()

void QgsRasterTransparencyWidget::updateDataDefinedButtons ( )
protected

Updates all property override buttons to reflect the widgets's current properties.

Note
Not available in Python bindings
Since
QGIS 3.22

Definition at line 570 of file qgsrastertransparencywidget.cpp.

Member Data Documentation

◆ mPropertyCollection

QgsPropertyCollection QgsRasterTransparencyWidget::mPropertyCollection
protected

Temporary property collection.

Definition at line 130 of file qgsrastertransparencywidget.h.


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