QGIS API Documentation  3.3.0-Master (c515a66)
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsSymbolSelectorDialog Class Reference

#include <qgssymbolselectordialog.h>

Inheritance diagram for QgsSymbolSelectorDialog:
Inheritance graph
[legend]

Public Slots

void addLayer ()
 
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 ()
 
void lockLayer ()
 
void moveLayerDown ()
 
void moveLayerUp ()
 
void removeLayer ()
 
void symbolChanged ()
 Slot to update tree when a new symbol from style. More...
 
void updateLayerPreview ()
 
void updatePreview ()
 

Signals

void symbolModified ()
 

Public Member Functions

 QgsSymbolSelectorDialog (QgsSymbol *symbol, QgsStyle *style, QgsVectorLayer *vl, QWidget *parent=nullptr, bool embedded=false)
 Constructor for QgsSymbolSelectorDialog. More...
 
 ~QgsSymbolSelectorDialog () override
 
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 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...
 

Protected Member Functions

QgsSymbolLayercurrentLayer ()
 
SymbolLayerItem * currentLayerItem ()
 
void keyPressEvent (QKeyEvent *e) override
 
void loadSymbol ()
 
void loadSymbol (QgsSymbol *symbol, SymbolLayerItem *parent)
 
void moveLayerByOffset (int offset)
 
void setWidget (QWidget *widget)
 
void updateLockButton ()
 
void updateUi ()
 

Detailed Description

Definition at line 264 of file qgssymbolselectordialog.h.

Constructor & Destructor Documentation

◆ QgsSymbolSelectorDialog()

QgsSymbolSelectorDialog::QgsSymbolSelectorDialog ( QgsSymbol symbol,
QgsStyle style,
QgsVectorLayer vl,
QWidget *  parent = nullptr,
bool  embedded = false 
)

Constructor for QgsSymbolSelectorDialog.

Parameters
symbolThe symbol
styleThe style
vlAssociated vector layer
parentParent widget
embeddedTrue to embed in renderer properties dialog, false otherwise

Definition at line 711 of file qgssymbolselectordialog.cpp.

◆ ~QgsSymbolSelectorDialog()

QgsSymbolSelectorDialog::~QgsSymbolSelectorDialog ( )
override

Definition at line 741 of file qgssymbolselectordialog.cpp.

Member Function Documentation

◆ addLayer

void QgsSymbolSelectorDialog::addLayer ( )
slot

Definition at line 830 of file qgssymbolselectordialog.cpp.

◆ advancedMenu()

QMenu * QgsSymbolSelectorDialog::advancedMenu ( )

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

Definition at line 747 of file qgssymbolselectordialog.cpp.

◆ changeLayer

void QgsSymbolSelectorDialog::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 870 of file qgssymbolselectordialog.cpp.

◆ context()

QgsSymbolWidgetContext QgsSymbolSelectorDialog::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 757 of file qgssymbolselectordialog.cpp.

◆ currentLayer()

QgsSymbolLayer * QgsSymbolSelectorDialog::currentLayer ( )
protected

Definition at line 805 of file qgssymbolselectordialog.cpp.

◆ currentLayerItem()

SymbolLayerItem * QgsSymbolSelectorDialog::currentLayerItem ( )
protected
Note
not available in Python bindings

Definition at line 800 of file qgssymbolselectordialog.cpp.

◆ duplicateLayer

void QgsSymbolSelectorDialog::duplicateLayer ( )
slot

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

Since
QGIS 2.14

Definition at line 845 of file qgssymbolselectordialog.cpp.

◆ keyPressEvent()

void QgsSymbolSelectorDialog::keyPressEvent ( QKeyEvent *  e)
overrideprotected

Definition at line 767 of file qgssymbolselectordialog.cpp.

◆ layerChanged

void QgsSymbolSelectorDialog::layerChanged ( )
slot

Definition at line 850 of file qgssymbolselectordialog.cpp.

◆ loadSymbol() [1/2]

void QgsSymbolSelectorDialog::loadSymbol ( )
protected

Definition at line 780 of file qgssymbolselectordialog.cpp.

◆ loadSymbol() [2/2]

void QgsSymbolSelectorDialog::loadSymbol ( QgsSymbol symbol,
SymbolLayerItem *  parent 
)
protected
Note
not available in Python bindings

Definition at line 785 of file qgssymbolselectordialog.cpp.

◆ lockLayer

void QgsSymbolSelectorDialog::lockLayer ( )
slot

Definition at line 840 of file qgssymbolselectordialog.cpp.

◆ moveLayerByOffset()

void QgsSymbolSelectorDialog::moveLayerByOffset ( int  offset)
protected

Definition at line 810 of file qgssymbolselectordialog.cpp.

◆ moveLayerDown

void QgsSymbolSelectorDialog::moveLayerDown ( )
slot

Definition at line 820 of file qgssymbolselectordialog.cpp.

◆ moveLayerUp

void QgsSymbolSelectorDialog::moveLayerUp ( )
slot

Definition at line 825 of file qgssymbolselectordialog.cpp.

◆ removeLayer

void QgsSymbolSelectorDialog::removeLayer ( )
slot

Definition at line 835 of file qgssymbolselectordialog.cpp.

◆ setContext()

void QgsSymbolSelectorDialog::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 752 of file qgssymbolselectordialog.cpp.

◆ setWidget()

void QgsSymbolSelectorDialog::setWidget ( QWidget *  widget)
protected

Definition at line 815 of file qgssymbolselectordialog.cpp.

◆ symbol()

QgsSymbol * QgsSymbolSelectorDialog::symbol ( )

Returns the symbol that is currently active in the widget.

Can be null.

Returns
The active symbol.

Definition at line 762 of file qgssymbolselectordialog.cpp.

◆ symbolChanged

void QgsSymbolSelectorDialog::symbolChanged ( )
slot

Slot to update tree when a new symbol from style.

Definition at line 865 of file qgssymbolselectordialog.cpp.

◆ symbolModified

void QgsSymbolSelectorDialog::symbolModified ( )
signal

◆ updateLayerPreview

void QgsSymbolSelectorDialog::updateLayerPreview ( )
slot

Definition at line 855 of file qgssymbolselectordialog.cpp.

◆ updateLockButton()

void QgsSymbolSelectorDialog::updateLockButton ( )
protected

Definition at line 795 of file qgssymbolselectordialog.cpp.

◆ updatePreview

void QgsSymbolSelectorDialog::updatePreview ( )
slot

Definition at line 860 of file qgssymbolselectordialog.cpp.

◆ updateUi()

void QgsSymbolSelectorDialog::updateUi ( )
protected

Definition at line 790 of file qgssymbolselectordialog.cpp.


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