QGIS API Documentation  3.9.0-Master (3ff8ca5736)
Public Slots | Signals | Public Member Functions | Friends | List of all members
QgsSymbolSelectorWidget Class Reference

Symbol selector widget that can be used to select and build a symbol. More...

#include <qgssymbolselectordialog.h>

Inheritance diagram for QgsSymbolSelectorWidget:
Inheritance graph
[legend]

Public Slots

void addLayer ()
 Add a symbol layer to the bottom of the stack. More...
 
void changeLayer (QgsSymbolLayer *layer)
 alters tree and sets proper widget when Layer Type is changed More...
 
void duplicateLayer ()
 Duplicates the current symbol layer and places the duplicated layer above the current symbol layer. More...
 
void layerChanged ()
 Called when the layer changes in the widget. More...
 
void lockLayer ()
 Lock the current active symbol layer. More...
 
void moveLayerDown ()
 Move the active symbol layer down. More...
 
void moveLayerUp ()
 Move the active symbol layer up. More...
 
void removeLayer ()
 Remove the current active symbol layer. More...
 
void symbolChanged ()
 Slot to update tree when a new symbol from style. More...
 
void updateLayerPreview ()
 Update the single symbol layer preview in the widget. More...
 
void updatePreview ()
 Update the preview of the whole symbol in the interface. More...
 
- 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 symbolModified ()
 Emiited when a symbol is modified in the widget. 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

 QgsSymbolSelectorWidget (QgsSymbol *symbol, QgsStyle *style, QgsVectorLayer *vl, QWidget *parent=nullptr)
 Symbol selector widget that can be used to select and build a symbol. More...
 
QMenu * advancedMenu ()
 Returns menu for "advanced" button - create it if doesn't exist and show the advanced button. More...
 
QgsSymbolWidgetContext context () const
 Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. More...
 
void loadSymbol (QgsSymbol *symbol, SymbolLayerItem *parent=nullptr)
 Loads the given symbol into the widget. More...
 
void setContext (const QgsSymbolWidgetContext &context)
 Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. More...
 
QgsSymbolsymbol ()
 Returns the symbol that is currently active in the widget. 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...
 
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...
 

Friends

class QgsSymbolSelectorDialog
 To allow for non API break access from the dialog. More...
 

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...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

Symbol selector widget that can be used to select and build a symbol.

Definition at line 87 of file qgssymbolselectordialog.h.

Constructor & Destructor Documentation

◆ QgsSymbolSelectorWidget()

QgsSymbolSelectorWidget::QgsSymbolSelectorWidget ( QgsSymbol symbol,
QgsStyle style,
QgsVectorLayer vl,
QWidget *  parent = nullptr 
)

Symbol selector widget that can be used to select and build a symbol.

Parameters
symbolThe symbol to load into the widget as a start point.
styleThe style used by the widget.
vlThe vector layer for the symbol.
parent
Note
The ownership of the symbol is not transferred and must exist for the lifetime of the widget.

Definition at line 232 of file qgssymbolselectordialog.cpp.

Member Function Documentation

◆ addLayer

void QgsSymbolSelectorWidget::addLayer ( )
slot

Add a symbol layer to the bottom of the stack.

Definition at line 582 of file qgssymbolselectordialog.cpp.

◆ advancedMenu()

QMenu * QgsSymbolSelectorWidget::advancedMenu ( )

Returns menu for "advanced" button - create it if doesn't exist and show the advanced button.

Definition at line 344 of file qgssymbolselectordialog.cpp.

◆ changeLayer

void QgsSymbolSelectorWidget::changeLayer ( QgsSymbolLayer layer)
slot

alters tree and sets proper widget when Layer Type is changed

Note
: The layer is received from the LayerPropertiesWidget

Definition at line 736 of file qgssymbolselectordialog.cpp.

◆ context()

QgsSymbolWidgetContext QgsSymbolSelectorWidget::context ( ) const

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

See also
setContext()
Since
QGIS 3.0

Definition at line 381 of file qgssymbolselectordialog.cpp.

◆ duplicateLayer

void QgsSymbolSelectorWidget::duplicateLayer ( )
slot

Duplicates the current symbol layer and places the duplicated layer above the current symbol layer.

Since
QGIS 2.14

Definition at line 699 of file qgssymbolselectordialog.cpp.

◆ layerChanged

void QgsSymbolSelectorWidget::layerChanged ( )
slot

Called when the layer changes in the widget.

Updates the active properties for active symbol layer.

Definition at line 496 of file qgssymbolselectordialog.cpp.

◆ loadSymbol()

void QgsSymbolSelectorWidget::loadSymbol ( QgsSymbol symbol,
SymbolLayerItem *  parent = nullptr 
)

Loads the given symbol into the widget.

Parameters
symbolThe symbol to load.
parentThe parent symbol layer item. If the parent parameter is null, the whole symbol and model will be reset.
Note
The ownership of the symbol is not transferred and must exist for the lifetime of the widget.

Definition at line 386 of file qgssymbolselectordialog.cpp.

◆ lockLayer

void QgsSymbolSelectorWidget::lockLayer ( )
slot

Lock the current active symbol layer.

Definition at line 690 of file qgssymbolselectordialog.cpp.

◆ moveLayerDown

void QgsSymbolSelectorWidget::moveLayerDown ( )
slot

Move the active symbol layer down.

Definition at line 654 of file qgssymbolselectordialog.cpp.

◆ moveLayerUp

void QgsSymbolSelectorWidget::moveLayerUp ( )
slot

Move the active symbol layer up.

Definition at line 659 of file qgssymbolselectordialog.cpp.

◆ removeLayer

void QgsSymbolSelectorWidget::removeLayer ( )
slot

Remove the current active symbol layer.

Definition at line 632 of file qgssymbolselectordialog.cpp.

◆ setContext()

void QgsSymbolSelectorWidget::setContext ( const QgsSymbolWidgetContext context)

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

Parameters
contextsymbol widget context
See also
context()
Since
QGIS 3.0

Definition at line 355 of file qgssymbolselectordialog.cpp.

◆ symbol()

QgsSymbol* QgsSymbolSelectorWidget::symbol ( )
inline

Returns the symbol that is currently active in the widget.

Can be nullptr.

Returns
The active symbol.

Definition at line 129 of file qgssymbolselectordialog.h.

◆ symbolChanged

void QgsSymbolSelectorWidget::symbolChanged ( )
slot

Slot to update tree when a new symbol from style.

Definition at line 536 of file qgssymbolselectordialog.cpp.

◆ symbolModified

void QgsSymbolSelectorWidget::symbolModified ( )
signal

Emiited when a symbol is modified in the widget.

◆ updateLayerPreview

void QgsSymbolSelectorWidget::updateLayerPreview ( )
slot

Update the single symbol layer preview in the widget.

Definition at line 460 of file qgssymbolselectordialog.cpp.

◆ updatePreview

void QgsSymbolSelectorWidget::updatePreview ( )
slot

Update the preview of the whole symbol in the interface.

Definition at line 450 of file qgssymbolselectordialog.cpp.

Friends And Related Function Documentation

◆ QgsSymbolSelectorDialog

friend class QgsSymbolSelectorDialog
friend

To allow for non API break access from the dialog.

Definition at line 91 of file qgssymbolselectordialog.h.


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