QGIS API Documentation  3.17.0-Master (8af46bc54f)
Public Slots | Public Member Functions | List of all members
QgsMapLayerLoadStyleDialog Class Reference

A reusable dialog which allows users to select stored layer styles and categories to load for a map layer. More...

#include <qgsmaplayerloadstyledialog.h>

Inheritance diagram for QgsMapLayerLoadStyleDialog:
Inheritance graph
[legend]

Public Slots

void accept () override
 

Public Member Functions

 QgsMapLayerLoadStyleDialog (QgsMapLayer *layer, QWidget *parent=nullptr)
 Constructor for QgsMapLayerLoadStyleDialog, associated with the specified map layer. More...
 
QgsVectorLayerProperties::StyleType currentStyleType () const
 Returns the selected vector style type, for vector layers only. More...
 
QString fileExtension () const
 Returns the file extension for the selected layer style source file. More...
 
QString filePath () const
 Returns the full path to the selected layer style source file. More...
 
void initializeLists (const QStringList &ids, const QStringList &names, const QStringList &descriptions, int sectionLimit)
 Initialize list of database stored styles. More...
 
QString selectedStyleId ()
 Returns the ID of the selected database stored style. More...
 
QgsMapLayer::StyleCategories styleCategories () const
 Returns the list of selected style categories the user has opted to load. More...
 

Detailed Description

A reusable dialog which allows users to select stored layer styles and categories to load for a map layer.

Currently supports

Since
QGIS 3.16

Definition at line 42 of file qgsmaplayerloadstyledialog.h.

Constructor & Destructor Documentation

◆ QgsMapLayerLoadStyleDialog()

QgsMapLayerLoadStyleDialog::QgsMapLayerLoadStyleDialog ( QgsMapLayer layer,
QWidget *  parent = nullptr 
)
explicit

Constructor for QgsMapLayerLoadStyleDialog, associated with the specified map layer.

Definition at line 29 of file qgsmaplayerloadstyledialog.cpp.

Member Function Documentation

◆ accept

void QgsMapLayerLoadStyleDialog::accept ( )
overrideslot

Definition at line 288 of file qgsmaplayerloadstyledialog.cpp.

◆ currentStyleType()

QgsVectorLayerProperties::StyleType QgsMapLayerLoadStyleDialog::currentStyleType ( ) const

Returns the selected vector style type, for vector layers only.

Definition at line 167 of file qgsmaplayerloadstyledialog.cpp.

◆ fileExtension()

QString QgsMapLayerLoadStyleDialog::fileExtension ( ) const

Returns the file extension for the selected layer style source file.

See also
filePath()

Definition at line 179 of file qgsmaplayerloadstyledialog.cpp.

◆ filePath()

QString QgsMapLayerLoadStyleDialog::filePath ( ) const

Returns the full path to the selected layer style source file.

See also
fileExtension()

Definition at line 184 of file qgsmaplayerloadstyledialog.cpp.

◆ initializeLists()

void QgsMapLayerLoadStyleDialog::initializeLists ( const QStringList &  ids,
const QStringList &  names,
const QStringList &  descriptions,
int  sectionLimit 
)

Initialize list of database stored styles.

Definition at line 189 of file qgsmaplayerloadstyledialog.cpp.

◆ selectedStyleId()

QString QgsMapLayerLoadStyleDialog::selectedStyleId ( )

Returns the ID of the selected database stored style.

Definition at line 229 of file qgsmaplayerloadstyledialog.cpp.

◆ styleCategories()

QgsMapLayer::StyleCategories QgsMapLayerLoadStyleDialog::styleCategories ( ) const

Returns the list of selected style categories the user has opted to load.

Definition at line 162 of file qgsmaplayerloadstyledialog.cpp.


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