QGIS API Documentation  2.99.0-Master (c558d51)
Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsLayerPropertiesWidget Class Reference

#include <qgslayerpropertieswidget.h>

Inheritance diagram for QgsLayerPropertiesWidget:
Inheritance graph
[legend]

Public Slots

void emitSignalChanged ()
 
void layerTypeChanged ()
 
- 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...
 

Signals

void changed ()
 
void changeLayer (QgsSymbolLayer *)
 
- 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

 QgsLayerPropertiesWidget (QgsSymbolLayer *layer, const QgsSymbol *symbol, const QgsVectorLayer *vl, QWidget *parent=nullptr)
 
QgsSymbolWidgetContext context () const
 Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts. More...
 
void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts. More...
 
virtual void setDockMode (bool dockMode) override
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=0)
 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 ()
 Return the dock mode state. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()
 

Protected Member Functions

QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
void populateLayerTypes ()
 
void updateSymbolLayerWidget (QgsSymbolLayer *layer)
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event)
 Overridden key press event to handle the esc event on the widget. More...
 

Protected Attributes

QgsSymbolLayermLayer
 
const QgsSymbolmSymbol
 
const QgsVectorLayermVectorLayer
 

Additional Inherited Members

- 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

Definition at line 38 of file qgslayerpropertieswidget.h.

Constructor & Destructor Documentation

QgsLayerPropertiesWidget::QgsLayerPropertiesWidget ( QgsSymbolLayer layer,
const QgsSymbol symbol,
const QgsVectorLayer vl,
QWidget *  parent = nullptr 
)

Definition at line 92 of file qgslayerpropertieswidget.cpp.

Member Function Documentation

void QgsLayerPropertiesWidget::changed ( )
signal
void QgsLayerPropertiesWidget::changeLayer ( QgsSymbolLayer )
signal
QgsSymbolWidgetContext QgsLayerPropertiesWidget::context ( ) const

Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.

See also
setContext()
Note
added in QGIS 3.0

Definition at line 161 of file qgslayerpropertieswidget.cpp.

QgsExpressionContext QgsLayerPropertiesWidget::createExpressionContext ( ) const
overrideprotectedvirtual

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

Note
Added in QGIS 3.0

Implements QgsExpressionContextGenerator.

Definition at line 227 of file qgslayerpropertieswidget.cpp.

void QgsLayerPropertiesWidget::emitSignalChanged ( )
slot

Definition at line 304 of file qgslayerpropertieswidget.cpp.

void QgsLayerPropertiesWidget::layerTypeChanged ( )
slot

Definition at line 279 of file qgslayerpropertieswidget.cpp.

void QgsLayerPropertiesWidget::populateLayerTypes ( )
protected

Definition at line 172 of file qgslayerpropertieswidget.cpp.

void QgsLayerPropertiesWidget::setContext ( const QgsSymbolWidgetContext context)

Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.

Parameters
contextsymbol widget context
See also
context()
Note
added in QGIS 3.0

Definition at line 152 of file qgslayerpropertieswidget.cpp.

void QgsLayerPropertiesWidget::setDockMode ( bool  dockMode)
overridevirtual

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

Parameters
dockModeTrue to enable dock mode.

Reimplemented from QgsPanelWidget.

Definition at line 166 of file qgslayerpropertieswidget.cpp.

void QgsLayerPropertiesWidget::updateSymbolLayerWidget ( QgsSymbolLayer layer)
protected

Definition at line 195 of file qgslayerpropertieswidget.cpp.

Member Data Documentation

QgsSymbolLayer* QgsLayerPropertiesWidget::mLayer
protected

Definition at line 80 of file qgslayerpropertieswidget.h.

const QgsSymbol* QgsLayerPropertiesWidget::mSymbol
protected

Definition at line 82 of file qgslayerpropertieswidget.h.

const QgsVectorLayer* QgsLayerPropertiesWidget::mVectorLayer
protected

Definition at line 83 of file qgslayerpropertieswidget.h.


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