QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsSvgSelectorWidget Class Reference

A widget allowing selection of an SVG file, and configuration of SVG related parameters. More...

#include <qgssvgselectorwidget.h>

Inheritance diagram for QgsSvgSelectorWidget:
Inheritance graph
[legend]

Public Slots

void setSvgParameters (const QMap< QString, QgsProperty > &parameters)
 Sets the dynamic parameters.
 
void setSvgPath (const QString &svgPath)
 Accepts absolute paths.
 

Signals

void svgParametersChanged (const QMap< QString, QgsProperty > &parameters)
 Emitted when the parameters have changed.
 
void svgSelected (const QString &path)
 Emitted when an SVG is selected in the widget.
 

Public Member Functions

 QgsSvgSelectorWidget (QWidget *parent=nullptr)
 Constructor for QgsSvgSelectorWidget.
 
Q_DECL_DEPRECATED bool allowParamerters () const
 Returns if the group box to fill parameters is visible.
 
bool allowParameters () const
 Returns if the group box to fill parameters is visible.
 
bool browserVisible () const
 Returns if the SVG browser should be visible.
 
QString currentSvgPath () const
 
void initParametersModel (const QgsExpressionContextGenerator *generator, QgsVectorLayer *layer=nullptr)
 Initialize the parameters model so the context and the layer are referenced.
 
QgsPropertyOverrideButtonpropertyOverrideToolButton () const
 Returns the property override tool button of the file line edit.
 
void setAllowParameters (bool allow)
 Defines if the group box to fill parameters is visible.
 
void setBrowserVisible (bool visible)
 Defines if the SVG browser should be visible.
 
QgsPictureSourceLineEditBasesourceLineEdit () const
 Returns the source line edit.
 

Protected Member Functions

void populateList ()
 

Detailed Description

A widget allowing selection of an SVG file, and configuration of SVG related parameters.

Definition at line 380 of file qgssvgselectorwidget.h.

Constructor & Destructor Documentation

◆ QgsSvgSelectorWidget()

QgsSvgSelectorWidget::QgsSvgSelectorWidget ( QWidget *  parent = nullptr)

Constructor for QgsSvgSelectorWidget.

Definition at line 390 of file qgssvgselectorwidget.cpp.

Member Function Documentation

◆ allowParamerters()

Q_DECL_DEPRECATED bool QgsSvgSelectorWidget::allowParamerters ( ) const
inline

Returns if the group box to fill parameters is visible.

Since
QGIS 3.18
Deprecated:
QGIS 3.40. Use allowParameters().

Definition at line 414 of file qgssvgselectorwidget.h.

◆ allowParameters()

bool QgsSvgSelectorWidget::allowParameters ( ) const
inline

Returns if the group box to fill parameters is visible.

Since
QGIS 3.38

Definition at line 420 of file qgssvgselectorwidget.h.

◆ browserVisible()

bool QgsSvgSelectorWidget::browserVisible ( ) const
inline

Returns if the SVG browser should be visible.

Since
QGIS 3.20

Definition at line 432 of file qgssvgselectorwidget.h.

◆ currentSvgPath()

QString QgsSvgSelectorWidget::currentSvgPath ( ) const

Definition at line 474 of file qgssvgselectorwidget.cpp.

◆ initParametersModel()

void QgsSvgSelectorWidget::initParametersModel ( const QgsExpressionContextGenerator generator,
QgsVectorLayer layer = nullptr 
)

Initialize the parameters model so the context and the layer are referenced.

Since
QGIS 3.18

Definition at line 440 of file qgssvgselectorwidget.cpp.

◆ populateList()

void QgsSvgSelectorWidget::populateList ( )
protected

Definition at line 537 of file qgssvgselectorwidget.cpp.

◆ propertyOverrideToolButton()

QgsPropertyOverrideButton * QgsSvgSelectorWidget::propertyOverrideToolButton ( ) const

Returns the property override tool button of the file line edit.

Since
QGIS 3.20

Definition at line 497 of file qgssvgselectorwidget.cpp.

◆ setAllowParameters()

void QgsSvgSelectorWidget::setAllowParameters ( bool  allow)

Defines if the group box to fill parameters is visible.

Since
QGIS 3.18

Definition at line 479 of file qgssvgselectorwidget.cpp.

◆ setBrowserVisible()

void QgsSvgSelectorWidget::setBrowserVisible ( bool  visible)

Defines if the SVG browser should be visible.

Since
QGIS 3.20

Definition at line 488 of file qgssvgselectorwidget.cpp.

◆ setSvgParameters

void QgsSvgSelectorWidget::setSvgParameters ( const QMap< QString, QgsProperty > &  parameters)
slot

Sets the dynamic parameters.

Since
QGIS 3.18

Definition at line 469 of file qgssvgselectorwidget.cpp.

◆ setSvgPath

void QgsSvgSelectorWidget::setSvgPath ( const QString &  svgPath)
slot

Accepts absolute paths.

Definition at line 446 of file qgssvgselectorwidget.cpp.

◆ sourceLineEdit()

QgsPictureSourceLineEditBase * QgsSvgSelectorWidget::sourceLineEdit ( ) const
inline

Returns the source line edit.

Since
QGIS 3.16

Definition at line 401 of file qgssvgselectorwidget.h.

◆ svgParametersChanged

void QgsSvgSelectorWidget::svgParametersChanged ( const QMap< QString, QgsProperty > &  parameters)
signal

Emitted when the parameters have changed.

Since
QGIS 3.18

◆ svgSelected

void QgsSvgSelectorWidget::svgSelected ( const QString &  path)
signal

Emitted when an SVG is selected in the widget.


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