mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-28 00:05:33 -04:00
144 lines
3.8 KiB
Plaintext
144 lines
3.8 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/project/qgsprojectstylesettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsProjectStyleSettings : QObject
|
|
{
|
|
%Docstring(signature="appended")
|
|
Contains settings and properties relating to how a :py:class:`QgsProject` should handle
|
|
styling.
|
|
|
|
.. versionadded:: 3.26
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprojectstylesettings.h"
|
|
%End
|
|
public:
|
|
|
|
QgsProjectStyleSettings( QgsProject *project = 0 );
|
|
%Docstring
|
|
Constructor for QgsProjectStyleSettings for the specified ``project``.
|
|
|
|
Ownership is transferred to the ``project``.
|
|
%End
|
|
|
|
QgsSymbol *defaultSymbol( QgsWkbTypes::GeometryType geomType ) const;
|
|
%Docstring
|
|
Returns the project default symbol for a given geometry type.
|
|
|
|
:param geomType: the geometry type
|
|
|
|
:return: a symbol pointer or NULL if there is no default set
|
|
|
|
.. note::
|
|
|
|
the symbol ownership is transferred to the caller
|
|
%End
|
|
|
|
void setDefaultSymbol( QgsWkbTypes::GeometryType geomType, QgsSymbol *symbol );
|
|
%Docstring
|
|
Sets the project default symbol for a given geometry type.
|
|
|
|
:param geomType: the geometry type
|
|
:param symbol: the symbol pointer, set to NULL to clear default
|
|
|
|
.. note::
|
|
|
|
the symbol ownership is not transferred
|
|
%End
|
|
|
|
QgsColorRamp *defaultColorRamp() const;
|
|
%Docstring
|
|
Returns the project default color ramp.
|
|
|
|
:return: a color ramp pointer or NULL if there is no default set
|
|
|
|
.. note::
|
|
|
|
the color ramp ownership is transferred to the caller
|
|
%End
|
|
|
|
void setDefaultColorRamp( QgsColorRamp *colorRamp );
|
|
%Docstring
|
|
Sets the project default color ramp.
|
|
|
|
:param colorRamp: the color ramp, set to NULL to clear default
|
|
|
|
.. note::
|
|
|
|
the color ramp ownership is not transferred
|
|
%End
|
|
|
|
QgsTextFormat defaultTextFormat() const;
|
|
%Docstring
|
|
Returns the project default text format.
|
|
|
|
.. note::
|
|
|
|
if no default is defined, the returned format will be invalid
|
|
%End
|
|
|
|
void setDefaultTextFormat( QgsTextFormat textFormat );
|
|
%Docstring
|
|
Sets the project default text format.
|
|
|
|
:param textFormat: the text format, an invalid format is interpreted as no default
|
|
%End
|
|
|
|
bool randomizeDefaultSymbolColor() const;
|
|
%Docstring
|
|
Returns whether the default symbol fill color is randomized.
|
|
%End
|
|
|
|
void setRandomizeDefaultSymbolColor( bool randomized );
|
|
%Docstring
|
|
Sets whether the default symbol fill color is randomized.
|
|
%End
|
|
|
|
double defaultSymbolOpacity() const;
|
|
%Docstring
|
|
Returns the default symbol opacity.
|
|
%End
|
|
|
|
void setDefaultSymbolOpacity( double opacity );
|
|
%Docstring
|
|
Sets the default symbol opacity.
|
|
%End
|
|
|
|
void reset();
|
|
%Docstring
|
|
Resets the settings to a default state.
|
|
%End
|
|
|
|
bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
|
|
%Docstring
|
|
Reads the settings's state from a DOM element.
|
|
|
|
.. seealso:: :py:func:`writeXml`
|
|
%End
|
|
|
|
QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
|
|
%Docstring
|
|
Returns a DOM element representing the settings.
|
|
|
|
.. seealso:: :py:func:`readXml`
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/project/qgsprojectstylesettings.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|