QGIS API Documentation 3.29.0-Master (ade4f0cf0f)
Public Types | Public Member Functions | List of all members
QgsProjectStyleDatabaseModel Class Reference

List model representing the style databases associated with a QgsProject. More...

#include <qgsprojectstylesettings.h>

Inheritance diagram for QgsProjectStyleDatabaseModel:
Inheritance graph
[legend]

Public Types

enum  Role { StyleRole = Qt::UserRole + 1 , PathRole }
 Custom model roles. More...
 

Public Member Functions

 QgsProjectStyleDatabaseModel (QgsProjectStyleSettings *settings, QObject *parent SIP_TRANSFERTHIS=nullptr)
 Constructor for QgsProjectStyleDatabaseModel, showing the styles from the specified settings. More...
 
QVariant data (const QModelIndex &index, int role) const override
 
QModelIndex indexFromStyle (QgsStyle *style) const
 Returns the model index corresponding to a style. More...
 
int rowCount (const QModelIndex &parent) const override
 
void setShowDefaultStyle (bool show)
 Sets whether the default style should also be included in the model. More...
 
bool showDefaultStyle () const
 Returns true if the model includes the default style. More...
 
QgsStylestyleFromIndex (const QModelIndex &index) const
 Returns the style at the corresponding index. More...
 

Detailed Description

List model representing the style databases associated with a QgsProject.

Since
QGIS 3.26

Definition at line 292 of file qgsprojectstylesettings.h.

Member Enumeration Documentation

◆ Role

Custom model roles.

Enumerator
StyleRole 

Style object.

PathRole 

Style path.

Definition at line 299 of file qgsprojectstylesettings.h.

Constructor & Destructor Documentation

◆ QgsProjectStyleDatabaseModel()

QgsProjectStyleDatabaseModel::QgsProjectStyleDatabaseModel ( QgsProjectStyleSettings settings,
QObject *parent  SIP_TRANSFERTHIS = nullptr 
)
explicit

Constructor for QgsProjectStyleDatabaseModel, showing the styles from the specified settings.

Definition at line 440 of file qgsprojectstylesettings.cpp.

Member Function Documentation

◆ data()

QVariant QgsProjectStyleDatabaseModel::data ( const QModelIndex &  index,
int  role 
) const
override

Definition at line 460 of file qgsprojectstylesettings.cpp.

◆ indexFromStyle()

QModelIndex QgsProjectStyleDatabaseModel::indexFromStyle ( QgsStyle style) const

Returns the model index corresponding to a style.

See also
styleFromIndex()

Definition at line 525 of file qgsprojectstylesettings.cpp.

◆ rowCount()

int QgsProjectStyleDatabaseModel::rowCount ( const QModelIndex &  parent) const
override

Definition at line 454 of file qgsprojectstylesettings.cpp.

◆ setShowDefaultStyle()

void QgsProjectStyleDatabaseModel::setShowDefaultStyle ( bool  show)

Sets whether the default style should also be included in the model.

See also
showDefaultStyle()

Definition at line 550 of file qgsprojectstylesettings.cpp.

◆ showDefaultStyle()

bool QgsProjectStyleDatabaseModel::showDefaultStyle ( ) const
inline

Returns true if the model includes the default style.

See also
setShowDefaultStyle()

Definition at line 337 of file qgsprojectstylesettings.h.

◆ styleFromIndex()

QgsStyle * QgsProjectStyleDatabaseModel::styleFromIndex ( const QModelIndex &  index) const

Returns the style at the corresponding index.

See also
indexFromStyle()

Definition at line 513 of file qgsprojectstylesettings.cpp.


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