Add all missing class brief descriptions

This commit is contained in:
Nyall Dawson 2025-03-27 16:09:35 +10:00
parent 2e47963658
commit f480c2a04e
258 changed files with 813 additions and 60 deletions

View File

@ -11,6 +11,9 @@
class QgsCacheIndexFeatureId : QgsAbstractCacheIndex
{
%Docstring(signature="appended")
Indexes cached features using feature IDs.
%End
%TypeHeaderCode
#include "qgscacheindexfeatureid.h"

View File

@ -12,6 +12,9 @@
class QgsGeometryValidator : QThread
{
%Docstring(signature="appended")
Validates geometries using the QGIS geometry validation model.
%End
%TypeHeaderCode
#include "qgsgeometryvalidator.h"

View File

@ -34,6 +34,9 @@ Description of feature class in GML
class QgsGmlSchema : QObject
{
%Docstring(signature="appended")
Represents a GML schema.
%End
%TypeHeaderCode
#include "qgsgmlschema.h"

View File

@ -91,6 +91,9 @@ otherwise returns a file name for writing log messages to.
class QgsScopeLogger
{
%Docstring(signature="appended")
Logs the location of the call.
%End
%TypeHeaderCode
#include "qgslogger.h"

View File

@ -9,6 +9,9 @@
class QgsTrackedVectorLayerTools : QgsVectorLayerTools
{
%Docstring(signature="appended")
Vector layer tools subclass which "tracks" edits.
%End
%TypeHeaderCode
#include "qgstrackedvectorlayertools.h"

View File

@ -10,6 +10,9 @@
class QgsTransactionGroup : QObject
{
%Docstring(signature="appended")
Represents a transaction group.
%End
%TypeHeaderCode
#include "qgstransactiongroup.h"

View File

@ -35,6 +35,9 @@ There are two possibilities how to use this class:
class Option
{
%Docstring(signature="appended")
Describes an available option for configuring file writing for a particular output format.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -48,6 +51,9 @@ There are two possibilities how to use this class:
class SetOption : QgsVectorFileWriter::Option
{
%Docstring(signature="appended")
An available option for configuring file writing for a particular output format, presenting a choice of preset values.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -62,6 +68,9 @@ There are two possibilities how to use this class:
class StringOption: QgsVectorFileWriter::Option
{
%Docstring(signature="appended")
An available option for configuring file writing for a particular output format, presenting a freeform string option.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -74,6 +83,9 @@ There are two possibilities how to use this class:
class IntOption: QgsVectorFileWriter::Option
{
%Docstring(signature="appended")
An available option for configuring file writing for a particular output format, presenting an integer option.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -86,6 +98,9 @@ There are two possibilities how to use this class:
class BoolOption : QgsVectorFileWriter::SetOption
{
%Docstring(signature="appended")
An available option for configuring file writing for a particular output format, presenting an boolean option.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -96,6 +111,9 @@ There are two possibilities how to use this class:
class HiddenOption : QgsVectorFileWriter::Option
{
%Docstring(signature="appended")
A hidden option for file writing for a particular output format.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"

View File

@ -139,6 +139,9 @@ typedef QList<QgsRendererCategory> QgsCategoryList;
class QgsCategorizedSymbolRenderer : QgsFeatureRenderer
{
%Docstring(signature="appended")
A feature renderer which represents features using a list of renderer categories.
%End
%TypeHeaderCode
#include "qgscategorizedsymbolrenderer.h"

View File

@ -472,6 +472,9 @@ Returns the map unit scale for the fill's offset.
class QgsShapeburstFillSymbolLayer : QgsFillSymbolLayer
{
%Docstring(signature="appended")
A fill symbol layer which applies a gradient from the outer edges of a symbol to the inside.
%End
%TypeHeaderCode
#include "qgsfillsymbollayer.h"

View File

@ -537,6 +537,9 @@ Creates a new QgsFilledMarkerSymbolLayer.
class QgsSvgMarkerSymbolLayer : QgsMarkerSymbolLayer
{
%Docstring(signature="appended")
A marker symbol layer which renders an SVG graphic.
%End
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"
@ -925,6 +928,9 @@ Copies common properties to another layer.
class QgsFontMarkerSymbolLayer : QgsMarkerSymbolLayer
{
%Docstring(signature="appended")
A marker symbol layer which displays characters rendered using a font.
%End
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"

View File

@ -19,6 +19,9 @@ typedef QList<QgsSymbol *> QgsSymbolList;
class QgsSymbolLevelItem
{
%Docstring(signature="appended")
Represents a symbol level during vector rendering operations.
%End
%TypeHeaderCode
#include "qgsrenderer.h"

View File

@ -14,6 +14,9 @@
class QgsRendererRange
{
%Docstring(signature="appended")
Represents a value range for a :py:class:`QgsGraduatedSymbolRenderer`.
%End
%TypeHeaderCode
#include "qgsrendererrange.h"
@ -186,6 +189,7 @@ typedef QList<QgsRendererRange> QgsRangeList;
class QgsRendererRangeLabelFormat /Deprecated="Since 3.10. Use QgsClassificationMethod instead."/
{
%Docstring(signature="appended")
Encapsulates the formatting for a :py:class:`QgsRendererRange` label.
.. deprecated:: 3.10

View File

@ -10,6 +10,9 @@
class QgsSingleSymbolRenderer : QgsFeatureRenderer
{
%Docstring(signature="appended")
A feature renderer which renders all features with the same symbol.
%End
%TypeHeaderCode
#include "qgssinglesymbolrenderer.h"

View File

@ -24,6 +24,9 @@ typedef QMultiMap<QString, QString> QgsSmartConditionMap;
class QgsStyle : QObject
{
%Docstring(signature="appended")
A database of saved style entities, including symbols, color ramps, text formats and others.
%End
%TypeHeaderCode
#include "qgsstyle.h"

View File

@ -14,6 +14,9 @@
class QgsSymbolLayer
{
%Docstring(signature="appended")
Abstract base class for symbol layers.
%End
%TypeHeaderCode
#include "qgssymbollayer.h"

View File

@ -11,6 +11,9 @@
class QgsSymbolRenderContext
{
%Docstring(signature="appended")
Encapsulates the context in which a symbol is being rendered.
%End
%TypeHeaderCode
#include "qgssymbolrendercontext.h"

View File

@ -14,6 +14,9 @@
class QgsVectorLayerEditPassthrough : QgsVectorLayerEditBuffer
{
%Docstring(signature="appended")
An edit buffer which directly passes commands through, used when a layer is within a transaction.
%End
%TypeHeaderCode
#include "qgsvectorlayereditpassthrough.h"

View File

@ -12,6 +12,9 @@
class QgsAttributeTableFilterModel : QSortFilterProxyModel, QgsFeatureModel
{
%Docstring(signature="appended")
A proxy model for filtering an attribute table model.
%End
%TypeHeaderCode
#include "qgsattributetablefiltermodel.h"

View File

@ -296,6 +296,9 @@ Emitted when selecting context menu on the feature list to create the context me
class QgsAttributeTableAction : QAction
{
%Docstring(signature="appended")
A QAction subclass for map layer actions shown in an attribute table.
%End
%TypeHeaderCode
#include "qgsdualview.h"
@ -314,6 +317,9 @@ Create a new attribute table action.
class QgsAttributeTableMapLayerAction : QAction
{
%Docstring(signature="appended")
A QAction for attribute table map layer actions.
%End
%TypeHeaderCode
#include "qgsdualview.h"

View File

@ -12,6 +12,9 @@
class QgsFeatureListModel : QSortFilterProxyModel, QgsFeatureModel
{
%Docstring(signature="appended")
A proxy model for feature lists.
%End
%TypeHeaderCode
#include "qgsfeaturelistmodel.h"

View File

@ -10,6 +10,9 @@
class QgsFeatureListViewDelegate : QItemDelegate
{
%Docstring(signature="appended")
Custom item delegate for feature list views.
%End
%TypeHeaderCode
#include "qgsfeaturelistviewdelegate.h"

View File

@ -9,6 +9,9 @@
class QgsFeatureModel
{
%Docstring(signature="appended")
Base class for feature models.
%End
%TypeHeaderCode
#include "qgsfeaturemodel.h"

View File

@ -11,6 +11,9 @@
class QgsFeatureSelectionModel : QItemSelectionModel
{
%Docstring(signature="appended")
Item selection model for selecting features.
%End
%TypeHeaderCode
#include "qgsfeatureselectionmodel.h"

View File

@ -19,6 +19,9 @@
class QgsRelationReferenceWidget : QWidget
{
%Docstring(signature="appended")
A widget which shows related features.
%End
%TypeHeaderCode
#include "qgsrelationreferencewidget.h"

View File

@ -10,9 +10,11 @@
class QgsRelationWidgetWrapper : QgsWidgetWrapper
{
%Docstring(signature="appended")
A widget wrapper for relation widgets.
%End
%TypeHeaderCode
#include "qgsrelationwidgetwrapper.h"

View File

@ -10,7 +10,6 @@
class QgsPaintEffectWidget : QWidget
{
%Docstring(signature="appended")
@ -41,6 +40,9 @@ Emitted when properties of the effect are changed through the widget
class QgsDrawSourceWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsDrawSourceEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -59,6 +61,9 @@ class QgsDrawSourceWidget : QgsPaintEffectWidget
class QgsBlurWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsBlurEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -77,6 +82,9 @@ class QgsBlurWidget : QgsPaintEffectWidget
class QgsShadowEffectWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsShadowEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -95,6 +103,9 @@ class QgsShadowEffectWidget : QgsPaintEffectWidget
class QgsGlowWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsGlowEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -112,6 +123,9 @@ class QgsGlowWidget : QgsPaintEffectWidget
class QgsTransformWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsTransformEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -130,6 +144,9 @@ class QgsTransformWidget : QgsPaintEffectWidget
class QgsColorEffectWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsColorEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"

View File

@ -12,6 +12,9 @@
class QgsAttributeDialog : QDialog, QgsMapLayerActionContextGenerator
{
%Docstring(signature="appended")
An attribute table dialog for a vector layer.
%End
%TypeHeaderCode
#include "qgsattributedialog.h"

View File

@ -14,6 +14,9 @@
class QgsAttributeForm : QWidget
{
%Docstring(signature="appended")
The attribute form widget for vector layer features.
%End
%TypeHeaderCode
#include "qgsattributeform.h"

View File

@ -11,6 +11,9 @@
class QgsAttributeFormInterface
{
%Docstring(signature="appended")
Interface class for custom attribute forms.
%End
%TypeHeaderCode
#include "qgsattributeforminterface.h"

View File

@ -12,6 +12,9 @@
class QgsAttributeTypeLoadDialog : QDialog
{
%Docstring(signature="appended")
A dialog which allows populating value maps using features present in a vector layer.
%End
%TypeHeaderCode
#include "qgsattributetypeloaddialog.h"

View File

@ -13,6 +13,9 @@
class QgsGroupBoxCollapseButton : QToolButton
{
%Docstring(signature="appended")
A collapse buttonwidget for collapsible group boxes.
%End
%TypeHeaderCode
#include "qgscollapsiblegroupbox.h"

View File

@ -12,6 +12,9 @@
class QgsDial : QDial
{
%Docstring(signature="appended")
A QDial subclass with additional refinements.
%End
%TypeHeaderCode
#include "qgsdial.h"

View File

@ -11,6 +11,9 @@
class QgsErrorDialog : QDialog
{
%Docstring(signature="appended")
A dialog which shows error details.
%End
%TypeHeaderCode
#include "qgserrordialog.h"

View File

@ -12,6 +12,9 @@
class QgsExpressionHighlighter : QSyntaxHighlighter
{
%Docstring(signature="appended")
Syntax highlighter for QGIS expressions.
%End
%TypeHeaderCode
#include "qgsexpressionhighlighter.h"

View File

@ -17,6 +17,9 @@
class QgsFeatureSelectionDlg : QDialog
{
%Docstring(signature="appended")
A dialog for selecting features from a vector layer.
%End
%TypeHeaderCode
#include "qgsfeatureselectiondlg.h"

View File

@ -11,6 +11,9 @@
class QgsFieldValidator : QValidator
{
%Docstring(signature="appended")
A QValidator for validation against a :py:class:`QgsField`'s constraints and field type.
%End
%TypeHeaderCode
#include "qgsfieldvalidator.h"

View File

@ -10,6 +10,9 @@
class QgsGroupWmsDataDialog : QDialog
{
%Docstring(signature="appended")
A dialog for configuring a WMS group.
%End
%TypeHeaderCode
#include "qgsgroupwmsdatadialog.h"

View File

@ -11,6 +11,9 @@
class QgsLongLongValidator : QValidator
{
%Docstring(signature="appended")
A QValidator which allows validation of long long values.
%End
%TypeHeaderCode
#include "qgslonglongvalidator.h"

View File

@ -11,6 +11,9 @@
class QgsLUDialog : QDialog
{
%Docstring(signature="appended")
A dialog for setting a lower and upper range value.
%End
%TypeHeaderCode
#include "qgsludialog.h"

View File

@ -11,6 +11,9 @@
class QgsManageConnectionsDialog : QDialog
{
%Docstring(signature="appended")
A dialog for importing or exporting stored connections.
%End
%TypeHeaderCode
#include "qgsmanageconnectionsdialog.h"

View File

@ -11,6 +11,9 @@
class QgsNewMemoryLayerDialog : QDialog
{
%Docstring(signature="appended")
A dialog for configuring the properties of a new memory (scratch) layer.
%End
%TypeHeaderCode
#include "qgsnewmemorylayerdialog.h"

View File

@ -11,6 +11,9 @@
class QgsNewVectorLayerDialog : QDialog
{
%Docstring(signature="appended")
A dialog for configuring the properties of a new vector layer.
%End
%TypeHeaderCode
#include "qgsnewvectorlayerdialog.h"

View File

@ -11,6 +11,9 @@
class QgsPluginManagerInterface : QObject
{
%Docstring(signature="appended")
Abstract interface class for the QGIS plugin manager.
%End
%TypeHeaderCode
#include "qgspluginmanagerinterface.h"

View File

@ -10,6 +10,9 @@
class QgsRasterLayerSaveAsDialog : QDialog
{
%Docstring(signature="appended")
A dialog for configuring raster layer export parameters.
%End
%TypeHeaderCode
#include "qgsrasterlayersaveasdialog.h"

View File

@ -12,6 +12,9 @@
class QgsSlider : QSlider
{
%Docstring(signature="appended")
A custom QSlider with additional refinements.
%End
%TypeHeaderCode
#include "qgsslider.h"

View File

@ -11,6 +11,7 @@
class QgsSublayersDialog : QDialog
{
%Docstring(signature="appended")
Presents a choice of sublayers.
.. deprecated:: 3.40

View File

@ -12,6 +12,9 @@
class QgsMultiBandColorRendererWidget : QgsRasterRendererWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsMultiBandColorRenderer`.
%End
%TypeHeaderCode
#include "qgsmultibandcolorrendererwidget.h"

View File

@ -14,6 +14,9 @@
class QgsPalettedRendererWidget : QgsRasterRendererWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsPalettedRasterRenderer`.
%End
%TypeHeaderCode
#include "qgspalettedrendererwidget.h"

View File

@ -13,6 +13,9 @@
class QgsRasterMinMaxWidget : QWidget
{
%Docstring(signature="appended")
A widget for configuring how the minimum and maximum value of a raster layer is determined.
%End
%TypeHeaderCode
#include "qgsrasterminmaxwidget.h"

View File

@ -13,6 +13,9 @@
class QgsRendererRasterPropertiesWidget : QgsMapLayerConfigWidget
{
%Docstring(signature="appended")
A widget for configuring properties of a raster layer renderer.
%End
%TypeHeaderCode
#include "qgsrendererrasterpropertieswidget.h"

View File

@ -12,6 +12,9 @@
class QgsSingleBandGrayRendererWidget : QgsRasterRendererWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsSingleBandGrayRenderer`.
%End
%TypeHeaderCode
#include "qgssinglebandgrayrendererwidget.h"

View File

@ -10,6 +10,9 @@
class Qgs25DRendererWidget : QgsRendererWidget, protected Ui::Qgs25DRendererWidgetBase
{
%Docstring(signature="appended")
A widget for configuring a Qgs25DRenderer.
%End
%TypeHeaderCode
#include "qgs25drendererwidget.h"

View File

@ -10,6 +10,9 @@
class QgsArrowSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsArrowSymbolLayer`.
%End
%TypeHeaderCode
#include "qgsarrowsymbollayerwidget.h"

View File

@ -10,6 +10,9 @@
class QgsBrushStyleComboBox : QComboBox
{
%Docstring(signature="appended")
A combobox which presents choices of Qt.BrushStyle.
%End
%TypeHeaderCode
#include "qgsbrushstylecombobox.h"

View File

@ -14,6 +14,9 @@
class QgsCategorizedSymbolRendererWidget : QgsRendererWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsCategorizedSymbolRenderer`.
%End
%TypeHeaderCode
#include "qgscategorizedsymbolrendererwidget.h"

View File

@ -10,6 +10,9 @@
class QgsEllipseSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsEllipseSymbolLayer`.
%End
%TypeHeaderCode
#include "qgsellipsesymbollayerwidget.h"

View File

@ -16,6 +16,9 @@
class QgsGraduatedSymbolRendererWidget : QgsRendererWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsGraduatedSymbolRenderer`.
%End
%TypeHeaderCode
#include "qgsgraduatedsymbolrendererwidget.h"

View File

@ -10,6 +10,9 @@
class QgsHeatmapRendererWidget : QgsRendererWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsHeatmapRenderer`.
%End
%TypeHeaderCode
#include "qgsheatmaprendererwidget.h"

View File

@ -10,6 +10,9 @@
class QgsPenStyleComboBox : QComboBox
{
%Docstring(signature="appended")
A combobox widget for selection of Qt.PenStyle.
%End
%TypeHeaderCode
#include "qgspenstylecombobox.h"
@ -27,6 +30,9 @@ class QgsPenStyleComboBox : QComboBox
class QgsPenJoinStyleComboBox : QComboBox
{
%Docstring(signature="appended")
A combobox widget for selection of Qt.PenJoinStyle.
%End
%TypeHeaderCode
#include "qgspenstylecombobox.h"
@ -41,6 +47,9 @@ class QgsPenJoinStyleComboBox : QComboBox
class QgsPenCapStyleComboBox : QComboBox
{
%Docstring(signature="appended")
A combobox widget for selection of Qt.PenCapStyle.
%End
%TypeHeaderCode
#include "qgspenstylecombobox.h"

View File

@ -12,6 +12,9 @@
class QgsPointDisplacementRendererWidget : QgsRendererWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsPointDisplacementRenderer`.
%End
%TypeHeaderCode
#include "qgspointdisplacementrendererwidget.h"

View File

@ -14,6 +14,9 @@
class QgsRendererPropertiesDialog : QDialog
{
%Docstring(signature="appended")
A dialog for configuring vector layer renderers.
%End
%TypeHeaderCode
#include "qgsrendererpropertiesdialog.h"

View File

@ -231,6 +231,9 @@ Returns the vector layer associated with the widget.
class QgsDataDefinedSizeDialog : QgsDataDefinedValueDialog
{
%Docstring(signature="appended")
A dialog for configuring symbol-level data defined size.
%End
%TypeHeaderCode
#include "qgsrendererwidget.h"
@ -252,6 +255,9 @@ class QgsDataDefinedSizeDialog : QgsDataDefinedValueDialog
class QgsDataDefinedRotationDialog : QgsDataDefinedValueDialog
{
%Docstring(signature="appended")
A dialog for configuring symbol-level data defined rotation.
%End
%TypeHeaderCode
#include "qgsrendererwidget.h"
@ -272,6 +278,9 @@ class QgsDataDefinedRotationDialog : QgsDataDefinedValueDialog
class QgsDataDefinedWidthDialog : QgsDataDefinedValueDialog
{
%Docstring(signature="appended")
A dialog for configuring symbol-level data defined width.
%End
%TypeHeaderCode
#include "qgsrendererwidget.h"

View File

@ -90,6 +90,9 @@ transferred to the renderer.
class QgsRuleBasedRendererWidget : QgsRendererWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsRuleBasedRenderer`.
%End
%TypeHeaderCode
#include "qgsrulebasedrendererwidget.h"
@ -169,6 +172,9 @@ Opens the dialog for refining a rule using ranges
class QgsRendererRulePropsWidget : QgsPanelWidget
{
%Docstring(signature="appended")
A widget for editing the details of a rule based renderer rule.
%End
%TypeHeaderCode
#include "qgsrulebasedrendererwidget.h"
@ -224,6 +230,9 @@ Set the widget in dock mode.
class QgsRendererRulePropsDialog : QDialog
{
%Docstring(signature="appended")
A dialog for editing the details of a rule based renderer rule.
%End
%TypeHeaderCode
#include "qgsrulebasedrendererwidget.h"

View File

@ -11,6 +11,9 @@
class QgsSingleSymbolRendererWidget : QgsRendererWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsSingleSymbolRenderer`.
%End
%TypeHeaderCode
#include "qgssinglesymbolrendererwidget.h"

View File

@ -10,6 +10,9 @@
class QgsSmartGroupCondition : QWidget
{
%Docstring(signature="appended")
A widget for configuring the conditions attached to a style smart group.
%End
%TypeHeaderCode
#include "qgssmartgroupeditordialog.h"
@ -61,6 +64,9 @@ Emitted when the group with the specified ``id`` is removed.
class QgsSmartGroupEditorDialog : QDialog
{
%Docstring(signature="appended")
A dialog for configuring a style smart group.
%End
%TypeHeaderCode
#include "qgssmartgroupeditordialog.h"

View File

@ -13,6 +13,9 @@
class QgsStyleExportImportDialog : QDialog
{
%Docstring(signature="appended")
A dialog allowing importing and exporting of entities from a :py:class:`QgsStyle`.
%End
%TypeHeaderCode
#include "qgsstyleexportimportdialog.h"

View File

@ -12,6 +12,9 @@
class QgsStyleGroupSelectionDialog : QDialog
{
%Docstring(signature="appended")
A dialog which presents available groups from a :py:class:`QgsStyle`.
%End
%TypeHeaderCode
#include "qgsstylegroupselectiondialog.h"

View File

@ -207,6 +207,9 @@ Emitted when the parameters have changed
class QgsSvgSelectorDialog : QDialog
{
%Docstring(signature="appended")
A dialog for selection of an SVG file.
%End
%TypeHeaderCode
#include "qgssvgselectorwidget.h"

View File

@ -12,6 +12,9 @@
class QgsSymbolLayerWidget : QWidget, protected QgsExpressionContextGenerator
{
%Docstring(signature="appended")
Abstract base class for widgets used to configure :py:class:`QgsSymbolLayer` classes.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -86,6 +89,9 @@ Normally :py:func:`~QgsSymbolLayerWidget.changed` should be preferred.
class QgsSimpleLineSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsSimpleLineSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -129,6 +135,9 @@ Creates a new QgsSimpleLineSymbolLayerWidget.
class QgsSimpleMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsSimpleMarkerSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -169,6 +178,9 @@ Creates a new QgsSimpleMarkerSymbolLayerWidget.
class QgsSimpleFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsSimpleFillSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -209,7 +221,7 @@ Creates a new QgsSimpleFillSymbolLayerWidget.
class QgsFilledMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
Widget for configuring :py:class:`QgsFilledMarkerSymbolLayer` symbol layers.
A widget for configuring :py:class:`QgsFilledMarkerSymbolLayer` symbol layers.
%End
%TypeHeaderCode
@ -246,6 +258,9 @@ Creates a new QgsFilledMarkerSymbolLayerWidget.
class QgsGradientFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsGradientFillSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -292,6 +307,9 @@ Applies the color ramp passed on by the color ramp button
class QgsShapeburstFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsShapeburstFillSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -330,6 +348,9 @@ Creates a new QgsShapeburstFillSymbolLayerWidget.
class QgsMarkerLineSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsMarkerLineSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -372,7 +393,7 @@ Creates a new QgsMarkerLineSymbolLayerWidget.
class QgsHashedLineSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
Widget for controlling the properties of a :py:class:`QgsHashedLineSymbolLayer`.
A widget for controlling the properties of a :py:class:`QgsHashedLineSymbolLayer`.
.. versionadded:: 3.8
%End
@ -410,6 +431,9 @@ Creates a new QgsHashedLineSymbolLayerWidget.
class QgsSvgMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsSvgMarkerSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -477,7 +501,7 @@ Updates the GUI to reflect the SVG marker symbol ``layer``.
class QgsRasterMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
Widget for configuring :py:class:`QgsRasterMarkerSymbolLayer` symbol layers.
A widget for configuring :py:class:`QgsRasterMarkerSymbolLayer` symbol layers.
.. versionadded:: 3.6
%End
@ -519,7 +543,7 @@ Creates a new QgsRasterMarkerSymbolLayerWidget.
class QgsAnimatedMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
Widget for configuring :py:class:`QgsAnimatedMarkerSymbolLayer` symbol layers.
A widget for configuring :py:class:`QgsAnimatedMarkerSymbolLayer` symbol layers.
.. versionadded:: 3.26
%End
@ -560,6 +584,9 @@ Creates a new QgsAnimatedMarkerSymbolLayerWidget.
class QgsRasterFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsRasterFillSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -596,7 +623,7 @@ Creates a new QgsRasterFillSymbolLayerWidget.
class QgsRasterLineSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
Widget for configuring :py:class:`QgsRasterLineSymbolLayer` symbol layers.
A widget for configuring :py:class:`QgsRasterLineSymbolLayer` symbol layers.
.. versionadded:: 3.24
%End
@ -636,7 +663,7 @@ Creates a new QgsRasterLineSymbolLayerWidget.
class QgsLineburstSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
Widget for configuring :py:class:`QgsLineburstSymbolLayer` symbol layers.
A widget for configuring :py:class:`QgsLineburstSymbolLayer` symbol layers.
.. versionadded:: 3.24
%End
@ -714,6 +741,9 @@ Creates a new QgsFilledLineSymbolLayerWidget.
class QgsSVGFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsSVGFillSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -759,6 +789,9 @@ svg file supports custom parameters.
class QgsLinePatternFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsLinePatternFillSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -793,6 +826,9 @@ Creates a new QgsLinePatternFillSymbolLayerWidget.
class QgsPointPatternFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsPointPatternFillSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -829,8 +865,7 @@ Creates a new QgsPointPatternFillSymbolLayerWidget.
class QgsRandomMarkerFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
Widget for controlling the properties of a :py:class:`QgsRandomMarkerFillSymbolLayer`.
A widget for controlling the properties of a :py:class:`QgsRandomMarkerFillSymbolLayer`.
.. versionadded:: 3.12
%End
@ -866,6 +901,9 @@ Creates a new QgsRandomMarkerFillSymbolLayerWidget.
class QgsFontMarkerSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsFontMarkerSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -929,6 +967,9 @@ Set the font marker character from a text string.
class QgsCentroidFillSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsCentroidFillSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"
@ -965,7 +1006,7 @@ Creates a new QgsCentroidFillSymbolLayerWidget.
class QgsLinearReferencingSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
Widget for controlling the properties of a :py:class:`QgsLinearReferencingSymbolLayer`.
A widget for controlling the properties of a :py:class:`QgsLinearReferencingSymbolLayer`.
.. versionadded:: 3.40
%End
@ -1002,6 +1043,9 @@ Creates a new QgsLinearReferencingSymbolLayerWidget.
class QgsGeometryGeneratorSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for controlling the properties of a :py:class:`QgsGeometryGeneratorSymbolLayer`.
%End
%TypeHeaderCode
#include "qgssymbollayerwidget.h"

View File

@ -13,6 +13,9 @@
class QgsSymbolsListWidget : QWidget
{
%Docstring(signature="appended")
A widget which presents symbol-level properties (such as size), and allows selection of symbols from stored styles.
%End
%TypeHeaderCode
#include "qgssymbolslistwidget.h"

View File

@ -10,6 +10,9 @@
class QgsVectorFieldSymbolLayerWidget : QgsSymbolLayerWidget
{
%Docstring(signature="appended")
A widget for configuring a :py:class:`QgsVectorFieldSymbolLayer`.
%End
%TypeHeaderCode
#include "qgsvectorfieldsymbollayerwidget.h"

View File

@ -14,6 +14,9 @@
class QgsVectorLayerProperties : QgsLayerPropertiesDialog
{
%Docstring(signature="appended")
Layer properties dialog for vector layers.
%End
%TypeHeaderCode
#include "qgsvectorlayerproperties.h"

View File

@ -11,6 +11,9 @@
class QgsCacheIndexFeatureId : QgsAbstractCacheIndex
{
%Docstring(signature="appended")
Indexes cached features using feature IDs.
%End
%TypeHeaderCode
#include "qgscacheindexfeatureid.h"

View File

@ -12,6 +12,9 @@
class QgsGeometryValidator : QThread
{
%Docstring(signature="appended")
Validates geometries using the QGIS geometry validation model.
%End
%TypeHeaderCode
#include "qgsgeometryvalidator.h"

View File

@ -34,6 +34,9 @@ Description of feature class in GML
class QgsGmlSchema : QObject
{
%Docstring(signature="appended")
Represents a GML schema.
%End
%TypeHeaderCode
#include "qgsgmlschema.h"

View File

@ -91,6 +91,9 @@ otherwise returns a file name for writing log messages to.
class QgsScopeLogger
{
%Docstring(signature="appended")
Logs the location of the call.
%End
%TypeHeaderCode
#include "qgslogger.h"

View File

@ -9,6 +9,9 @@
class QgsTrackedVectorLayerTools : QgsVectorLayerTools
{
%Docstring(signature="appended")
Vector layer tools subclass which "tracks" edits.
%End
%TypeHeaderCode
#include "qgstrackedvectorlayertools.h"

View File

@ -10,6 +10,9 @@
class QgsTransactionGroup : QObject
{
%Docstring(signature="appended")
Represents a transaction group.
%End
%TypeHeaderCode
#include "qgstransactiongroup.h"

View File

@ -35,6 +35,9 @@ There are two possibilities how to use this class:
class Option
{
%Docstring(signature="appended")
Describes an available option for configuring file writing for a particular output format.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -48,6 +51,9 @@ There are two possibilities how to use this class:
class SetOption : QgsVectorFileWriter::Option
{
%Docstring(signature="appended")
An available option for configuring file writing for a particular output format, presenting a choice of preset values.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -62,6 +68,9 @@ There are two possibilities how to use this class:
class StringOption: QgsVectorFileWriter::Option
{
%Docstring(signature="appended")
An available option for configuring file writing for a particular output format, presenting a freeform string option.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -74,6 +83,9 @@ There are two possibilities how to use this class:
class IntOption: QgsVectorFileWriter::Option
{
%Docstring(signature="appended")
An available option for configuring file writing for a particular output format, presenting an integer option.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -86,6 +98,9 @@ There are two possibilities how to use this class:
class BoolOption : QgsVectorFileWriter::SetOption
{
%Docstring(signature="appended")
An available option for configuring file writing for a particular output format, presenting an boolean option.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"
@ -96,6 +111,9 @@ There are two possibilities how to use this class:
class HiddenOption : QgsVectorFileWriter::Option
{
%Docstring(signature="appended")
A hidden option for file writing for a particular output format.
%End
%TypeHeaderCode
#include "qgsvectorfilewriter.h"

View File

@ -139,6 +139,9 @@ typedef QList<QgsRendererCategory> QgsCategoryList;
class QgsCategorizedSymbolRenderer : QgsFeatureRenderer
{
%Docstring(signature="appended")
A feature renderer which represents features using a list of renderer categories.
%End
%TypeHeaderCode
#include "qgscategorizedsymbolrenderer.h"

View File

@ -472,6 +472,9 @@ Returns the map unit scale for the fill's offset.
class QgsShapeburstFillSymbolLayer : QgsFillSymbolLayer
{
%Docstring(signature="appended")
A fill symbol layer which applies a gradient from the outer edges of a symbol to the inside.
%End
%TypeHeaderCode
#include "qgsfillsymbollayer.h"

View File

@ -537,6 +537,9 @@ Creates a new QgsFilledMarkerSymbolLayer.
class QgsSvgMarkerSymbolLayer : QgsMarkerSymbolLayer
{
%Docstring(signature="appended")
A marker symbol layer which renders an SVG graphic.
%End
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"
@ -925,6 +928,9 @@ Copies common properties to another layer.
class QgsFontMarkerSymbolLayer : QgsMarkerSymbolLayer
{
%Docstring(signature="appended")
A marker symbol layer which displays characters rendered using a font.
%End
%TypeHeaderCode
#include "qgsmarkersymbollayer.h"

View File

@ -19,6 +19,9 @@ typedef QList<QgsSymbol *> QgsSymbolList;
class QgsSymbolLevelItem
{
%Docstring(signature="appended")
Represents a symbol level during vector rendering operations.
%End
%TypeHeaderCode
#include "qgsrenderer.h"

View File

@ -14,6 +14,9 @@
class QgsRendererRange
{
%Docstring(signature="appended")
Represents a value range for a :py:class:`QgsGraduatedSymbolRenderer`.
%End
%TypeHeaderCode
#include "qgsrendererrange.h"
@ -186,6 +189,7 @@ typedef QList<QgsRendererRange> QgsRangeList;
class QgsRendererRangeLabelFormat /Deprecated="Since 3.10. Use QgsClassificationMethod instead."/
{
%Docstring(signature="appended")
Encapsulates the formatting for a :py:class:`QgsRendererRange` label.
.. deprecated:: 3.10

View File

@ -10,6 +10,9 @@
class QgsSingleSymbolRenderer : QgsFeatureRenderer
{
%Docstring(signature="appended")
A feature renderer which renders all features with the same symbol.
%End
%TypeHeaderCode
#include "qgssinglesymbolrenderer.h"

View File

@ -24,6 +24,9 @@ typedef QMultiMap<QString, QString> QgsSmartConditionMap;
class QgsStyle : QObject
{
%Docstring(signature="appended")
A database of saved style entities, including symbols, color ramps, text formats and others.
%End
%TypeHeaderCode
#include "qgsstyle.h"

View File

@ -14,6 +14,9 @@
class QgsSymbolLayer
{
%Docstring(signature="appended")
Abstract base class for symbol layers.
%End
%TypeHeaderCode
#include "qgssymbollayer.h"

View File

@ -11,6 +11,9 @@
class QgsSymbolRenderContext
{
%Docstring(signature="appended")
Encapsulates the context in which a symbol is being rendered.
%End
%TypeHeaderCode
#include "qgssymbolrendercontext.h"

View File

@ -14,6 +14,9 @@
class QgsVectorLayerEditPassthrough : QgsVectorLayerEditBuffer
{
%Docstring(signature="appended")
An edit buffer which directly passes commands through, used when a layer is within a transaction.
%End
%TypeHeaderCode
#include "qgsvectorlayereditpassthrough.h"

View File

@ -12,6 +12,9 @@
class QgsAttributeTableFilterModel : QSortFilterProxyModel, QgsFeatureModel
{
%Docstring(signature="appended")
A proxy model for filtering an attribute table model.
%End
%TypeHeaderCode
#include "qgsattributetablefiltermodel.h"

View File

@ -296,6 +296,9 @@ Emitted when selecting context menu on the feature list to create the context me
class QgsAttributeTableAction : QAction
{
%Docstring(signature="appended")
A QAction subclass for map layer actions shown in an attribute table.
%End
%TypeHeaderCode
#include "qgsdualview.h"
@ -314,6 +317,9 @@ Create a new attribute table action.
class QgsAttributeTableMapLayerAction : QAction
{
%Docstring(signature="appended")
A QAction for attribute table map layer actions.
%End
%TypeHeaderCode
#include "qgsdualview.h"

View File

@ -12,6 +12,9 @@
class QgsFeatureListModel : QSortFilterProxyModel, QgsFeatureModel
{
%Docstring(signature="appended")
A proxy model for feature lists.
%End
%TypeHeaderCode
#include "qgsfeaturelistmodel.h"

View File

@ -10,6 +10,9 @@
class QgsFeatureListViewDelegate : QItemDelegate
{
%Docstring(signature="appended")
Custom item delegate for feature list views.
%End
%TypeHeaderCode
#include "qgsfeaturelistviewdelegate.h"

View File

@ -9,6 +9,9 @@
class QgsFeatureModel
{
%Docstring(signature="appended")
Base class for feature models.
%End
%TypeHeaderCode
#include "qgsfeaturemodel.h"

View File

@ -11,6 +11,9 @@
class QgsFeatureSelectionModel : QItemSelectionModel
{
%Docstring(signature="appended")
Item selection model for selecting features.
%End
%TypeHeaderCode
#include "qgsfeatureselectionmodel.h"

View File

@ -19,6 +19,9 @@
class QgsRelationReferenceWidget : QWidget
{
%Docstring(signature="appended")
A widget which shows related features.
%End
%TypeHeaderCode
#include "qgsrelationreferencewidget.h"

View File

@ -10,9 +10,11 @@
class QgsRelationWidgetWrapper : QgsWidgetWrapper
{
%Docstring(signature="appended")
A widget wrapper for relation widgets.
%End
%TypeHeaderCode
#include "qgsrelationwidgetwrapper.h"

View File

@ -10,7 +10,6 @@
class QgsPaintEffectWidget : QWidget
{
%Docstring(signature="appended")
@ -41,6 +40,9 @@ Emitted when properties of the effect are changed through the widget
class QgsDrawSourceWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsDrawSourceEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -59,6 +61,9 @@ class QgsDrawSourceWidget : QgsPaintEffectWidget
class QgsBlurWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsBlurEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -77,6 +82,9 @@ class QgsBlurWidget : QgsPaintEffectWidget
class QgsShadowEffectWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsShadowEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -95,6 +103,9 @@ class QgsShadowEffectWidget : QgsPaintEffectWidget
class QgsGlowWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsGlowEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -112,6 +123,9 @@ class QgsGlowWidget : QgsPaintEffectWidget
class QgsTransformWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsTransformEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"
@ -130,6 +144,9 @@ class QgsTransformWidget : QgsPaintEffectWidget
class QgsColorEffectWidget : QgsPaintEffectWidget
{
%Docstring(signature="appended")
A widget for configuring :py:class:`QgsColorEffect` effects.
%End
%TypeHeaderCode
#include "qgspainteffectwidget.h"

View File

@ -12,6 +12,9 @@
class QgsAttributeDialog : QDialog, QgsMapLayerActionContextGenerator
{
%Docstring(signature="appended")
An attribute table dialog for a vector layer.
%End
%TypeHeaderCode
#include "qgsattributedialog.h"

View File

@ -14,6 +14,9 @@
class QgsAttributeForm : QWidget
{
%Docstring(signature="appended")
The attribute form widget for vector layer features.
%End
%TypeHeaderCode
#include "qgsattributeform.h"

Some files were not shown because too many files have changed in this diff Show More