mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
1073 lines
26 KiB
Plaintext
1073 lines
26 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/symbology/qgsstyle.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
typedef QMap<QString, QgsColorRamp * > QgsVectorColorRampMap;
|
|
typedef QMap<int, QString> QgsSymbolGroupMap;
|
|
|
|
typedef QMap<QString, QgsTextFormat > QgsTextFormatMap;
|
|
|
|
typedef QMap<QString, QgsPalLayerSettings > QgsLabelSettingsMap;
|
|
|
|
|
|
typedef QMultiMap<QString, QString> QgsSmartConditionMap;
|
|
|
|
|
|
enum SymbolTable
|
|
{
|
|
SymbolId,
|
|
SymbolName,
|
|
SymbolXML,
|
|
SymbolFavoriteId,
|
|
};
|
|
|
|
enum TagTable
|
|
{
|
|
TagId,
|
|
TagName,
|
|
};
|
|
|
|
enum TagmapTable
|
|
{
|
|
TagmapTagId,
|
|
TagmapSymbolId,
|
|
};
|
|
|
|
enum ColorrampTable
|
|
{
|
|
ColorrampId,
|
|
ColorrampName,
|
|
ColorrampXML,
|
|
ColorrampFavoriteId,
|
|
};
|
|
|
|
enum TextFormatTable
|
|
{
|
|
TextFormatId,
|
|
TextFormatName,
|
|
TextFormatXML,
|
|
TextFormatFavoriteId,
|
|
};
|
|
|
|
enum LabelSettingsTable
|
|
{
|
|
LabelSettingsId,
|
|
LabelSettingsName,
|
|
LabelSettingsXML,
|
|
LabelSettingsFavoriteId,
|
|
};
|
|
|
|
enum SmartgroupTable
|
|
{
|
|
SmartgroupId,
|
|
SmartgroupName,
|
|
SmartgroupXML,
|
|
};
|
|
|
|
class QgsStyle : QObject
|
|
{
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsstyle.h"
|
|
%End
|
|
public:
|
|
|
|
QgsStyle();
|
|
%Docstring
|
|
Constructor for QgsStyle.
|
|
%End
|
|
~QgsStyle();
|
|
|
|
enum StyleEntity
|
|
{
|
|
SymbolEntity,
|
|
TagEntity,
|
|
ColorrampEntity,
|
|
SmartgroupEntity,
|
|
TextFormatEntity,
|
|
LabelSettingsEntity,
|
|
};
|
|
|
|
bool addEntity( const QString &name, const QgsStyleEntityInterface *entity, bool update = false );
|
|
%Docstring
|
|
Adds an ``entity`` to the style, with the specified ``name``. Ownership is not transferred.
|
|
|
|
If ``update`` is ``True`` then the style database is updated automatically as a result.
|
|
|
|
Returns ``True`` if the add operation was successful.
|
|
|
|
.. note::
|
|
|
|
Adding an entity with the name of existing one replaces the existing one automatically.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
bool addSymbol( const QString &name, QgsSymbol *symbol /Transfer/, bool update = false );
|
|
%Docstring
|
|
Adds a symbol to style and takes symbol's ownership
|
|
|
|
.. note::
|
|
|
|
Adding a symbol with the name of existing one replaces it.
|
|
|
|
:param name: is the name of the symbol being added or updated
|
|
:param symbol: is the Vector symbol
|
|
:param update: set to ``True`` when the style DB has to be updated, by default it is ``False``
|
|
|
|
:return: success status of the operation
|
|
%End
|
|
|
|
bool addColorRamp( const QString &name, QgsColorRamp *colorRamp /Transfer/, bool update = false );
|
|
%Docstring
|
|
Adds a color ramp to the style. Calling this method takes the ramp's ownership.
|
|
|
|
.. note::
|
|
|
|
Adding a color ramp with the name of existing one replaces it.
|
|
|
|
:param name: is the name of the color ramp being added or updated
|
|
:param colorRamp: is the color ramp. Ownership is transferred.
|
|
:param update: set to ``True`` when the style DB has to be updated, by default it is ``False``
|
|
|
|
:return: success status of the operation
|
|
%End
|
|
|
|
bool addTextFormat( const QString &name, const QgsTextFormat &format, bool update = false );
|
|
%Docstring
|
|
Adds a text ``format`` with the specified ``name`` to the style.
|
|
|
|
If ``update`` is set to ``True``, the style DB will be automatically updated with the new text format.
|
|
|
|
Returns ``True`` if the operation was successful.
|
|
|
|
.. note::
|
|
|
|
Adding a text format with the name of existing one replaces it.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
bool addLabelSettings( const QString &name, const QgsPalLayerSettings &settings, bool update = false );
|
|
%Docstring
|
|
Adds label ``settings`` with the specified ``name`` to the style.
|
|
|
|
If ``update`` is set to ``True``, the style DB will be automatically updated with the new text format.
|
|
|
|
Returns ``True`` if the operation was successful.
|
|
|
|
.. note::
|
|
|
|
Adding label settings with the name of existing ones replaces them.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
int addTag( const QString &tagName );
|
|
%Docstring
|
|
Adds a new tag and returns the tag's id
|
|
|
|
:param tagName: the name of the new tag to be created
|
|
|
|
:return: returns an int, which is the DB id of the new tag created, 0 if the tag couldn't be created
|
|
%End
|
|
|
|
|
|
int addSmartgroup( const QString &name, const QString &op, const QStringList &matchTag, const QStringList &noMatchTag,
|
|
const QStringList &matchName, const QStringList &noMatchName );
|
|
%Docstring
|
|
Adds a new smartgroup to the database and returns the id.
|
|
|
|
:param name: is the name of the new Smart Group to be added
|
|
:param op: is the operator between the conditions; AND/OR as QString
|
|
:param matchTag: list of strings to match within tags
|
|
:param noMatchTag: list of strings to exclude matches from tags
|
|
:param matchName: list of string to match within names
|
|
:param noMatchName: list of strings to exclude matches from names
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
QStringList tags() const;
|
|
%Docstring
|
|
Returns a list of all tags in the style database
|
|
|
|
.. seealso:: :py:func:`addTag`
|
|
|
|
.. versionadded:: 2.16
|
|
%End
|
|
|
|
void clear();
|
|
%Docstring
|
|
Removes all contents of the style
|
|
%End
|
|
|
|
QgsColorRamp *colorRamp( const QString &name ) const /Factory/;
|
|
%Docstring
|
|
Returns a new copy of the specified color ramp. The caller
|
|
takes responsibility for deleting the returned object.
|
|
%End
|
|
|
|
int colorRampCount();
|
|
%Docstring
|
|
Returns count of color ramps
|
|
%End
|
|
|
|
QStringList colorRampNames() const;
|
|
%Docstring
|
|
Returns a list of names of color ramps
|
|
%End
|
|
|
|
const QgsColorRamp *colorRampRef( const QString &name ) const;
|
|
%Docstring
|
|
Returns a const pointer to a symbol (doesn't create new instance)
|
|
%End
|
|
|
|
int colorrampId( const QString &name );
|
|
%Docstring
|
|
Returns the id in the style database for the given colorramp name
|
|
returns 0 if not found
|
|
%End
|
|
|
|
QgsTextFormat textFormat( const QString &name ) const;
|
|
%Docstring
|
|
Returns the text format with the specified ``name``.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
int textFormatCount() const;
|
|
%Docstring
|
|
Returns count of text formats in the style.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
QStringList textFormatNames() const;
|
|
%Docstring
|
|
Returns a list of names of text formats in the style.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
int textFormatId( const QString &name );
|
|
%Docstring
|
|
Returns the ID in the style database for the given text format by ``name``.
|
|
Returns 0 if the text format was not found.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
QgsPalLayerSettings labelSettings( const QString &name ) const;
|
|
%Docstring
|
|
Returns the label settings with the specified ``name``.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
QgsWkbTypes::GeometryType labelSettingsLayerType( const QString &name ) const;
|
|
%Docstring
|
|
Returns the layer geometry type corresponding to the label settings
|
|
with the specified ``name``, or QgsWkbTypes.UnknownGeometry
|
|
if matching label settings are not present.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
int labelSettingsCount() const;
|
|
%Docstring
|
|
Returns count of label settings in the style.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
QStringList labelSettingsNames() const;
|
|
%Docstring
|
|
Returns a list of names of label settings in the style.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
int labelSettingsId( const QString &name );
|
|
%Docstring
|
|
Returns the ID in the style database for the given label settings by ``name``.
|
|
Returns 0 if the label settings were not found.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
static QgsStyle *defaultStyle();
|
|
%Docstring
|
|
Returns default application-wide style
|
|
%End
|
|
|
|
|
|
bool tagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags );
|
|
%Docstring
|
|
Tags the symbol with the tags in the list
|
|
|
|
Applies the given tags to the given symbol or colorramp
|
|
|
|
:param type: is either SymbolEntity or ColorrampEntity
|
|
:param symbol: is the name of the symbol or colorramp as QString
|
|
:param tags: is the list of the tags that are to be applied as QStringList
|
|
|
|
:return: returns the success state of the operation
|
|
%End
|
|
|
|
bool detagSymbol( StyleEntity type, const QString &symbol, const QStringList &tags );
|
|
%Docstring
|
|
Detags the symbol with the given list
|
|
|
|
Removes the given tags for the specified symbol or colorramp
|
|
|
|
:param type: is either SymbolEntity or ColorrampEntity
|
|
:param symbol: is the name of the symbol or colorramp
|
|
:param tags: is the list of tags that are to be removed as QStringList
|
|
|
|
:return: returns the success state of the operation
|
|
%End
|
|
|
|
bool detagSymbol( StyleEntity type, const QString &symbol );
|
|
%Docstring
|
|
Clears the symbol from all attached tags
|
|
|
|
Removes all tags for the specified symbol or colorramp
|
|
|
|
:param type: is either SymbolEntity or ColorrampEntity
|
|
:param symbol: is the name of the symbol or colorramp
|
|
|
|
:return: returns the success state of the operation
|
|
%End
|
|
|
|
bool removeSymbol( const QString &name );
|
|
%Docstring
|
|
Removes symbol from style (and delete it)
|
|
%End
|
|
|
|
bool renameSymbol( const QString &oldName, const QString &newName );
|
|
%Docstring
|
|
Renames a symbol from ``oldName`` to ``newName``.
|
|
|
|
Returns ``True`` if symbol was successfully renamed.
|
|
%End
|
|
|
|
QgsSymbol *symbol( const QString &name ) /Factory/;
|
|
%Docstring
|
|
Returns a NEW copy of symbol
|
|
%End
|
|
|
|
const QgsSymbol *symbolRef( const QString &name ) const;
|
|
%Docstring
|
|
Returns a const pointer to a symbol (doesn't create new instance)
|
|
%End
|
|
|
|
int symbolCount();
|
|
%Docstring
|
|
Returns count of symbols in style
|
|
%End
|
|
|
|
QStringList symbolNames() const;
|
|
%Docstring
|
|
Returns a list of names of symbols
|
|
%End
|
|
|
|
int symbolId( const QString &name );
|
|
%Docstring
|
|
Returns the id in the style database for the given symbol name
|
|
returns 0 if not found
|
|
%End
|
|
int tagId( const QString &tag );
|
|
%Docstring
|
|
Returns the DB id for the given tag name
|
|
%End
|
|
int smartgroupId( const QString &smartgroup );
|
|
%Docstring
|
|
Returns the DB id for the given smartgroup name
|
|
%End
|
|
|
|
QStringList allNames( StyleEntity type ) const;
|
|
%Docstring
|
|
Returns a list of the names of all existing entities of the specified ``type``.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
QStringList symbolsOfFavorite( StyleEntity type ) const;
|
|
%Docstring
|
|
Returns the symbol names which are flagged as favorite
|
|
|
|
:param type: is either SymbolEntity or ColorampEntity
|
|
|
|
:return: A QStringList of the symbol or colorramp names flagged as favorite
|
|
%End
|
|
|
|
QStringList symbolsWithTag( StyleEntity type, int tagid ) const;
|
|
%Docstring
|
|
Returns the symbol names with which have the given tag
|
|
|
|
:param type: is either SymbolEntity or ColorampEntity
|
|
:param tagid: is id of the tag which has been applied over the symbol as int
|
|
|
|
:return: A QStringList of the symbol or colorramp names for the given tag id
|
|
%End
|
|
|
|
bool addFavorite( StyleEntity type, const QString &name );
|
|
%Docstring
|
|
Adds the specified symbol to favorites
|
|
|
|
:param type: is either SymbolEntity of ColorrampEntity
|
|
:param name: is the name of the symbol or coloramp whose is to be added to favorites
|
|
|
|
:return: returns the success state as bool
|
|
%End
|
|
|
|
bool removeFavorite( StyleEntity type, const QString &name );
|
|
%Docstring
|
|
Removes the specified symbol from favorites
|
|
|
|
:param type: is either SymbolEntity of ColorrampEntity
|
|
:param name: is the name of the symbol or coloramp whose is to be removed from favorites
|
|
|
|
:return: returns the success state as bool
|
|
%End
|
|
|
|
bool rename( StyleEntity type, int id, const QString &newName );
|
|
%Docstring
|
|
Renames the given entity with the specified id
|
|
|
|
:param type: is any of the style entities. Refer enum StyleEntity.
|
|
:param id: is the DB id of the entity which is to be renamed
|
|
:param newName: is the new name of the entity
|
|
%End
|
|
|
|
bool remove( StyleEntity type, int id );
|
|
%Docstring
|
|
Removes the specified entity from the db
|
|
|
|
:param type: is any of the style entities. Refer enum StyleEntity.
|
|
:param id: is the DB id of the entity to be removed
|
|
%End
|
|
|
|
bool saveSymbol( const QString &name, QgsSymbol *symbol, bool favorite, const QStringList &tags );
|
|
%Docstring
|
|
Adds the symbol to the DB with the tags
|
|
|
|
:param name: is the name of the symbol as QString
|
|
:param symbol: is the pointer to the new QgsSymbol being saved
|
|
:param favorite: is a boolean value to specify whether the symbol should be added to favorites
|
|
:param tags: is a list of tags that are associated with the symbol as a QStringList.
|
|
|
|
:return: returns the success state of the save operation
|
|
%End
|
|
|
|
bool saveColorRamp( const QString &name, QgsColorRamp *ramp, bool favorite, const QStringList &tags );
|
|
%Docstring
|
|
Adds the colorramp to the DB
|
|
|
|
:param name: is the name of the colorramp as QString
|
|
:param ramp: is the pointer to the new QgsColorRamp being saved
|
|
:param favorite: is a boolean value to specify whether the colorramp should be added to favorites
|
|
:param tags: is a list of tags that are associated with the color ramp as a QStringList.
|
|
|
|
:return: returns the success state of the save operation
|
|
%End
|
|
|
|
bool removeColorRamp( const QString &name );
|
|
%Docstring
|
|
Removes color ramp from style (and delete it)
|
|
%End
|
|
|
|
bool renameColorRamp( const QString &oldName, const QString &newName );
|
|
%Docstring
|
|
Changes ramp's name
|
|
%End
|
|
|
|
bool saveTextFormat( const QString &name, const QgsTextFormat &format, bool favorite, const QStringList &tags );
|
|
%Docstring
|
|
Adds a text ``format`` to the database.
|
|
|
|
:param name: is the name of the text format
|
|
:param format: text format to save
|
|
:param favorite: is a boolean value to specify whether the text format should be added to favorites
|
|
:param tags: is a list of tags that are associated with the text format
|
|
|
|
:return: returns the success state of the save operation
|
|
%End
|
|
|
|
bool removeTextFormat( const QString &name );
|
|
%Docstring
|
|
Removes a text format from the style.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
bool renameTextFormat( const QString &oldName, const QString &newName );
|
|
%Docstring
|
|
Changes a text format's name.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
bool saveLabelSettings( const QString &name, const QgsPalLayerSettings &settings, bool favorite, const QStringList &tags );
|
|
%Docstring
|
|
Adds label ``settings`` to the database.
|
|
|
|
:param name: is the name of the label settings
|
|
:param settings: label settings to save
|
|
:param favorite: is a boolean value to specify whether the label settings should be added to favorites
|
|
:param tags: is a list of tags that are associated with the label settings
|
|
|
|
:return: returns the success state of the save operation
|
|
%End
|
|
|
|
bool removeLabelSettings( const QString &name );
|
|
%Docstring
|
|
Removes label settings from the style.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
bool renameLabelSettings( const QString &oldName, const QString &newName );
|
|
%Docstring
|
|
Changes a label setting's name.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
bool createDatabase( const QString &filename );
|
|
%Docstring
|
|
Creates an on-disk database
|
|
|
|
This function creates a new on-disk permanent style database.
|
|
|
|
:return: returns the success state of the database creation
|
|
|
|
.. seealso:: :py:func:`createMemoryDatabase`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
bool createMemoryDatabase();
|
|
%Docstring
|
|
Creates a temporary memory database
|
|
|
|
This function is used to create a temporary style database in case a permanent on-disk database is not needed.
|
|
|
|
:return: returns the success state of the temporary memory database creation
|
|
|
|
.. seealso:: :py:func:`createDatabase`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
void createTables();
|
|
%Docstring
|
|
Creates tables structure for new database
|
|
|
|
This function is used to create the tables structure in a newly-created database.
|
|
|
|
:return: returns the success state of the temporary memory database creation
|
|
|
|
.. seealso:: :py:func:`createDatabase`
|
|
|
|
.. seealso:: :py:func:`createMemoryDatabase`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
bool load( const QString &filename );
|
|
%Docstring
|
|
Loads a file into the style
|
|
|
|
This function will load an on-disk database and populate styles.
|
|
|
|
:param filename: location of the database to load styles from
|
|
|
|
:return: returns the success state of the database being loaded
|
|
%End
|
|
|
|
bool save( QString filename = QString() );
|
|
%Docstring
|
|
Saves style into a file (will use current filename if empty string is passed)
|
|
%End
|
|
|
|
QString errorString();
|
|
%Docstring
|
|
Returns last error from load/save operation
|
|
%End
|
|
|
|
QString fileName();
|
|
%Docstring
|
|
Returns current file name of the style
|
|
%End
|
|
|
|
QStringList findSymbols( StyleEntity type, const QString &qword );
|
|
%Docstring
|
|
Returns the names of the symbols which have a matching 'substring' in its definition
|
|
|
|
:param type: is either SymbolEntity or ColorrampEntity
|
|
:param qword: is the query string to search the symbols or colorramps.
|
|
|
|
:return: A QStringList of the matched symbols or colorramps
|
|
%End
|
|
|
|
QStringList tagsOfSymbol( StyleEntity type, const QString &symbol );
|
|
%Docstring
|
|
Returns the tags associated with the symbol
|
|
|
|
:param type: is either SymbolEntity or ColorrampEntity
|
|
:param symbol: is the name of the symbol or color ramp
|
|
|
|
:return: A QStringList of the tags that have been applied to that symbol/colorramp
|
|
%End
|
|
|
|
bool isFavorite( StyleEntity type, const QString &name );
|
|
%Docstring
|
|
Returns ``True`` if the symbol with matching ``type`` and ``name`` is
|
|
marked as a favorite.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
bool symbolHasTag( StyleEntity type, const QString &symbol, const QString &tag );
|
|
%Docstring
|
|
Returns whether a given tag is associated with the symbol
|
|
|
|
:param type: is either SymbolEntity or ColorrampEntity
|
|
:param symbol: is the name of the symbol or color ramp
|
|
:param tag: the name of the tag to look for
|
|
|
|
:return: A boolean value identicating whether a tag was found attached to the symbol
|
|
%End
|
|
|
|
QString tag( int id ) const;
|
|
%Docstring
|
|
Returns the tag name for the given id
|
|
%End
|
|
|
|
QgsSymbolGroupMap smartgroupsListMap();
|
|
%Docstring
|
|
Returns the smart groups map with id as key and name as value
|
|
%End
|
|
|
|
QStringList smartgroupNames() const;
|
|
%Docstring
|
|
Returns the smart groups list
|
|
%End
|
|
|
|
QgsSmartConditionMap smartgroup( int id );
|
|
%Docstring
|
|
Returns the QgsSmartConditionMap for the given id
|
|
%End
|
|
|
|
QString smartgroupOperator( int id );
|
|
%Docstring
|
|
Returns the operator for the smartgroup
|
|
clumsy implementation TODO create a class for smartgroups
|
|
%End
|
|
|
|
QStringList symbolsOfSmartgroup( StyleEntity type, int id );
|
|
%Docstring
|
|
Returns the symbols for the smartgroup
|
|
%End
|
|
|
|
bool exportXml( const QString &filename );
|
|
%Docstring
|
|
Exports the style as a XML file
|
|
%End
|
|
|
|
bool importXml( const QString &filename );
|
|
%Docstring
|
|
Imports the symbols and colorramps into the default style database from the given XML file
|
|
%End
|
|
|
|
static bool isXmlStyleFile( const QString &path );
|
|
%Docstring
|
|
Tests if the file at ``path`` is a QGIS style XML file.
|
|
|
|
This method samples only the first line in the file, so is safe to call on
|
|
large xml files.
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
signals:
|
|
|
|
void symbolSaved( const QString &name, QgsSymbol *symbol );
|
|
%Docstring
|
|
Emitted every time a new symbol has been added to the database.
|
|
Emitted whenever a symbol has been added to the style and the database
|
|
has been updated as a result.
|
|
|
|
.. seealso:: :py:func:`symbolRemoved`
|
|
|
|
.. seealso:: :py:func:`rampAdded`
|
|
|
|
.. seealso:: :py:func:`symbolChanged`
|
|
%End
|
|
|
|
void symbolChanged( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a symbol's definition is changed. This does not include
|
|
name or tag changes.
|
|
|
|
.. seealso:: :py:func:`symbolSaved`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
void groupsModified();
|
|
%Docstring
|
|
Emitted every time a tag or smartgroup has been added, removed, or renamed
|
|
%End
|
|
|
|
void entityTagsChanged( QgsStyle::StyleEntity entity, const QString &name, const QStringList &newTags );
|
|
%Docstring
|
|
Emitted whenever an ``entity``'s tags are changed.
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
void favoritedChanged( QgsStyle::StyleEntity entity, const QString &name, bool isFavorite );
|
|
%Docstring
|
|
Emitted whenever an ``entity`` is either favorited or un-favorited.
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
void symbolRemoved( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a symbol has been removed from the style and the database
|
|
has been updated as a result.
|
|
|
|
.. seealso:: :py:func:`symbolSaved`
|
|
|
|
.. seealso:: :py:func:`rampRemoved`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
void symbolRenamed( const QString &oldName, const QString &newName );
|
|
%Docstring
|
|
Emitted whenever a symbol has been renamed from ``oldName`` to ``newName``
|
|
|
|
.. seealso:: :py:func:`rampRenamed`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
void rampRenamed( const QString &oldName, const QString &newName );
|
|
%Docstring
|
|
Emitted whenever a color ramp has been renamed from ``oldName`` to ``newName``
|
|
|
|
.. seealso:: :py:func:`symbolRenamed`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
void rampAdded( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a color ramp has been added to the style and the database
|
|
has been updated as a result.
|
|
|
|
.. seealso:: :py:func:`rampRemoved`
|
|
|
|
.. seealso:: :py:func:`symbolSaved`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
void rampRemoved( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a color ramp has been removed from the style and the database
|
|
has been updated as a result.
|
|
|
|
.. seealso:: :py:func:`rampAdded`
|
|
|
|
.. seealso:: :py:func:`symbolRemoved`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
void rampChanged( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a color ramp's definition is changed. This does not include
|
|
name or tag changes.
|
|
|
|
.. seealso:: :py:func:`rampAdded`
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
|
|
void textFormatRenamed( const QString &oldName, const QString &newName );
|
|
%Docstring
|
|
Emitted whenever a text format has been renamed from ``oldName`` to ``newName``
|
|
|
|
.. seealso:: :py:func:`symbolRenamed`
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
void textFormatAdded( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a text format has been added to the style and the database
|
|
has been updated as a result.
|
|
|
|
.. seealso:: :py:func:`textFormatRemoved`
|
|
|
|
.. seealso:: :py:func:`symbolSaved`
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
void textFormatRemoved( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a text format has been removed from the style and the database
|
|
has been updated as a result.
|
|
|
|
.. seealso:: :py:func:`textFormatAdded`
|
|
|
|
.. seealso:: :py:func:`symbolRemoved`
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
void textFormatChanged( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a text format's definition is changed. This does not include
|
|
name or tag changes.
|
|
|
|
.. seealso:: :py:func:`textFormatAdded`
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
void labelSettingsRenamed( const QString &oldName, const QString &newName );
|
|
%Docstring
|
|
Emitted whenever label settings have been renamed from ``oldName`` to ``newName``
|
|
|
|
.. seealso:: :py:func:`symbolRenamed`
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
void labelSettingsAdded( const QString &name );
|
|
%Docstring
|
|
Emitted whenever label settings have been added to the style and the database
|
|
has been updated as a result.
|
|
|
|
.. seealso:: :py:func:`labelSettingsRemoved`
|
|
|
|
.. seealso:: :py:func:`symbolSaved`
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
void labelSettingsRemoved( const QString &name );
|
|
%Docstring
|
|
Emitted whenever label settings have been removed from the style and the database
|
|
has been updated as a result.
|
|
|
|
.. seealso:: :py:func:`labelSettingsAdded`
|
|
|
|
.. seealso:: :py:func:`symbolRemoved`
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
void labelSettingsChanged( const QString &name );
|
|
%Docstring
|
|
Emitted whenever a label setting's definition is changed. This does not include
|
|
name or tag changes.
|
|
|
|
.. seealso:: :py:func:`labelSettingsAdded`
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsStyleEntityInterface
|
|
{
|
|
%Docstring
|
|
An interface for entities which can be placed in a QgsStyle database.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsstyle.h"
|
|
%End
|
|
%ConvertToSubClassCode
|
|
switch ( sipCpp->type() )
|
|
{
|
|
case QgsStyle::SymbolEntity:
|
|
sipType = sipType_QgsStyleSymbolEntity;
|
|
break;
|
|
|
|
case QgsStyle::ColorrampEntity:
|
|
sipType = sipType_QgsStyleColorRampEntity;
|
|
break;
|
|
|
|
case QgsStyle::TextFormatEntity:
|
|
sipType = sipType_QgsStyleTextFormatEntity;
|
|
break;
|
|
|
|
case QgsStyle::LabelSettingsEntity:
|
|
sipType = sipType_QgsStyleLabelSettingsEntity;
|
|
break;
|
|
|
|
case QgsStyle::SmartgroupEntity:
|
|
case QgsStyle::TagEntity:
|
|
sipType = 0;
|
|
break;
|
|
}
|
|
%End
|
|
public:
|
|
|
|
virtual ~QgsStyleEntityInterface();
|
|
|
|
virtual QgsStyle::StyleEntity type() const = 0;
|
|
%Docstring
|
|
Returns the type of style entity.
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsStyleSymbolEntity : QgsStyleEntityInterface
|
|
{
|
|
%Docstring
|
|
A symbol entity for QgsStyle databases.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsstyle.h"
|
|
%End
|
|
public:
|
|
|
|
QgsStyleSymbolEntity( const QgsSymbol *symbol );
|
|
%Docstring
|
|
Constructor for QgsStyleSymbolEntity, with the specified ``symbol``.
|
|
|
|
Ownership of ``symbol`` is NOT transferred.
|
|
%End
|
|
|
|
virtual QgsStyle::StyleEntity type() const;
|
|
|
|
|
|
const QgsSymbol *symbol() const;
|
|
%Docstring
|
|
Returns the entity's symbol.
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsStyleColorRampEntity : QgsStyleEntityInterface
|
|
{
|
|
%Docstring
|
|
A color ramp entity for QgsStyle databases.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsstyle.h"
|
|
%End
|
|
public:
|
|
|
|
QgsStyleColorRampEntity( const QgsColorRamp *ramp );
|
|
%Docstring
|
|
Constructor for QgsStyleColorRampEntity, with the specified color ``ramp``.
|
|
|
|
Ownership of ``ramp`` is NOT transferred.
|
|
%End
|
|
|
|
virtual QgsStyle::StyleEntity type() const;
|
|
|
|
|
|
const QgsColorRamp *ramp() const;
|
|
%Docstring
|
|
Returns the entity's color ramp.
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsStyleTextFormatEntity : QgsStyleEntityInterface
|
|
{
|
|
%Docstring
|
|
A text format entity for QgsStyle databases.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsstyle.h"
|
|
%End
|
|
public:
|
|
|
|
QgsStyleTextFormatEntity( const QgsTextFormat &format );
|
|
%Docstring
|
|
Constructor for QgsStyleTextFormatEntity, with the specified text ``format``.
|
|
%End
|
|
|
|
virtual QgsStyle::StyleEntity type() const;
|
|
|
|
|
|
QgsTextFormat format() const;
|
|
%Docstring
|
|
Returns the entity's text format.
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsStyleLabelSettingsEntity : QgsStyleEntityInterface
|
|
{
|
|
%Docstring
|
|
A label settings entity for QgsStyle databases.
|
|
|
|
.. versionadded:: 3.10
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsstyle.h"
|
|
%End
|
|
public:
|
|
|
|
QgsStyleLabelSettingsEntity( const QgsPalLayerSettings &settings );
|
|
%Docstring
|
|
Constructor for QgsStyleLabelSettingsEntity, with the specified label ``settings``.
|
|
%End
|
|
|
|
virtual QgsStyle::StyleEntity type() const;
|
|
|
|
|
|
|
|
const QgsPalLayerSettings &settings() const;
|
|
%Docstring
|
|
Returns the entity's label settings.
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/symbology/qgsstyle.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|