diff --git a/python/auto_sip.blacklist b/python/auto_sip.blacklist index 5e10ded86b8..2c8e6049b5c 100644 --- a/python/auto_sip.blacklist +++ b/python/auto_sip.blacklist @@ -41,38 +41,6 @@ core/composer/qgspaperitem.sip core/composer/qgsscalebarstyle.sip core/composer/qgssingleboxscalebarstyle.sip core/composer/qgsticksscalebarstyle.sip -gui/symbology-ng/qgs25drendererwidget.sip -gui/symbology-ng/qgsarrowsymbollayerwidget.sip -gui/symbology-ng/qgsbrushstylecombobox.sip -gui/symbology-ng/qgscategorizedsymbolrendererwidget.sip -gui/symbology-ng/qgscptcitycolorrampdialog.sip -gui/symbology-ng/qgsdashspacedialog.sip -gui/symbology-ng/qgsellipsesymbollayerwidget.sip -gui/symbology-ng/qgsgraduatedhistogramwidget.sip -gui/symbology-ng/qgsgraduatedsymbolrendererwidget.sip -gui/symbology-ng/qgsheatmaprendererwidget.sip -gui/symbology-ng/qgsinvertedpolygonrendererwidget.sip -gui/symbology-ng/qgslayerpropertieswidget.sip -gui/symbology-ng/qgsnullsymbolrendererwidget.sip -gui/symbology-ng/qgspenstylecombobox.sip -gui/symbology-ng/qgspointclusterrendererwidget.sip -gui/symbology-ng/qgspointdisplacementrendererwidget.sip -gui/symbology-ng/qgsrendererpropertiesdialog.sip -gui/symbology-ng/qgsrendererwidget.sip -gui/symbology-ng/qgsrulebasedrendererwidget.sip -gui/symbology-ng/qgssinglesymbolrendererwidget.sip -gui/symbology-ng/qgssmartgroupeditordialog.sip -gui/symbology-ng/qgsstyleexportimportdialog.sip -gui/symbology-ng/qgsstylegroupselectiondialog.sip -gui/symbology-ng/qgsstylemanagerdialog.sip -gui/symbology-ng/qgsstylesavedialog.sip -gui/symbology-ng/qgssvgselectorwidget.sip -gui/symbology-ng/qgssymbollayerwidget.sip -gui/symbology-ng/qgssymbollevelsdialog.sip -gui/symbology-ng/qgssymbolslistwidget.sip -gui/symbology-ng/qgssymbolselectordialog.sip -gui/symbology-ng/qgssymbolwidgetcontext.sip -gui/symbology-ng/qgsvectorfieldsymbollayerwidget.sip analysis/vector/qgsgeometryanalyzer.sip analysis/vector/qgsgeometrysnapper.sip analysis/vector/qgspointsample.sip diff --git a/python/core/qgslogger.sip b/python/core/qgslogger.sip index 10ee06b98cb..346a567e28e 100644 --- a/python/core/qgslogger.sip +++ b/python/core/qgslogger.sip @@ -89,8 +89,12 @@ Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any. * }; -class QgsScopeLogger // clazy:exclude=rule-of-three +class QgsScopeLogger { + +%TypeHeaderCode +#include "qgslogger.h" +%End public: QgsScopeLogger( const char *file, const char *func, int line ); ~QgsScopeLogger(); diff --git a/python/gui/qgstextpreview.sip b/python/gui/qgstextpreview.sip index 8b9a61b7d15..6f95353f932 100644 --- a/python/gui/qgstextpreview.sip +++ b/python/gui/qgstextpreview.sip @@ -54,8 +54,8 @@ class QgsTextPreview : QLabel void setScale( double scale ); %Docstring - Sets the scale to use for previewing format sizes in map units. - \param scale preview map scale + Sets the ``scale`` to use for previewing format sizes in map units. + The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. .. seealso:: scale() .. seealso:: setMapUnits() %End @@ -63,6 +63,7 @@ class QgsTextPreview : QLabel double scale() const; %Docstring Returns the scale used for previewing format sizes in map units. + The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. .. seealso:: setScale() .. seealso:: mapUnits() :rtype: float diff --git a/python/gui/symbology-ng/qgs25drendererwidget.sip b/python/gui/symbology-ng/qgs25drendererwidget.sip index 4ef1a48ba3b..b65e24b4e5e 100644 --- a/python/gui/symbology-ng/qgs25drendererwidget.sip +++ b/python/gui/symbology-ng/qgs25drendererwidget.sip @@ -1,42 +1,50 @@ -/*************************************************************************** - qgs25drendererwidget.sip - Qgs25DRendererWidget +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgs25drendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ - --------------------- - begin : 14.1.2016 - copyright : (C) 2016 by Matthias Kuhn - email : matthias@opengis.ch - *************************************************************************** - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - ***************************************************************************/ -class Qgs25DRendererWidget : QgsRendererWidget + +class Qgs25DRendererWidget : QgsRendererWidget, protected Ui::Qgs25DRendererWidgetBase { + %TypeHeaderCode #include "qgs25drendererwidget.h" %End public: - /** Static creation method - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will take ownership) - */ + static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer /Transfer/ ) /Factory/; +%Docstring + Static creation method + \param layer the layer where this renderer is applied + \param style + \param renderer the mask renderer (will not take ownership) + :rtype: QgsRendererWidget +%End - /** Constructor - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will take ownership) - */ Qgs25DRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer /Transfer/ ); +%Docstring + Constructor + \param layer the layer where this renderer is applied + \param style + \param renderer the mask renderer (will not take ownership) +%End + + virtual QgsFeatureRenderer *renderer(); - QgsFeatureRenderer *renderer(); private: - void apply(); + virtual void apply() ; }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgs25drendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsarrowsymbollayerwidget.sip b/python/gui/symbology-ng/qgsarrowsymbollayerwidget.sip index f3c1ed8bbec..9665403985b 100644 --- a/python/gui/symbology-ng/qgsarrowsymbollayerwidget.sip +++ b/python/gui/symbology-ng/qgsarrowsymbollayerwidget.sip @@ -1,22 +1,44 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsarrowsymbollayerwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsArrowSymbolLayerWidget: QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgsarrowsymbollayerwidget.h" %End public: - /** Constructor - * @param layer the layer where this symbol layer is applied - * @param parent the parent widget - */ + QgsArrowSymbolLayerWidget( const QgsVectorLayer *layer, QWidget *parent /TransferThis/ = 0 ); +%Docstring + Constructor + \param layer the layer where this symbol layer is applied + \param parent the parent widget +%End - /** Static creation method - * @param layer the layer where this symbol layer is applied - */ static QgsSymbolLayerWidget *create( const QgsVectorLayer *layer ) /Factory/; +%Docstring + Static creation method + \param layer the layer where this symbol layer is applied + :rtype: QgsSymbolLayerWidget +%End - /** Set the symbol layer */ virtual void setSymbolLayer( QgsSymbolLayer *layer ); - /** Get the current symbol layer */ virtual QgsSymbolLayer *symbolLayer(); + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsarrowsymbollayerwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsbrushstylecombobox.sip b/python/gui/symbology-ng/qgsbrushstylecombobox.sip index 2af498f5a5f..0f0df337883 100644 --- a/python/gui/symbology-ng/qgsbrushstylecombobox.sip +++ b/python/gui/symbology-ng/qgsbrushstylecombobox.sip @@ -1,17 +1,41 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsbrushstylecombobox.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsBrushStyleComboBox : QComboBox { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgsbrushstylecombobox.h" +%End public: - QgsBrushStyleComboBox( QWidget *parent /TransferThis/ = NULL ); + QgsBrushStyleComboBox( QWidget *parent /TransferThis/ = 0 ); Qt::BrushStyle brushStyle() const; +%Docstring + :rtype: Qt.BrushStyle +%End void setBrushStyle( Qt::BrushStyle style ); protected: QIcon iconForBrush( Qt::BrushStyle style ); +%Docstring + :rtype: QIcon +%End }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsbrushstylecombobox.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgscategorizedsymbolrendererwidget.sip b/python/gui/symbology-ng/qgscategorizedsymbolrendererwidget.sip index b6d1eed7060..0a621a11873 100644 --- a/python/gui/symbology-ng/qgscategorizedsymbolrendererwidget.sip +++ b/python/gui/symbology-ng/qgscategorizedsymbolrendererwidget.sip @@ -1,26 +1,44 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + + class QgsCategorizedSymbolRendererWidget : QgsRendererWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgscategorizedsymbolrendererwidget.h" +%End public: static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring + :rtype: QgsRendererWidget +%End QgsCategorizedSymbolRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); ~QgsCategorizedSymbolRendererWidget(); virtual QgsFeatureRenderer *renderer(); - /** Replaces category symbols with the symbols from a style that have a matching - * name. - * @param style style containing symbols to match with - * @return number of symbols matched - * @see matchToSymbolsFromLibrary - * @see matchToSymbolsFromXml - * @note added in QGIS 2.9 - */ int matchToSymbols( QgsStyle *style ); +%Docstring + Replaces category symbols with the symbols from a style that have a matching + name. + \param style style containing symbols to match with + :return: number of symbols matched +.. seealso:: matchToSymbolsFromLibrary +.. seealso:: matchToSymbolsFromXml +.. versionadded:: 2.9 + :rtype: int +%End public slots: void changeCategorizedSymbol(); @@ -28,7 +46,12 @@ class QgsCategorizedSymbolRendererWidget : QgsRendererWidget void categoriesDoubleClicked( const QModelIndex &idx ); void addCategory(); void addCategories(); + void applyColorRamp(); +%Docstring + Applies the color ramp passed on by the color ramp button +%End + void deleteCategories(); void deleteAllCategories(); @@ -36,21 +59,23 @@ class QgsCategorizedSymbolRendererWidget : QgsRendererWidget void rowsMoved(); - /** Replaces category symbols with the symbols from the users' symbol library that have a - * matching name. - * @see matchToSymbolsFromXml - * @see matchToSymbols - * @note added in QGIS 2.9 - */ void matchToSymbolsFromLibrary(); +%Docstring + Replaces category symbols with the symbols from the users' symbol library that have a + matching name. +.. seealso:: matchToSymbolsFromXml +.. seealso:: matchToSymbols +.. versionadded:: 2.9 +%End - /** Prompts for selection of an xml file, then replaces category symbols with the symbols - * from the XML file with a matching name. - * @see matchToSymbolsFromLibrary - * @see matchToSymbols - * @note added in QGIS 2.9 - */ void matchToSymbolsFromXml(); +%Docstring + Prompts for selection of an xml file, then replaces category symbols with the symbols + from the XML file with a matching name. +.. seealso:: matchToSymbolsFromLibrary +.. seealso:: matchToSymbols +.. versionadded:: 2.9 +%End protected: @@ -58,22 +83,48 @@ class QgsCategorizedSymbolRendererWidget : QgsRendererWidget void updateCategorizedSymbolIcon(); - // Called by virtual refreshSymbolView() void populateCategories(); - //! return row index for the currently selected category (-1 if on no selection) int currentCategoryRow(); +%Docstring +return row index for the currently selected category (-1 if on no selection) + :rtype: int +%End - //! return a list of indexes for the categories unders selection QList selectedCategories(); +%Docstring +return a list of indexes for the categories unders selection + :rtype: list of int +%End - //! change the selected symbols alone for the change button, if there is a selection void changeSelectedSymbols(); +%Docstring +change the selected symbols alone for the change button, if there is a selection +%End void changeCategorySymbol(); - QList selectedSymbols(); + virtual QList selectedSymbols(); + QgsCategoryList selectedCategoryList(); - void refreshSymbolView(); - void keyPressEvent( QKeyEvent *event ); +%Docstring + :rtype: QgsCategoryList +%End + virtual void refreshSymbolView(); + + virtual void keyPressEvent( QKeyEvent *event ); + + + protected: + + + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgscptcitycolorrampdialog.sip b/python/gui/symbology-ng/qgscptcitycolorrampdialog.sip index 472a11240c2..7153b6d7995 100644 --- a/python/gui/symbology-ng/qgscptcitycolorrampdialog.sip +++ b/python/gui/symbology-ng/qgscptcitycolorrampdialog.sip @@ -1,46 +1,79 @@ -/** \ingroup gui - * \class QgsCptCityColorRampDialog - * A dialog which allows users to modify the properties of a QgsCptCityColorRamp. - * \note added in QGIS 3.0 - */ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgscptcitycolorrampdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + + + class QgsCptCityColorRampDialog : QDialog { -%TypeHeaderCode -#include +%Docstring + A dialog which allows users to modify the properties of a QgsCptCityColorRamp. +.. versionadded:: 3.0 %End +%TypeHeaderCode +#include "qgscptcitycolorrampdialog.h" +%End public: - /** Constructor for QgsCptCityColorRampDialog. - * @param ramp initial ramp to show in dialog - * @param parent parent widget - */ QgsCptCityColorRampDialog( const QgsCptCityColorRamp &ramp, QWidget *parent /TransferThis/ = 0 ); - ~QgsCptCityColorRampDialog(); +%Docstring + Constructor for QgsCptCityColorRampDialog. + \param ramp initial ramp to show in dialog + \param parent parent widget +%End - /** Returns a color ramp representing the current settings from the dialog. - * @see setRamp() - */ QgsCptCityColorRamp ramp() const; +%Docstring + Returns a color ramp representing the current settings from the dialog. +.. seealso:: setRamp() + :rtype: QgsCptCityColorRamp +%End - /** Sets the color ramp to show in the dialog. - * @param ramp color ramp - * @see ramp() - */ void setRamp( const QgsCptCityColorRamp &ramp ); +%Docstring + Sets the color ramp to show in the dialog. + \param ramp color ramp +.. seealso:: ramp() +%End - /** Returns the name of the ramp currently selected in the dialog. - */ QString selectedName() const; +%Docstring + Returns the name of the ramp currently selected in the dialog. + :rtype: str +%End - /** Returns true if the ramp should be converted to a QgsGradientColorRamp. - */ bool saveAsGradientRamp() const; +%Docstring + Returns true if the ramp should be converted to a QgsGradientColorRamp. + :rtype: bool +%End + + virtual bool eventFilter( QObject *obj, QEvent *event ); - bool eventFilter( QObject *obj, QEvent *event ); signals: - //! Emitted when the dialog settings change void changed(); +%Docstring +Emitted when the dialog settings change +%End + }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgscptcitycolorrampdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsdashspacedialog.sip b/python/gui/symbology-ng/qgsdashspacedialog.sip index edac08b65fd..6ac6d08d731 100644 --- a/python/gui/symbology-ng/qgsdashspacedialog.sip +++ b/python/gui/symbology-ng/qgsdashspacedialog.sip @@ -1,11 +1,36 @@ -class QgsDashSpaceDialog : QDialog +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsdashspacedialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + +class QgsDashSpaceDialog: QDialog { +%Docstring + A dialog to enter a custom dash space pattern for lines +%End + %TypeHeaderCode -#include +#include "qgsdashspacedialog.h" %End public: - QgsDashSpaceDialog( const QVector &v, QWidget *parent /TransferThis/ = 0, const Qt::WindowFlags &f = 0 ); - ~QgsDashSpaceDialog(); + QgsDashSpaceDialog( const QVector &v, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags f = 0 ); QVector dashDotVector() const; +%Docstring + :rtype: list of qreal +%End + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsdashspacedialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsellipsesymbollayerwidget.sip b/python/gui/symbology-ng/qgsellipsesymbollayerwidget.sip index 26a76c5b53e..5890c6647a7 100644 --- a/python/gui/symbology-ng/qgsellipsesymbollayerwidget.sip +++ b/python/gui/symbology-ng/qgsellipsesymbollayerwidget.sip @@ -1,14 +1,38 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsellipsesymbollayerwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsEllipseSymbolLayerWidget: QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgsellipsesymbollayerwidget.h" %End public: QgsEllipseSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); + + protected: + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsellipsesymbollayerwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsgraduatedhistogramwidget.sip b/python/gui/symbology-ng/qgsgraduatedhistogramwidget.sip index 437e0b755a4..e282a4e19c3 100644 --- a/python/gui/symbology-ng/qgsgraduatedhistogramwidget.sip +++ b/python/gui/symbology-ng/qgsgraduatedhistogramwidget.sip @@ -1,42 +1,63 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsgraduatedhistogramwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ -/** \ingroup gui - * \class QgsGraduatedHistogramWidget - * \brief Graphical histogram for displaying distribution of field values and - * editing range breaks for a QgsGraduatedSymbolRenderer renderer. - * - * \note Added in version 2.9 - */ -class QgsGraduatedHistogramWidget : QWidget + + + +class QgsGraduatedHistogramWidget : QgsHistogramWidget { -%TypeHeaderCode -#include +%Docstring + Graphical histogram for displaying distribution of field values and + editing range breaks for a QgsGraduatedSymbolRenderer renderer. + +.. versionadded:: 2.9 %End +%TypeHeaderCode +#include "qgsgraduatedhistogramwidget.h" +%End public: - /** QgsGraduatedHistogramWidget constructor - * @param parent parent widget - */ QgsGraduatedHistogramWidget( QWidget *parent /TransferThis/ = 0 ); - ~QgsGraduatedHistogramWidget(); +%Docstring + QgsGraduatedHistogramWidget constructor + \param parent parent widget +%End - /** Sets the QgsGraduatedSymbolRenderer renderer associated with the histogram. - * The histogram will fetch the ranges from the renderer before every refresh. - * @param renderer associated QgsGraduatedSymbolRenderer - */ void setRenderer( QgsGraduatedSymbolRenderer *renderer ); +%Docstring + Sets the QgsGraduatedSymbolRenderer renderer associated with the histogram. + The histogram will fetch the ranges from the renderer before every refresh. + \param renderer associated QgsGraduatedSymbolRenderer +%End signals: - /** Emitted when the user modifies the graduated ranges using the histogram widget. - * @param rangesAdded true if the user has added ranges, false if the user has just - * modified existing range breaks - */ void rangesModified( bool rangesAdded ); +%Docstring + Emitted when the user modifies the graduated ranges using the histogram widget. + \param rangesAdded true if the user has added ranges, false if the user has just + modified existing range breaks +%End protected: virtual void drawHistogram(); }; + + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsgraduatedhistogramwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.sip b/python/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.sip index 28b41c8144b..82b6b4f4bbe 100644 --- a/python/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.sip +++ b/python/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.sip @@ -1,10 +1,26 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + class QgsGraduatedSymbolRendererWidget : QgsRendererWidget { + %TypeHeaderCode -#include +#include "qgsgraduatedsymbolrendererwidget.h" %End public: static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring + :rtype: QgsRendererWidget +%End QgsGraduatedSymbolRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); ~QgsGraduatedSymbolRendererWidget(); @@ -21,14 +37,22 @@ class QgsGraduatedSymbolRendererWidget : QgsRendererWidget void rangesClicked( const QModelIndex &idx ); void changeCurrentValue( QStandardItem *item ); - /** Adds a class manually to the classification*/ void addClass(); - /** Removes currently selected classes */ +%Docstring +Adds a class manually to the classification +%End void deleteClasses(); - /** Removes all classes from the classification*/ +%Docstring +Removes currently selected classes +%End void deleteAllClasses(); - /** Toggle the link between classes boundaries */ +%Docstring +Removes all classes from the classification +%End void toggleBoundariesLink( bool linked ); +%Docstring +Toggle the link between classes boundaries +%End void labelFormatChanged(); @@ -36,7 +60,6 @@ class QgsGraduatedSymbolRendererWidget : QgsRendererWidget void rowsMoved(); void modelDataChanged(); - void on_mSizeUnitWidget_changed(); void on_methodComboBox_currentIndexChanged( int ); void refreshRanges( bool reset = false ); @@ -46,21 +69,46 @@ class QgsGraduatedSymbolRendererWidget : QgsRendererWidget void connectUpdateHandlers(); void disconnectUpdateHandlers(); bool rowsOrdered(); +%Docstring + :rtype: bool +%End void updateGraduatedSymbolIcon(); - //! return a list of indexes for the classes under selection QList selectedClasses(); +%Docstring +return a list of indexes for the classes under selection + :rtype: list of int +%End QgsRangeList selectedRanges(); +%Docstring + :rtype: QgsRangeList +%End void changeRangeSymbol( int rangeIdx ); void changeRange( int rangeIdx ); void changeSelectedSymbols(); - QList selectedSymbols(); - QgsSymbol *findSymbolForRange( double lowerBound, double upperBound, const QgsRangeList &ranges ) const; - void refreshSymbolView(); + virtual QList selectedSymbols(); + + QgsSymbol *findSymbolForRange( double lowerBound, double upperBound, const QgsRangeList &ranges ) const; +%Docstring + :rtype: QgsSymbol +%End + virtual void refreshSymbolView(); + + + virtual void keyPressEvent( QKeyEvent *event ); + - void keyPressEvent( QKeyEvent *event ); }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsheatmaprendererwidget.sip b/python/gui/symbology-ng/qgsheatmaprendererwidget.sip index 7ccec52c05f..133d1531ee3 100644 --- a/python/gui/symbology-ng/qgsheatmaprendererwidget.sip +++ b/python/gui/symbology-ng/qgsheatmaprendererwidget.sip @@ -1,25 +1,48 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsheatmaprendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsHeatmapRendererWidget : QgsRendererWidget { + %TypeHeaderCode -#include +#include "qgsheatmaprendererwidget.h" %End public: - /** Static creation method - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will take ownership) - */ + static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring + Static creation method + \param layer the layer where this renderer is applied + \param style + \param renderer the mask renderer (will not take ownership) + :rtype: QgsRendererWidget +%End - /** Constructor - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will take ownership) - */ QgsHeatmapRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); +%Docstring + Constructor + \param layer the layer where this renderer is applied + \param style + \param renderer the mask renderer (will not take ownership) +%End - /** @returns the current feature renderer */ virtual QgsFeatureRenderer *renderer(); - virtual void setContext( const QgsSymbolWidgetContext &context ); + }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsheatmaprendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsinvertedpolygonrendererwidget.sip b/python/gui/symbology-ng/qgsinvertedpolygonrendererwidget.sip index ab87ca5d00e..145df502e34 100644 --- a/python/gui/symbology-ng/qgsinvertedpolygonrendererwidget.sip +++ b/python/gui/symbology-ng/qgsinvertedpolygonrendererwidget.sip @@ -1,24 +1,57 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsInvertedPolygonRendererWidget : QgsRendererWidget { +%Docstring + A widget used represent options of a QgsInvertedPolygonRenderer + +.. versionadded:: 2.4 +%End + %TypeHeaderCode -#include +#include "qgsinvertedpolygonrendererwidget.h" %End public: - /** Static creation method - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will take ownership) - */ + static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring + Static creation method + \param layer the layer where this renderer is applied + \param style + \param renderer the mask renderer (will not take ownership) + :rtype: QgsRendererWidget +%End - /** Constructor - * @param layer the layer where this renderer is applied - * @param style - * @param renderer the mask renderer (will take ownership) - */ QgsInvertedPolygonRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); +%Docstring + Constructor + \param layer the layer where this renderer is applied + \param style + \param renderer the mask renderer (will not take ownership) +%End - /** @returns the current feature renderer */ virtual QgsFeatureRenderer *renderer(); + virtual void setContext( const QgsSymbolWidgetContext &context ); + + + protected: + }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsinvertedpolygonrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgslayerpropertieswidget.sip b/python/gui/symbology-ng/qgslayerpropertieswidget.sip index a9d87094116..96a54f0c0f1 100644 --- a/python/gui/symbology-ng/qgslayerpropertieswidget.sip +++ b/python/gui/symbology-ng/qgslayerpropertieswidget.sip @@ -1,25 +1,47 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgslayerpropertieswidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + + class QgsLayerPropertiesWidget : QgsPanelWidget, QgsExpressionContextGenerator { + %TypeHeaderCode -#include +#include "qgslayerpropertieswidget.h" +%End + public: + QgsLayerPropertiesWidget( QgsSymbolLayer *layer, const QgsSymbol *symbol, const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); + + void setContext( const QgsSymbolWidgetContext &context ); +%Docstring + Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + \param context symbol widget context +.. seealso:: context() +.. versionadded:: 3.0 %End - public: - QgsLayerPropertiesWidget( QgsSymbolLayer *layer, const QgsSymbol *symbol, const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); - - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() - * @note added in QGIS 3.0 - */ - void setContext( const QgsSymbolWidgetContext &context ); - - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() - * @note added in QGIS 3.0 - */ QgsSymbolWidgetContext context() const; +%Docstring + Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. +.. seealso:: setContext() +.. versionadded:: 3.0 + :rtype: QgsSymbolWidgetContext +%End + virtual void setDockMode( bool dockMode ); +%Docstring + Set the widget in dock mode which tells the widget to emit panel + widgets and not open dialogs + \param dockMode True to enable dock mode. +%End public slots: void layerTypeChanged(); @@ -27,11 +49,32 @@ class QgsLayerPropertiesWidget : QgsPanelWidget, QgsExpressionContextGenerator signals: void changed(); - void changeLayer( QgsSymbolLayer* ); + void changeLayer( QgsSymbolLayer * ); protected: void populateLayerTypes(); void updateSymbolLayerWidget( QgsSymbolLayer *layer ); + virtual QgsExpressionContext createExpressionContext() const; + + void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key ); +%Docstring + Registers a data defined override button. Handles setting up connections + for the button and initializing the button to show the correct descriptions + and help text for the associated property. +.. versionadded:: 3.0 +%End + + protected: // data + + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgslayerpropertieswidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsnullsymbolrendererwidget.sip b/python/gui/symbology-ng/qgsnullsymbolrendererwidget.sip index 27313451b55..c27610597fb 100644 --- a/python/gui/symbology-ng/qgsnullsymbolrendererwidget.sip +++ b/python/gui/symbology-ng/qgsnullsymbolrendererwidget.sip @@ -1,24 +1,55 @@ -/** \ingroup gui - * \class QgsNullSymbolRendererWidget - * \brief Blank widget for customising QgsNullSymbolRenderer. - * \note Added in version 2.16 - */ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsnullsymbolrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + class QgsNullSymbolRendererWidget : QgsRendererWidget { -%TypeHeaderCode -#include +%Docstring + Blank widget for customising QgsNullSymbolRenderer. +.. versionadded:: 2.16 %End +%TypeHeaderCode +#include "qgsnullsymbolrendererwidget.h" +%End public: - //! Creates a new QgsNullSymbolRendererWidget object static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring +Creates a new QgsNullSymbolRendererWidget object + :rtype: QgsRendererWidget +%End - //! Constructor for QgsNullSymbolRendererWidget QgsNullSymbolRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); +%Docstring +Constructor for QgsNullSymbolRendererWidget +%End ~QgsNullSymbolRendererWidget(); - //! Returns a pointer to the configured renderer virtual QgsFeatureRenderer *renderer(); +%Docstring +Returns a pointer to the configured renderer + :rtype: QgsFeatureRenderer +%End + + protected: + + }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsnullsymbolrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgspenstylecombobox.sip b/python/gui/symbology-ng/qgspenstylecombobox.sip index 582e3a1181c..48bdbc1ca78 100644 --- a/python/gui/symbology-ng/qgspenstylecombobox.sip +++ b/python/gui/symbology-ng/qgspenstylecombobox.sip @@ -1,45 +1,75 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgspenstylecombobox.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsPenStyleComboBox : QComboBox { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgspenstylecombobox.h" +%End public: - QgsPenStyleComboBox( QWidget *parent /TransferThis/ = NULL ); + QgsPenStyleComboBox( QWidget *parent /TransferThis/ = 0 ); Qt::PenStyle penStyle() const; +%Docstring + :rtype: Qt.PenStyle +%End void setPenStyle( Qt::PenStyle style ); protected: QIcon iconForPen( Qt::PenStyle style ); +%Docstring + :rtype: QIcon +%End }; class QgsPenJoinStyleComboBox : QComboBox { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgspenstylecombobox.h" +%End public: - QgsPenJoinStyleComboBox( QWidget *parent /TransferThis/ = NULL ); + QgsPenJoinStyleComboBox( QWidget *parent /TransferThis/ = 0 ); Qt::PenJoinStyle penJoinStyle() const; +%Docstring + :rtype: Qt.PenJoinStyle +%End void setPenJoinStyle( Qt::PenJoinStyle style ); }; class QgsPenCapStyleComboBox : QComboBox { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgspenstylecombobox.h" +%End public: - QgsPenCapStyleComboBox( QWidget *parent /TransferThis/ = NULL ); + QgsPenCapStyleComboBox( QWidget *parent /TransferThis/ = 0 ); Qt::PenCapStyle penCapStyle() const; +%Docstring + :rtype: Qt.PenCapStyle +%End void setPenCapStyle( Qt::PenCapStyle style ); }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgspenstylecombobox.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgspointclusterrendererwidget.sip b/python/gui/symbology-ng/qgspointclusterrendererwidget.sip index e32d5a2fcf5..90eb36b629f 100644 --- a/python/gui/symbology-ng/qgspointclusterrendererwidget.sip +++ b/python/gui/symbology-ng/qgspointclusterrendererwidget.sip @@ -1,33 +1,59 @@ -/** \class QgsPointClusterRendererWidget - * \ingroup gui - * A widget which allows configuration of the properties for a QgsPointClusterRenderer. - * \note added in QGIS 3.0 - */ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgspointclusterrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + class QgsPointClusterRendererWidget: QgsRendererWidget { +%Docstring + A widget which allows configuration of the properties for a QgsPointClusterRenderer. +.. versionadded:: 3.0 +%End + %TypeHeaderCode -#include +#include "qgspointclusterrendererwidget.h" %End public: - /** Returns a new QgsPointClusterRendererWidget. - * @param layer associated vector layer - * @param style style collection - * @param renderer source QgsPointClusterRenderer renderer - * @returns new QgsRendererWidget - */ static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring + Returns a new QgsPointClusterRendererWidget. + \param layer associated vector layer + \param style style collection + \param renderer source QgsPointClusterRenderer renderer + :return: new QgsRendererWidget + :rtype: QgsRendererWidget +%End - /** Constructor for QgsPointClusterRendererWidget. - * @param layer associated vector layer - * @param style style collection - * @param renderer source QgsPointClusterRenderer renderer - */ QgsPointClusterRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); +%Docstring + Constructor for QgsPointClusterRendererWidget. + \param layer associated vector layer + \param style style collection + \param renderer source QgsPointClusterRenderer renderer +%End ~QgsPointClusterRendererWidget(); - QgsFeatureRenderer *renderer(); - void setContext( const QgsSymbolWidgetContext &context ); + virtual QgsFeatureRenderer *renderer(); + + virtual void setContext( const QgsSymbolWidgetContext &context ); + + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgspointclusterrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgspointdisplacementrendererwidget.sip b/python/gui/symbology-ng/qgspointdisplacementrendererwidget.sip index 5f5079b1138..4b67f1eaee4 100644 --- a/python/gui/symbology-ng/qgspointdisplacementrendererwidget.sip +++ b/python/gui/symbology-ng/qgspointdisplacementrendererwidget.sip @@ -1,13 +1,40 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgspointdisplacementrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + class QgsPointDisplacementRendererWidget: QgsRendererWidget { + %TypeHeaderCode -#include +#include "qgspointdisplacementrendererwidget.h" %End public: static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring + :rtype: QgsRendererWidget +%End QgsPointDisplacementRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); ~QgsPointDisplacementRendererWidget(); - QgsFeatureRenderer *renderer(); - void setContext( const QgsSymbolWidgetContext &context ); + virtual QgsFeatureRenderer *renderer(); + + virtual void setContext( const QgsSymbolWidgetContext &context ); + + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgspointdisplacementrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsrendererpropertiesdialog.sip b/python/gui/symbology-ng/qgsrendererpropertiesdialog.sip index cfcf6f1b810..7bbb846acea 100644 --- a/python/gui/symbology-ng/qgsrendererpropertiesdialog.sip +++ b/python/gui/symbology-ng/qgsrendererpropertiesdialog.sip @@ -1,93 +1,132 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsrendererpropertiesdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + + + class QgsRendererPropertiesDialog : QDialog { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgsrendererpropertiesdialog.h" +%End public: - /** Constructor for QgsRendererPropertiesDialog. - * @param layer associated layer - * @param style style collection - * @param embedded set to true to indicate that the dialog will be embedded in another widget, rather - * than shown as a dialog by itself - * @param parent parent widget - */ QgsRendererPropertiesDialog( QgsVectorLayer *layer, QgsStyle *style, bool embedded = false, QWidget *parent /TransferThis/ = 0 ); - +%Docstring + Constructor for QgsRendererPropertiesDialog. + \param layer associated layer + \param style style collection + \param embedded set to true to indicate that the dialog will be embedded in another widget, rather + than shown as a dialog by itself + \param parent parent widget +%End ~QgsRendererPropertiesDialog(); - /** Sets the map canvas associated with the dialog. This allows the widget to retrieve the current - * map scale and other properties from the canvas. - * @param canvas map canvas - * @note added in QGIS 2.12 - */ void setMapCanvas( QgsMapCanvas *canvas ); +%Docstring + Sets the map canvas associated with the dialog. This allows the widget to retrieve the current + map scale and other properties from the canvas. + \param canvas map canvas +.. versionadded:: 2.12 +%End - /** - * Set the widget in dock mode which tells the widget to emit panel - * widgets and not open dialogs - * @param dockMode True to enable dock mode. - */ void setDockMode( bool dockMode ); +%Docstring + Set the widget in dock mode which tells the widget to emit panel + widgets and not open dialogs + \param dockMode True to enable dock mode. +%End signals: - /** - * Emitted when expression context variables on the associated - * vector layers have been changed. Will request the parent dialog - * to re-synchronize with the variables. - */ + void layerVariablesChanged(); +%Docstring + Emitted when expression context variables on the associated + vector layers have been changed. Will request the parent dialog + to re-synchronize with the variables. +%End - /** - * Emitted when something on the widget has changed. - * All widgets will fire this event to notify of an internal change. - */ void widgetChanged(); +%Docstring + Emitted when something on the widget has changed. + All widgets will fire this event to notify of an internal change. +%End - /** - * Emit when you require a panel to be show in the interface. - * @param panel The panel widget to show. - * @note If you are connected to this signal you should also connect - * given panels showPanel signal as they can be nested. - */ void showPanel( QgsPanelWidget *panel ); +%Docstring + Emit when you require a panel to be show in the interface. + \param panel The panel widget to show. +.. note:: + + If you are connected to this signal you should also connect + given panels showPanel signal as they can be nested. +%End public slots: - //! called when user changes renderer type void rendererChanged(); +%Docstring +called when user changes renderer type +%End - //! Apply the changes from the dialog to the layer. void apply(); +%Docstring +Apply the changes from the dialog to the layer. +%End - //! Apply and accept the changes for the dialog. void onOK(); +%Docstring +Apply and accept the changes for the dialog. +%End - /** - * Open a panel or dialog depending on dock mode setting - * If dock mode is true this method will emit the showPanel signal - * for connected slots to handle the open event. - * - * If dock mode is false this method will open a dialog - * and block the user. - * - * @param panel The panel widget to open. - */ void openPanel( QgsPanelWidget *panel ); +%Docstring + Open a panel or dialog depending on dock mode setting + If dock mode is true this method will emit the showPanel signal + for connected slots to handle the open event. + + If dock mode is false this method will open a dialog + and block the user. + + \param panel The panel widget to open. +%End + protected: - /** - * Connect the given slot to the value changed event for the set of widgets - * Each widget is checked for type and the common type of signal is connected - * to the slot. - * - * @param widgets The list of widgets to check. - * @param slot The slot to connect to the signals. - */ + void connectValueChanged( const QList &widgets, const char *slot ); +%Docstring + Connect the given slot to the value changed event for the set of widgets + Each widget is checked for type and the common type of signal is connected + to the slot. + + \param widgets The list of widgets to check. + \param slot The slot to connect to the signals. +%End + + virtual void keyPressEvent( QKeyEvent *event ); + + + + - //! Reimplements dialog keyPress event so we can ignore it - void keyPressEvent( QKeyEvent *event ); }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsrendererpropertiesdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsrendererwidget.sip b/python/gui/symbology-ng/qgsrendererwidget.sip index 6259e7e21c6..64e6285030a 100644 --- a/python/gui/symbology-ng/qgsrendererwidget.sip +++ b/python/gui/symbology-ng/qgsrendererwidget.sip @@ -1,187 +1,267 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsRendererWidget : QgsPanelWidget { -%TypeHeaderCode -#include +%Docstring +Base class for renderer settings widgets + +WORKFLOW: +- open renderer dialog with some RENDERER (never null!) +- find out which widget to use +- instantiate it and set in stacked widget +- on any change of renderer type, create some default (dummy?) version and change the stacked widget +- when clicked ok/apply, get the renderer from active widget and clone it for the layer %End +%TypeHeaderCode +#include "qgsrendererwidget.h" +%End public: QgsRendererWidget( QgsVectorLayer *layer, QgsStyle *style ); - virtual ~QgsRendererWidget(); - - //! return pointer to the renderer (no transfer of ownership) virtual QgsFeatureRenderer *renderer() = 0; +%Docstring +return pointer to the renderer (no transfer of ownership) + :rtype: QgsFeatureRenderer +%End - //! show a dialog with renderer's symbol level settings void showSymbolLevelsDialog( QgsFeatureRenderer *r ); +%Docstring +show a dialog with renderer's symbol level settings +%End - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() - * @note added in QGIS 3.0 - */ - void setContext( const QgsSymbolWidgetContext &context ); + virtual void setContext( const QgsSymbolWidgetContext &context ); +%Docstring + Sets the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. + \param context symbol widget context +.. seealso:: context() +.. versionadded:: 3.0 +%End - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() - * @note added in QGIS 3.0 - */ QgsSymbolWidgetContext context() const; +%Docstring + Returns the context in which the renderer widget is shown, e.g., the associated map canvas and expression contexts. +.. seealso:: setContext() +.. versionadded:: 3.0 + :rtype: QgsSymbolWidgetContext +%End - /** Returns the vector layer associated with the widget. - * @note added in QGIS 2.12 - */ const QgsVectorLayer *vectorLayer() const; +%Docstring + Returns the vector layer associated with the widget. +.. versionadded:: 2.12 + :rtype: QgsVectorLayer +%End - /** - * This method should be called whenever the renderer is actually set on the layer. - */ void applyChanges(); +%Docstring + This method should be called whenever the renderer is actually set on the layer. +%End signals: - /** - * Emitted when expression context variables on the associated - * vector layers have been changed. Will request the parent dialog - * to re-synchronize with the variables. - */ + void layerVariablesChanged(); +%Docstring + Emitted when expression context variables on the associated + vector layers have been changed. Will request the parent dialog + to re-synchronize with the variables. +%End protected: - /** Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods - and by connecting the slot contextMenuViewCategories(const QPoint&)*/ - virtual QList selectedSymbols(); + + + virtual QList selectedSymbols(); +%Docstring + Subclasses may provide the capability of changing multiple symbols at once by implementing the following two methods +and by connecting the slot contextMenuViewCategories(const QPoint&)* + :rtype: list of QgsSymbol +%End virtual void refreshSymbolView(); protected slots: void contextMenuViewCategories( QPoint p ); - /** Change color of selected symbols*/ void changeSymbolColor(); - /** Change opacity of selected symbols*/ +%Docstring +Change color of selected symbols +%End void changeSymbolOpacity(); - /** Change units mm/map units of selected symbols*/ +%Docstring +Change opacity of selected symbols +%End void changeSymbolUnit(); - /** Change line widths of selected symbols*/ +%Docstring +Change units mm/map units of selected symbols +%End void changeSymbolWidth(); - /** Change marker sizes of selected symbols*/ +%Docstring +Change line widths of selected symbols +%End void changeSymbolSize(); - /** Change marker angles of selected symbols*/ +%Docstring +Change marker sizes of selected symbols +%End void changeSymbolAngle(); +%Docstring +Change marker angles of selected symbols +%End virtual void copy(); virtual void paste(); private: - /** - * This will be called whenever the renderer is set on a layer. - * This can be overwritten in subclasses. - */ - virtual void apply(); - + virtual void apply() ; +%Docstring + This will be called whenever the renderer is set on a layer. + This can be overwritten in subclasses. +%End }; -/** -Utility classes for "en masse" size definition -*/ + + + + + class QgsDataDefinedValueDialog : QDialog { -%TypeHeaderCode -#include +%Docstring +Utility classes for "en masse" size definition %End +%TypeHeaderCode +#include "qgsrendererwidget.h" +%End public: - /** Constructor - * @param symbolList must not be empty - * @param layer must not be null - * @param label value label - */ - QgsDataDefinedValueDialog( const QList &symbolList, QgsVectorLayer *layer, const QString &label ); - virtual ~QgsDataDefinedValueDialog(); - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() - * @note added in QGIS 3.0 - */ + QgsDataDefinedValueDialog( const QList &symbolList, QgsVectorLayer *layer, const QString &label ); +%Docstring + Constructor + \param symbolList must not be empty + \param layer must not be null + \param label value label +%End + void setContext( const QgsSymbolWidgetContext &context ); +%Docstring + Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + \param context symbol widget context +.. seealso:: context() +.. versionadded:: 3.0 +%End - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() - * @note added in QGIS 3.0 - */ QgsSymbolWidgetContext context() const; +%Docstring + Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. +.. seealso:: setContext() +.. versionadded:: 3.0 + :rtype: QgsSymbolWidgetContext +%End - /** Returns the vector layer associated with the widget. - * @note added in QGIS 2.12 - */ const QgsVectorLayer *vectorLayer() const; +%Docstring + Returns the vector layer associated with the widget. +.. versionadded:: 2.12 + :rtype: QgsVectorLayer +%End public slots: void dataDefinedChanged(); protected: - /** - * Should be called in the constructor of child classes. - * - * @note May be missing Python bindings depending on the platform. - */ + void init( int propertyKey ); // needed in children ctor to call virtual private: - QgsProperty symbolDataDefined() const; - virtual QgsProperty symbolDataDefined( const QgsSymbol* ) const = 0; - virtual double value( const QgsSymbol* ) const = 0; - virtual void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ) = 0; + QgsProperty symbolDataDefined() const ; +%Docstring + :rtype: QgsProperty +%End + private: + virtual QgsProperty symbolDataDefined( const QgsSymbol * ) const = 0 ; +%Docstring + :rtype: QgsProperty +%End + private: + virtual double value( const QgsSymbol * ) const = 0 ; +%Docstring + :rtype: float +%End + private: + virtual void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ) = 0 ; }; class QgsDataDefinedSizeDialog : QgsDataDefinedValueDialog { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgsrendererwidget.h" +%End public: - QgsDataDefinedSizeDialog( const QList &symbolList, QgsVectorLayer *layer ); + QgsDataDefinedSizeDialog( const QList &symbolList, QgsVectorLayer *layer ); protected: - virtual QgsProperty symbolDataDefined( const QgsSymbol* ) const; + virtual QgsProperty symbolDataDefined( const QgsSymbol *symbol ) const; + + + virtual double value( const QgsSymbol *symbol ) const; + + virtual void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ); - double value( const QgsSymbol *symbol ) const; - void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ); }; class QgsDataDefinedRotationDialog : QgsDataDefinedValueDialog { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgsrendererwidget.h" +%End public: - QgsDataDefinedRotationDialog( const QList &symbolList, QgsVectorLayer *layer ); + QgsDataDefinedRotationDialog( const QList &symbolList, QgsVectorLayer *layer ); protected: - virtual QgsProperty symbolDataDefined( const QgsSymbol* ) const; + virtual QgsProperty symbolDataDefined( const QgsSymbol *symbol ) const; - double value( const QgsSymbol *symbol ) const; - void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ); + virtual double value( const QgsSymbol *symbol ) const; + + virtual void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ); + }; - class QgsDataDefinedWidthDialog : QgsDataDefinedValueDialog { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgsrendererwidget.h" +%End public: - QgsDataDefinedWidthDialog( const QList &symbolList, QgsVectorLayer *layer ); + QgsDataDefinedWidthDialog( const QList &symbolList, QgsVectorLayer *layer ); protected: - virtual QgsProperty symbolDataDefined( const QgsSymbol* ) const; + virtual QgsProperty symbolDataDefined( const QgsSymbol *symbol ) const; - double value( const QgsSymbol *symbol ) const; - void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ); + virtual double value( const QgsSymbol *symbol ) const; + + virtual void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ); + }; + + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsrulebasedrendererwidget.sip b/python/gui/symbology-ng/qgsrulebasedrendererwidget.sip index 039f19962bc..9b9c9146f16 100644 --- a/python/gui/symbology-ng/qgsrulebasedrendererwidget.sip +++ b/python/gui/symbology-ng/qgsrulebasedrendererwidget.sip @@ -1,9 +1,30 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsrulebasedrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + + + class QgsRuleBasedRendererModel : QAbstractItemModel { -%TypeHeaderCode -#include +%Docstring +Tree model for the rules: + +(invalid) == root node ++--- top level rule ++--- top level rule %End +%TypeHeaderCode +#include "qgsrulebasedrendererwidget.h" +%End public: QgsRuleBasedRendererModel( QgsRuleBasedRenderer *r ); @@ -13,50 +34,57 @@ class QgsRuleBasedRendererModel : QAbstractItemModel int role = Qt::DisplayRole ) const; virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const; virtual int columnCount( const QModelIndex & = QModelIndex() ) const; - //! provide model index for parent's child item virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const; - //! provide parent model index virtual QModelIndex parent( const QModelIndex &index ) const; - // editing support virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ); - // drag'n'drop support - Qt::DropActions supportedDropActions() const; - QStringList mimeTypes() const; - QMimeData *mimeData( const QModelIndexList &indexes ) const; - bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ); + virtual Qt::DropActions supportedDropActions() const; + + virtual QStringList mimeTypes() const; + + virtual QMimeData *mimeData( const QModelIndexList &indexes ) const; + + virtual bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ); + + + virtual bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ); - bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ); - // new methods QgsRuleBasedRenderer::Rule *ruleForIndex( const QModelIndex &index ) const; +%Docstring + :rtype: QgsRuleBasedRenderer.Rule +%End void insertRule( const QModelIndex &parent, int before, QgsRuleBasedRenderer::Rule *newrule ); void updateRule( const QModelIndex &parent, int row ); - // update rule and all its descendants void updateRule( const QModelIndex &index ); void removeRule( const QModelIndex &index ); - void willAddRules( const QModelIndex &parent, int count ); + void willAddRules( const QModelIndex &parent, int count ); // call beginInsertRows void finishedAddingRules(); // call endInsertRows - //! @note not available in python bindungs - // void setFeatureCounts( QMap countMap ); void clearFeatureCounts(); + protected: }; + + + class QgsRuleBasedRendererWidget : QgsRendererWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgsrulebasedrendererwidget.h" +%End public: static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring + :rtype: QgsRendererWidget +%End QgsRuleBasedRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); ~QgsRuleBasedRendererWidget(); @@ -86,65 +114,141 @@ class QgsRuleBasedRendererWidget : QgsRendererWidget protected: void refineRule( int type ); - //! Opens the dialog for refining a rule using categories void refineRuleCategoriesGui(); - //! Opens the dialog for refining a rule using ranges +%Docstring +Opens the dialog for refining a rule using categories +%End void refineRuleRangesGui(); +%Docstring +Opens the dialog for refining a rule using ranges +%End void refineRuleScalesGui( const QModelIndexList &index ); QgsRuleBasedRenderer::Rule *currentRule(); - - QList selectedSymbols(); - QList selectedRules(); - void refreshSymbolView(); - void keyPressEvent( QKeyEvent *event ); -}; - -/////// - -class QgsRendererRulePropsWidget: QgsPanelWidget -{ -%TypeHeaderCode -#include +%Docstring + :rtype: QgsRuleBasedRenderer.Rule %End - public: - /** - * Widget to edit the details of a rule based renderer rule. - * @param rule The rule to edit. - * @param layer The layer used to pull layer related information. - * @param style The active QGIS style. - * @param parent The parent widget. - * @param context the symbol widget context - */ - QgsRendererRulePropsWidget( QgsRuleBasedRenderer::Rule *rule, QgsVectorLayer *layer, QgsStyle *style, QWidget *parent /TransferThis/ = 0, const QgsSymbolWidgetContext &context= QgsSymbolWidgetContext() ); - ~QgsRendererRulePropsWidget(); + virtual QList selectedSymbols(); + + QgsRuleBasedRenderer::RuleList selectedRules(); +%Docstring + :rtype: QgsRuleBasedRenderer.RuleList +%End + virtual void refreshSymbolView(); + + virtual void keyPressEvent( QKeyEvent *event ); + + + + + + protected slots: + virtual void copy(); + + virtual void paste(); - QgsRuleBasedRenderer::Rule *rule(); - public slots: - void testFilter(); - void buildExpression(); - void apply(); - virtual void setDockMode( bool dockMode); }; + + +class QgsRendererRulePropsWidget : QgsPanelWidget +{ + +%TypeHeaderCode +#include "qgsrulebasedrendererwidget.h" +%End + public: + + QgsRendererRulePropsWidget( QgsRuleBasedRenderer::Rule *rule, + QgsVectorLayer *layer, + QgsStyle *style, + QWidget *parent /TransferThis/ = 0, + const QgsSymbolWidgetContext &context = QgsSymbolWidgetContext() ); +%Docstring + Widget to edit the details of a rule based renderer rule. + \param rule The rule to edit. + \param layer The layer used to pull layer related information. + \param style The active QGIS style. + \param parent The parent widget. + \param context the symbol widget context +%End + + QgsRuleBasedRenderer::Rule *rule(); +%Docstring + Return the current set rule. + :return: The current rule. + :rtype: QgsRuleBasedRenderer.Rule +%End + + public slots: + + void testFilter(); +%Docstring + Test the filter that is set in the widget +%End + + void buildExpression(); +%Docstring + Open the expression builder widget to check if the +%End + + void apply(); +%Docstring + Apply any changes from the widget to the set rule. +%End + + virtual void setDockMode( bool dockMode ); +%Docstring + Set the widget in dock mode. + \param dockMode True for dock mode. +%End + + protected: + + +}; + class QgsRendererRulePropsDialog : QDialog { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgsrulebasedrendererwidget.h" +%End public: QgsRendererRulePropsDialog( QgsRuleBasedRenderer::Rule *rule, QgsVectorLayer *layer, QgsStyle *style, QWidget *parent /TransferThis/ = 0, const QgsSymbolWidgetContext &context = QgsSymbolWidgetContext() ); +%Docstring + Constructor for QgsRendererRulePropsDialog + \param rule associated rule based renderer rule + \param layer source vector layer + \param style style collection + \param parent parent widget + \param context symbol widget context +%End + ~QgsRendererRulePropsDialog(); QgsRuleBasedRenderer::Rule *rule(); +%Docstring + :rtype: QgsRuleBasedRenderer.Rule +%End public slots: void testFilter(); void buildExpression(); - void accept(); + virtual void accept(); + + }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsrulebasedrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgssinglesymbolrendererwidget.sip b/python/gui/symbology-ng/qgssinglesymbolrendererwidget.sip index b061ab63dd0..d5cf35c2d70 100644 --- a/python/gui/symbology-ng/qgssinglesymbolrendererwidget.sip +++ b/python/gui/symbology-ng/qgssinglesymbolrendererwidget.sip @@ -1,10 +1,25 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssinglesymbolrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + class QgsSingleSymbolRendererWidget : QgsRendererWidget { + %TypeHeaderCode -#include +#include "qgssinglesymbolrendererwidget.h" %End public: static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ) /Factory/; +%Docstring + :rtype: QgsRendererWidget +%End QgsSingleSymbolRendererWidget( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); ~QgsSingleSymbolRendererWidget(); @@ -14,9 +29,26 @@ class QgsSingleSymbolRendererWidget : QgsRendererWidget virtual void setContext( const QgsSymbolWidgetContext &context ); virtual void setDockMode( bool dockMode ); +%Docstring + Set the widget in dock mode which tells the widget to emit panel + widgets and not open dialogs + \param dockMode True to enable dock mode. +%End public slots: void changeSingleSymbol(); void showSymbolLevels(); + + protected: + }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssinglesymbolrendererwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgssmartgroupeditordialog.sip b/python/gui/symbology-ng/qgssmartgroupeditordialog.sip index 0ed995cd137..3e441043757 100644 --- a/python/gui/symbology-ng/qgssmartgroupeditordialog.sip +++ b/python/gui/symbology-ng/qgssmartgroupeditordialog.sip @@ -1,71 +1,117 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssmartgroupeditordialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsSmartGroupCondition : QWidget { + %TypeHeaderCode -#include +#include "qgssmartgroupeditordialog.h" +%End + public: + QgsSmartGroupCondition( int id, QWidget *parent /TransferThis/ = 0 ); + + QString constraint(); +%Docstring +returns the constraint key + :rtype: str %End - public: - QgsSmartGroupCondition( int id, QWidget *parent /TransferThis/ = NULL ); - - //! returns the constraint key - QString constraint(); - - //! returns the parameter QString parameter(); +%Docstring +returns the parameter + :rtype: str +%End - //! sets the given constraint void setConstraint( const QString &constraint ); +%Docstring +sets the given constraint +%End - //! sets the given param void setParameter( const QString ¶m ); +%Docstring +sets the given param +%End - //! sets the remove button hidden state to 'hide' void hideRemoveButton( bool hide ); +%Docstring +sets the remove button hidden state to 'hide' +%End public slots: void destruct(); signals: void removed( int ); + + protected: + }; + + + + class QgsSmartGroupEditorDialog : QDialog { + %TypeHeaderCode -#include +#include "qgssmartgroupeditordialog.h" +%End + public: + QgsSmartGroupEditorDialog( QgsStyle *style, QWidget *parent /TransferThis/ = 0 ); + + QString smartgroupName(); +%Docstring +returns the value from mNameLineEdit + :rtype: str %End - public: - QgsSmartGroupEditorDialog( QgsStyle *style, QWidget *parent /TransferThis/ = NULL ); - ~QgsSmartGroupEditorDialog(); - //! returns the value from mNameLineEdit - QString smartgroupName(); - - //! returns the condition map - //! @note not available in python bindings - // QgsSmartConditionMap conditionMap(); - - //! returns the AND/OR condition QString conditionOperator(); +%Docstring +returns the AND/OR condition + :rtype: str +%End - //! sets up the GUI for the given conditionmap - //! @note not available in python bindings - // void setConditionMap( const QgsSmartConditionMap& ); - //! sets the operator AND/OR - void setOperator( const QString& ); + void setOperator( const QString & ); +%Docstring +sets the operator AND/OR +%End - //! sets the smart group Name - void setSmartgroupName( const QString& ); + void setSmartgroupName( const QString & ); +%Docstring +sets the smart group Name +%End public slots: - //! function to create a new ConditionBox and update UI void addCondition(); +%Docstring +function to create a new ConditionBox and update UI +%End - //! slot to remove the condition with id int void removeCondition( int ); +%Docstring +slot to remove the condition with id int +%End void on_buttonBox_accepted(); + + protected: }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssmartgroupeditordialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsstyleexportimportdialog.sip b/python/gui/symbology-ng/qgsstyleexportimportdialog.sip index d5f82cae1a9..8c51cdfee5d 100644 --- a/python/gui/symbology-ng/qgsstyleexportimportdialog.sip +++ b/python/gui/symbology-ng/qgsstyleexportimportdialog.sip @@ -1,7 +1,20 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsstyleexportimportdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + class QgsStyleExportImportDialog : QDialog { + %TypeHeaderCode -#include +#include "qgsstyleexportimportdialog.h" %End public: enum Mode @@ -10,57 +23,72 @@ class QgsStyleExportImportDialog : QDialog Import }; - // constructor - // mode argument must be 0 for saving and 1 for loading - QgsStyleExportImportDialog( QgsStyle *style, QWidget *parent /TransferThis/ = NULL, Mode mode = Export ); + QgsStyleExportImportDialog( QgsStyle *style, QWidget *parent /TransferThis/ = 0, Mode mode = Export ); ~QgsStyleExportImportDialog(); - /** - * @brief selectSymbols select symbols by name - * @param symbolNames list of symbol names - */ void selectSymbols( const QStringList &symbolNames ); - /** - * @brief deselectSymbols deselect symbols by name - * @param symbolNames list of symbol names - */ +%Docstring + selectSymbols select symbols by name + \param symbolNames list of symbol names +%End + void deselectSymbols( const QStringList &symbolNames ); +%Docstring + deselectSymbols deselect symbols by name + \param symbolNames list of symbol names +%End public slots: void doExportImport(); - /** - * @brief selectByGroup open select by group dialog - */ + void selectByGroup(); - /** - * @brief selectAll selects all symbols - */ +%Docstring + selectByGroup open select by group dialog +%End + void selectAll(); - /** - * @brief clearSelection deselects all symbols - */ +%Docstring + selectAll selects all symbols +%End + void clearSelection(); - /** - * Select the symbols belonging to the given tag - * @param tagName the name of the tag to be selected - */ +%Docstring + clearSelection deselects all symbols +%End + void selectTag( const QString &tagName ); - /** - * Deselect the symbols belonging to the given tag - * @param tagName the name of the tag to be deselected - */ +%Docstring + Select the symbols belonging to the given tag + \param tagName the name of the group to be selected +%End + void deselectTag( const QString &tagName ); - /** - * @brief selectSmartgroup selects all symbols from a smart group - * @param groupName - */ +%Docstring + Deselect the symbols belonging to the given tag + \param tagName the name of the group to be deselected +%End + void selectSmartgroup( const QString &groupName ); - /** - * @brief deselectSmartgroup deselects all symbols from a smart group - * @param groupName - */ +%Docstring + selectSmartgroup selects all symbols from a smart group + \param groupName +%End + void deselectSmartgroup( const QString &groupName ); +%Docstring + deselectSmartgroup deselects all symbols from a smart group + \param groupName +%End void importTypeChanged( int ); void browse(); + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsstyleexportimportdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsstylegroupselectiondialog.sip b/python/gui/symbology-ng/qgsstylegroupselectiondialog.sip index 6232c32c245..82d9f05aeb6 100644 --- a/python/gui/symbology-ng/qgsstylegroupselectiondialog.sip +++ b/python/gui/symbology-ng/qgsstylegroupselectiondialog.sip @@ -1,45 +1,60 @@ -/*************************************************************************** - qgsstylegroupselectiondialog.h - --------------------- - begin : Oct 2015 - copyright : (C) 2015 by Alessandro Pasotti - email : elpaso at itopen dot it - - *************************************************************************** - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - ***************************************************************************/ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsstylegroupselectiondialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ -class QgsStyleGroupSelectionDialog : public QDialog, private Ui::SymbolsGroupSelectionDialogBase + + + +class QgsStyleGroupSelectionDialog : QDialog { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgsstylegroupselectiondialog.h" +%End public: QgsStyleGroupSelectionDialog( QgsStyle *style, QWidget *parent = 0 ); - ~QgsStyleGroupSelectionDialog(); - //! Set bold font for item void setBold( QStandardItem *item ); +%Docstring +Set bold font for item +%End signals: - //! tag with tagName has been selected void tagSelected( const QString &tagName ); - //! tag with tagName has been deselected +%Docstring +tag with tagName has been selected +%End void tagDeselected( const QString &tagName ); - //! smartgroup with groupName has been selected +%Docstring +tag with tagName has been deselected +%End void smartgroupSelected( const QString &groupName ); - //! smart group with groupName has been deselected +%Docstring +smartgroup with groupName has been selected +%End void smartgroupDeselected( const QString &groupName ); - //! all deselected +%Docstring +smart group with groupName has been deselected +%End void allDeselected(); - //! all selected +%Docstring +all deselected +%End void allSelected(); +%Docstring +all selected +%End }; +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsstylegroupselectiondialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsstylemanagerdialog.sip b/python/gui/symbology-ng/qgsstylemanagerdialog.sip index 2228dc948b5..c4fe78a62ec 100644 --- a/python/gui/symbology-ng/qgsstylemanagerdialog.sip +++ b/python/gui/symbology-ng/qgsstylemanagerdialog.sip @@ -1,15 +1,30 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsstylemanagerdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + class QgsStyleManagerDialog : QDialog { + %TypeHeaderCode -#include +#include "qgsstylemanagerdialog.h" %End - public: - QgsStyleManagerDialog( QgsStyle *style, QWidget *parent /TransferThis/ = NULL ); + QgsStyleManagerDialog( QgsStyle *style, QWidget *parent /TransferThis/ = 0 ); - //! open add color ramp dialog, return color ramp's name if the ramp has been added - static QString addColorRampStatic( QWidget* parent, QgsStyle* style, + static QString addColorRampStatic( QWidget *parent, QgsStyle *style, QString RampType = QString() ); +%Docstring +open add color ramp dialog, return color ramp's name if the ramp has been added + :rtype: str +%End public slots: void addItem(); @@ -22,97 +37,195 @@ class QgsStyleManagerDialog : QDialog void importItems(); void on_tabItemType_currentChanged( int ); - //! adds symbols of some type to list void populateList(); +%Docstring +adds symbols of some type to list +%End - //! called when the dialog is going to be closed void onFinished(); +%Docstring +called when the dialog is going to be closed +%End void on_buttonBox_helpRequested(); void itemChanged( QStandardItem *item ); - void groupChanged( const QModelIndex& ); + void groupChanged( const QModelIndex & ); void groupRenamed( QStandardItem * ); - //! add a tag int addTag(); - //! add a smartgroup +%Docstring +add a tag + :rtype: int +%End int addSmartgroup(); - //! remove a tag or smartgroup +%Docstring +add a smartgroup + :rtype: int +%End void removeGroup(); +%Docstring +remove a tag or smartgroup +%End - //! carry out symbol tagging using check boxes void tagSymbolsAction(); +%Docstring +carry out symbol tagging using check boxes +%End - //! edit the selected smart group void editSmartgroupAction(); +%Docstring +edit the selected smart group +%End - //! symbol changed from one group - void regrouped( QStandardItem* ); + void regrouped( QStandardItem * ); +%Docstring +symbol changed from one group +%End - //! filter the symbols based on input search term - void filterSymbols( const QString& ); + void filterSymbols( const QString & ); +%Docstring +filter the symbols based on input search term +%End - //! Perform symbol specific tasks when selected - void symbolSelected( const QModelIndex& ); + void symbolSelected( const QModelIndex & ); +%Docstring +Perform symbol specific tasks when selected +%End - //! Perform tasks when the selected symbols change void selectedSymbolsChanged( const QItemSelection &selected, const QItemSelection &deselected ); +%Docstring +Perform tasks when the selected symbols change +%End - //! Context menu for the groupTree void grouptreeContextMenu( QPoint ); +%Docstring +Context menu for the groupTree +%End - //! Context menu for the listItems ( symbols list ) void listitemsContextMenu( QPoint ); +%Docstring +Context menu for the listItems ( symbols list ) +%End protected slots: bool addColorRamp( QAction *action ); - //! Add selected symbols to favorites +%Docstring + :rtype: bool +%End void addFavoriteSelectedSymbols(); - //! Remove selected symbols from favorites +%Docstring +Add selected symbols to favorites +%End void removeFavoriteSelectedSymbols(); - //! Tag selected symbols using menu item selection +%Docstring +Remove selected symbols from favorites +%End void tagSelectedSymbols( bool newTag = false ); - //! Remove all tags from selected symbols +%Docstring +Tag selected symbols using menu item selection +%End void detagSelectedSymbols(); +%Docstring +Remove all tags from selected symbols +%End protected: - //! populate combo box with known style items (symbols, color ramps) void populateTypes(); +%Docstring +populate combo box with known style items (symbols, color ramps) +%End - //! populate the groups void populateGroups(); - //! to set symbols checked when in editing mode - void setSymbolsChecked( const QStringList& ); +%Docstring +populate the groups +%End + void setSymbolsChecked( const QStringList & ); +%Docstring +to set symbols checked when in editing mode +%End - //! populate list view with symbols of the current type with the given names void populateSymbols( const QStringList &symbolNames, bool checkable = false ); +%Docstring +populate list view with symbols of the current type with the given names +%End - //! populate list view with color ramps void populateColorRamps( const QStringList &colorRamps, bool checkable = false ); +%Docstring +populate list view with color ramps +%End int currentItemType(); +%Docstring + :rtype: int +%End QString currentItemName(); +%Docstring + :rtype: str +%End - //! add a new symbol to style bool addSymbol(); - //! add a new color ramp to style +%Docstring +add a new symbol to style + :rtype: bool +%End bool addColorRamp(); +%Docstring +add a new color ramp to style + :rtype: bool +%End bool editSymbol(); +%Docstring + :rtype: bool +%End bool editColorRamp(); +%Docstring + :rtype: bool +%End bool removeSymbol(); +%Docstring + :rtype: bool +%End bool removeColorRamp(); +%Docstring + :rtype: bool +%End - //! Enables or disbables the symbol specific inputs void enableSymbolInputs( bool ); - //! Enables or disables the groupTree specific inputs +%Docstring +Enables or disbables the symbol specific inputs +%End void enableGroupInputs( bool ); - //! Enables or disables the groupTree items for grouping mode +%Docstring +Enables or disables the groupTree specific inputs +%End void enableItemsForGroupingMode( bool ); +%Docstring +Enables or disables the groupTree items for grouping mode +%End + + void setBold( QStandardItem * ); +%Docstring +sets the text of the item with bold font +%End + + + + + + + + - //! sets the text of the item with bold font - void setBold( QStandardItem* ); }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsstylemanagerdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsstylesavedialog.sip b/python/gui/symbology-ng/qgsstylesavedialog.sip index 3626d189841..6a802d1c38f 100644 --- a/python/gui/symbology-ng/qgsstylesavedialog.sip +++ b/python/gui/symbology-ng/qgsstylesavedialog.sip @@ -1,22 +1,60 @@ -class QgsStyleSaveDialog : QDialog +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsstylesavedialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + +class QgsStyleSaveDialog: QDialog { -%TypeHeaderCode -#include +%Docstring + a dialog for setting properties of a newly saved style. +.. versionadded:: 3.0 %End +%TypeHeaderCode +#include "qgsstylesavedialog.h" +%End public: - /** Constructor for QgsSymbolSaveDialog - * @param parent parent widget - * @param type the QgsStyle entity type being saved - */ - QgsStyleSaveDialog( QWidget *parent /TransferThis/ = NULL, QgsStyle::StyleEntity type = QgsStyle::SymbolEntity ); - //! returns the text value of the name element + QgsStyleSaveDialog( QWidget *parent /TransferThis/ = 0, QgsStyle::StyleEntity type = QgsStyle::SymbolEntity ); +%Docstring + Constructor for QgsSymbolSaveDialog + \param parent parent widget + \param type the QgsStyle entity type being saved +%End + QString name() const; +%Docstring +returns the text value of the name element + :rtype: str +%End - //! returns the text value of the tags element QString tags() const; +%Docstring +returns the text value of the tags element + :rtype: str +%End - //! returns whether the favorite element is checked bool isFavorite() const; +%Docstring +returns whether the favorite element is checked + :rtype: bool +%End + + + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsstylesavedialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgssvgselectorwidget.sip b/python/gui/symbology-ng/qgssvgselectorwidget.sip index 53f46741ec5..0a7a6866867 100644 --- a/python/gui/symbology-ng/qgssvgselectorwidget.sip +++ b/python/gui/symbology-ng/qgssvgselectorwidget.sip @@ -1,62 +1,129 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssvgselectorwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + + class QgsSvgSelectorListModel : QAbstractListModel { +%Docstring + A model for displaying SVG files with a preview icon. Population of the model is performed in + a background thread to ensure that initial creation of the model is responsive and does + not block the GUI. +%End + %TypeHeaderCode -#include +#include "qgssvgselectorwidget.h" %End public: + QgsSvgSelectorListModel( QObject *parent /TransferThis/ ); +%Docstring + Constructor for QgsSvgSelectorListModel. All SVGs in folders from the application SVG + search paths will be shown. + \param parent parent object +%End - // Constructor to create model for icons in a specific path QgsSvgSelectorListModel( QObject *parent /TransferThis/, const QString &path ); +%Docstring + Constructor for creating a model for SVG files in a specific path. + \param parent parent object + \param path initial path, which is recursively searched +%End - int rowCount( const QModelIndex &parent = QModelIndex() ) const; + virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const; + + virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const; + + + protected: - QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const; }; + class QgsSvgSelectorGroupsModel : QStandardItemModel { +%Docstring + A model for displaying SVG search paths. Population of the model is performed in + a background thread to ensure that initial creation of the model is responsive and does + not block the GUI. +%End + %TypeHeaderCode -#include +#include "qgssvgselectorwidget.h" %End public: QgsSvgSelectorGroupsModel( QObject *parent /TransferThis/ ); -}; + ~QgsSvgSelectorGroupsModel(); +}; class QgsSvgSelectorWidget : QWidget { + %TypeHeaderCode -#include +#include "qgssvgselectorwidget.h" %End public: QgsSvgSelectorWidget( QWidget *parent /TransferThis/ = 0 ); ~QgsSvgSelectorWidget(); QString currentSvgPath() const; +%Docstring + :rtype: str +%End public slots: void setSvgPath( const QString &svgPath ); +%Docstring +Accepts absolute paths +%End signals: void svgSelected( const QString &path ); protected: void populateList(); + }; class QgsSvgSelectorDialog : QDialog { + %TypeHeaderCode -#include +#include "qgssvgselectorwidget.h" %End public: - QgsSvgSelectorDialog( QWidget* parent /TransferThis/ = 0, const Qt::WindowFlags& fl = QgsGuiUtils::ModalDialogFlags, + + QgsSvgSelectorDialog( QWidget *parent /TransferThis/ = 0, + Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Close | QDialogButtonBox::Ok, Qt::Orientation orientation = Qt::Horizontal ); +%Docstring + Constructor for QgsSvgSelectorDialog. +%End ~QgsSvgSelectorDialog(); - //! Returns pointer to the embedded SVG selector widget QgsSvgSelectorWidget *svgSelector(); +%Docstring +Returns pointer to the embedded SVG selector widget + :rtype: QgsSvgSelectorWidget +%End + protected: }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssvgselectorwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgssymbollayerwidget.sip b/python/gui/symbology-ng/qgssymbollayerwidget.sip index e9674b24e07..e832fd5d790 100644 --- a/python/gui/symbology-ng/qgssymbollayerwidget.sip +++ b/python/gui/symbology-ng/qgssymbollayerwidget.sip @@ -1,71 +1,103 @@ -class QgsSymbolLayerWidget : QWidget -{ -%TypeHeaderCode -#include -%End +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbollayerwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + +class QgsSymbolLayerWidget : QWidget, protected QgsExpressionContextGenerator +{ + +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: QgsSymbolLayerWidget( QWidget *parent /TransferThis/, const QgsVectorLayer *vl = 0 ); - virtual ~QgsSymbolLayerWidget(); virtual void setSymbolLayer( QgsSymbolLayer *layer ) = 0; virtual QgsSymbolLayer *symbolLayer() = 0; +%Docstring + :rtype: QgsSymbolLayer +%End - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() - * @note added in QGIS 3.0 - */ void setContext( const QgsSymbolWidgetContext &context ); +%Docstring + Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + \param context symbol widget context +.. seealso:: context() +.. versionadded:: 3.0 +%End - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() - * @note added in QGIS 3.0 - */ QgsSymbolWidgetContext context() const; +%Docstring + Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. +.. seealso:: setContext() +.. versionadded:: 3.0 + :rtype: QgsSymbolWidgetContext +%End - /** Returns the vector layer associated with the widget. - * @note added in QGIS 2.12 - */ const QgsVectorLayer *vectorLayer() const; +%Docstring + Returns the vector layer associated with the widget. +.. versionadded:: 2.12 + :rtype: QgsVectorLayer +%End protected: - void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key ); - QgsExpressionContext createExpressionContext() const; + void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key ); +%Docstring + Registers a data defined override button. Handles setting up connections + for the button and initializing the button to show the correct descriptions + and help text for the associated property. +.. versionadded:: 3.0 +%End + + virtual QgsExpressionContext createExpressionContext() const; + signals: - /** - * Should be emitted whenever configuration changes happened on this symbol layer configuration. - * If the subsymbol is changed, {@link symbolChanged()} should be emitted instead. - */ + void changed(); - /** - * Should be emitted whenever the sub symbol changed on this symbol layer configuration. - * Normally {@link changed()} should be preferred. - * - * @see {@link changed()} - */ +%Docstring + Should be emitted whenever configuration changes happened on this symbol layer configuration. + If the subsymbol is changed, symbolChanged() should be emitted instead. +%End + void symbolChanged(); +%Docstring + Should be emitted whenever the sub symbol changed on this symbol layer configuration. + Normally changed() should be preferred. + +.. seealso:: changed() +%End protected slots: void updateDataDefinedProperty(); + }; -/////////// + + class QgsSimpleLineSymbolLayerWidget : QgsSymbolLayerWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - QgsSimpleLineSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsSimpleLineSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); @@ -82,29 +114,33 @@ class QgsSimpleLineSymbolLayerWidget : QgsSymbolLayerWidget void on_mDrawInsideCheckBox_stateChanged( int state ); protected: - //creates a new icon for the 'change pattern' button + void updatePatternIcon(); + }; -/////////// + + class QgsSimpleMarkerSymbolLayerWidget : QgsSymbolLayerWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - QgsSimpleMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); - ~QgsSimpleMarkerSymbolLayerWidget(); + QgsSimpleMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); public slots: + void setColorStroke( const QColor &color ); void setColorFill( const QColor &color ); void setSize(); @@ -117,22 +153,28 @@ class QgsSimpleMarkerSymbolLayerWidget : QgsSymbolLayerWidget void on_mStrokeWidthSpinBox_valueChanged( double d ); void on_mHorizontalAnchorComboBox_currentIndexChanged( int index ); void on_mVerticalAnchorComboBox_currentIndexChanged( int index ); + + protected: + }; -/////////// + + class QgsSimpleFillSymbolLayerWidget : QgsSymbolLayerWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - QgsSimpleFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsSimpleFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); @@ -145,64 +187,76 @@ class QgsSimpleFillSymbolLayerWidget : QgsSymbolLayerWidget void offsetChanged(); void on_mStrokeWidthUnitWidget_changed(); void on_mOffsetUnitWidget_changed(); + + protected: }; -/////////// -/** \ingroup gui - * \class QgsFilledMarkerSymbolLayerWidget - * \brief Widget for configuring QgsFilledMarkerSymbolLayer symbol layers. - * \note Added in version 2.16 - */ + + class QgsFilledMarkerSymbolLayerWidget : QgsSymbolLayerWidget { -%TypeHeaderCode -#include +%Docstring + Widget for configuring QgsFilledMarkerSymbolLayer symbol layers. +.. versionadded:: 2.16 %End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - /** Constructor for QgsFilledMarkerSymbolLayerWidget. - * @param vl associated vector layer - * @param parent parent widget - */ QgsFilledMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); +%Docstring + Constructor for QgsFilledMarkerSymbolLayerWidget. + \param vl associated vector layer + \param parent parent widget +%End - ~QgsFilledMarkerSymbolLayerWidget(); - - /** Creates a new QgsFilledMarkerSymbolLayerWidget. - * @param vl associated vector layer - */ static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + Creates a new QgsFilledMarkerSymbolLayerWidget. + \param vl associated vector layer + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); + protected: + }; -/////////// + class QgsGradientFillSymbolLayerWidget : QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgssymbollayerwidget.h" %End public: - QgsGradientFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsGradientFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); public slots: void setColor( const QColor &color ); void setColor2( const QColor &color ); + void applyColorRamp(); +%Docstring + Applies the color ramp passed on by the color ramp button +%End + void setGradientType( int index ); void setCoordinateMode( int index ); void setGradientSpread( int index ); @@ -211,21 +265,27 @@ class QgsGradientFillSymbolLayerWidget : QgsSymbolLayerWidget void on_mOffsetUnitWidget_changed(); void colorModeChanged(); void on_mSpinAngle_valueChanged( double value ); + + protected: }; -/////////// + + class QgsShapeburstFillSymbolLayerWidget : QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgssymbollayerwidget.h" %End public: - QgsShapeburstFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsShapeburstFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); @@ -241,21 +301,27 @@ class QgsShapeburstFillSymbolLayerWidget : QgsSymbolLayerWidget void offsetChanged(); void on_mOffsetUnitWidget_changed(); void on_mIgnoreRingsCheckBox_stateChanged( int state ); + + protected: }; -/////////// + + class QgsMarkerLineSymbolLayerWidget : QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgssymbollayerwidget.h" %End public: - QgsMarkerLineSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsMarkerLineSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); @@ -269,24 +335,29 @@ class QgsMarkerLineSymbolLayerWidget : QgsSymbolLayerWidget void on_mIntervalUnitWidget_changed(); void on_mOffsetUnitWidget_changed(); void on_mOffsetAlongLineUnitWidget_changed(); + + protected: + }; -/////////// + + class QgsSvgMarkerSymbolLayerWidget : QgsSymbolLayerWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - QgsSvgMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); - ~QgsSvgMarkerSymbolLayerWidget(); + QgsSvgMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); @@ -311,104 +382,132 @@ class QgsSvgMarkerSymbolLayerWidget : QgsSymbolLayerWidget protected: void populateList(); - //update gui for svg file (insert new path, update activation of gui elements for svg params) void setGuiForSvg( const QgsSvgMarkerSymbolLayer *layer ); + + }; -/////////// + + class QgsRasterFillSymbolLayerWidget : QgsSymbolLayerWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - QgsRasterFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsRasterFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); + protected: + }; -/////////// + + class QgsSVGFillSymbolLayerWidget : QgsSymbolLayerWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - QgsSVGFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsSVGFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); protected: void insertIcons(); - /** Enables or disables svg fill color, stroke color and stroke width based on whether the - * svg file supports custom parameters. - * @param resetValues set to true to overwrite existing layer fill color, stroke color and stroke width - * with default values from svg file - */ + void updateParamGui( bool resetValues = true ); +%Docstring + Enables or disables svg fill color, stroke color and stroke width based on whether the + svg file supports custom parameters. + \param resetValues set to true to overwrite existing layer fill color, stroke color and stroke width + with default values from svg file +%End + }; -////////// + + class QgsLinePatternFillSymbolLayerWidget : QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgssymbollayerwidget.h" %End public: - QgsLinePatternFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsLinePatternFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); + + protected: + }; -////////// + + class QgsPointPatternFillSymbolLayerWidget: QgsSymbolLayerWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - QgsPointPatternFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsPointPatternFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); + + protected: + }; -///////// + + class QgsFontMarkerSymbolLayerWidget : QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgssymbollayerwidget.h" %End - public: - QgsFontMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); - - ~QgsFontMarkerSymbolLayerWidget(); + QgsFontMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); @@ -416,9 +515,11 @@ class QgsFontMarkerSymbolLayerWidget : QgsSymbolLayerWidget void setFontFamily( const QFont &font ); void setColor( const QColor &color ); - /** Set stroke color. - * @note added in 2.16 */ void setColorStroke( const QColor &color ); +%Docstring + Set stroke color. +.. versionadded:: 2.16 +%End void setSize( double size ); void setAngle( double angle ); void setCharacter( QChar chr ); @@ -429,41 +530,63 @@ class QgsFontMarkerSymbolLayerWidget : QgsSymbolLayerWidget void on_mStrokeWidthSpinBox_valueChanged( double d ); void on_mHorizontalAnchorComboBox_currentIndexChanged( int index ); void on_mVerticalAnchorComboBox_currentIndexChanged( int index ); + + protected: + }; -////////// + + + class QgsCentroidFillSymbolLayerWidget : QgsSymbolLayerWidget { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollayerwidget.h" +%End public: - QgsCentroidFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = NULL ); + QgsCentroidFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); + + protected: + }; + + class QgsGeometryGeneratorSymbolLayerWidget : QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgssymbollayerwidget.h" %End public: QgsGeometryGeneratorSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); - /** - * Will be registered as factory - */ static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + Will be registered as factory + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbollayerwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgssymbollevelsdialog.sip b/python/gui/symbology-ng/qgssymbollevelsdialog.sip index 0e98caa0ab1..f0821eb0f25 100644 --- a/python/gui/symbology-ng/qgssymbollevelsdialog.sip +++ b/python/gui/symbology-ng/qgssymbollevelsdialog.sip @@ -1,16 +1,29 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbollevelsdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + class QgsSymbolLevelsDialog : QDialog { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbollevelsdialog.h" +%End public: - //! @note not available in python bindings - // QgsSymbolLevelsDialog( const QList< QPair > &list, bool usingSymbolLevels, QWidget *parent = NULL ); + + ~QgsSymbolLevelsDialog(); bool usingLevels() const; +%Docstring + :rtype: bool +%End - // used by rule-based renderer (to hide checkbox to enable/disable ordering) void setForceOrderingEnabled( bool enabled ); public slots: @@ -19,11 +32,17 @@ class QgsSymbolLevelsDialog : QDialog void renderingPassChanged( int row, int column ); protected: - //! @note not available in python bindings - //void populateTable(); - //! @note not available in python bindings - //void setDefaultLevels(); + private: QgsSymbolLevelsDialog(); }; + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbollevelsdialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgssymbolselectordialog.sip b/python/gui/symbology-ng/qgssymbolselectordialog.sip index d7f52a480bb..eb7b4f2fac9 100644 --- a/python/gui/symbology-ng/qgssymbolselectordialog.sip +++ b/python/gui/symbology-ng/qgssymbolselectordialog.sip @@ -1,123 +1,233 @@ -class QgsSymbolSelectorWidget : QgsPanelWidget +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbolselectordialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + + + + + + + + +class QgsSymbolSelectorWidget: QgsPanelWidget { -%TypeHeaderCode -#include +%Docstring + Symbol selector widget that cna be used to select and build a symbol %End +%TypeHeaderCode +#include "qgssymbolselectordialog.h" +%End public: - QgsSymbolSelectorWidget( QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0); - //! return menu for "advanced" button - create it if doesn't exist and show the advanced button + QgsSymbolSelectorWidget( QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); +%Docstring + Symbol selector widget that can be used to select and build a symbol + \param symbol The symbol to load into the widget as a start point. + \param style The style used by the widget. + \param vl The vector layer for the symbol. + \param parent +%End + QMenu *advancedMenu(); +%Docstring +return menu for "advanced" button - create it if doesn't exist and show the advanced button + :rtype: QMenu +%End - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() - * @note added in QGIS 3.0 - */ void setContext( const QgsSymbolWidgetContext &context ); +%Docstring + Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + \param context symbol widget context +.. seealso:: context() +.. versionadded:: 3.0 +%End - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() - * @note added in QGIS 3.0 - */ QgsSymbolWidgetContext context() const; +%Docstring + Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. +.. seealso:: setContext() +.. versionadded:: 3.0 + :rtype: QgsSymbolWidgetContext +%End - /** - * @brief Return the symbol that is currently active in the widget. Can be null. - * @return The active symbol. - */ QgsSymbol *symbol(); +%Docstring + Return the symbol that is currently active in the widget. Can be null. + :return: The active symbol. + :rtype: QgsSymbol +%End protected: - //! Reimplements dialog keyPress event so we can ignore it - void keyPressEvent( QKeyEvent *event ); void loadSymbol(); - //! @note not available in python bindings - // void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent ); +%Docstring + Reload the current symbol in the view. +%End + void updateUi(); +%Docstring + Update the state of the UI based on the currently set symbol layer. +%End void updateLockButton(); +%Docstring + Update the lock button states based on the current symbol layer. +%End + - //! @note not available in python bindings - // SymbolLayerItem *currentLayerItem(); QgsSymbolLayer *currentLayer(); +%Docstring + The current symbol layer that is active in the interface. + :return: The active symbol layer. + :rtype: QgsSymbolLayer +%End void moveLayerByOffset( int offset ); +%Docstring + Move the current active layer by a set offset in the list. + \param offset The offset to move the layer by +%End void setWidget( QWidget *widget ); +%Docstring + Set the properties widget for the active symbol layer. + \param widget The widget to set to configure the active symbol layer. +%End signals: + void symbolModified(); +%Docstring + Emiited when a symbol is modified in the widget. +%End public slots: + void moveLayerDown(); +%Docstring + Move the active symbol layer down. +%End + void moveLayerUp(); +%Docstring + Move the active symbol layer up. +%End void addLayer(); +%Docstring + Add a symobl layer to the bottom of the stack. +%End + void removeLayer(); +%Docstring + Remove the current active symbol layer. +%End void lockLayer(); +%Docstring + Lock the current active symbol layer. +%End - //! Duplicates the current symbol layer and places the duplicated layer above the current symbol layer - //! @note added in QGIS 2.14 void duplicateLayer(); +%Docstring +.. versionadded:: 2.14 +%End void layerChanged(); +%Docstring + Called when the layer changes in the widget. Updates the active properties for + active symbol layer. +%End void updateLayerPreview(); - void updatePreview(); +%Docstring + Update the single symbol layer preview in the widget. +%End + + void updatePreview(); +%Docstring + Update the preview of the whole symbol in the interface. +%End - //! Slot to update tree when a new symbol from style void symbolChanged(); - //! alters tree and sets proper widget when Layer Type is changed - //! @note: The layer is received from the LayerPropertiesWidget +%Docstring +Slot to update tree when a new symbol from style +%End void changeLayer( QgsSymbolLayer *layer ); +%Docstring +\note: The layer is received from the LayerPropertiesWidget +%End + + + protected: // data + + }; class QgsSymbolSelectorDialog : QDialog { -%TypeHeaderCode -#include -%End +%TypeHeaderCode +#include "qgssymbolselectordialog.h" +%End public: QgsSymbolSelectorDialog( QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0, bool embedded = false ); + ~QgsSymbolSelectorDialog(); - //! return menu for "advanced" button - create it if doesn't exist and show the advanced button QMenu *advancedMenu(); +%Docstring +return menu for "advanced" button - create it if doesn't exist and show the advanced button + :rtype: QMenu +%End - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() - * @note added in QGIS 3.0 - */ void setContext( const QgsSymbolWidgetContext &context ); +%Docstring + Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + \param context symbol widget context +.. seealso:: context() +.. versionadded:: 3.0 +%End - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() - * @note added in QGIS 3.0 - */ QgsSymbolWidgetContext context() const; +%Docstring + Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. +.. seealso:: setContext() +.. versionadded:: 3.0 + :rtype: QgsSymbolWidgetContext +%End QgsSymbol *symbol(); +%Docstring + Return the symbol that is currently active in the widget. Can be null. + :return: The active symbol. + :rtype: QgsSymbol +%End + protected: - //! Reimplements dialog keyPress event so we can ignore it - void keyPressEvent( QKeyEvent *event ); + virtual void keyPressEvent( QKeyEvent *e ); + void loadSymbol(); - //! @note not available in python bindings - // void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent ); + void updateUi(); void updateLockButton(); - //! @note not available in python bindings - // SymbolLayerItem *currentLayerItem(); QgsSymbolLayer *currentLayer(); +%Docstring + :rtype: QgsSymbolLayer +%End void moveLayerByOffset( int offset ); @@ -135,20 +245,31 @@ class QgsSymbolSelectorDialog : QDialog void lockLayer(); - //! Duplicates the current symbol layer and places the duplicated layer above the current symbol layer - //! @note added in QGIS 2.14 void duplicateLayer(); +%Docstring +.. versionadded:: 2.14 +%End void layerChanged(); void updateLayerPreview(); void updatePreview(); - //! Slot to update tree when a new symbol from style void symbolChanged(); - //! alters tree and sets proper widget when Layer Type is changed - //! @note: The layer is received from the LayerPropertiesWidget +%Docstring +Slot to update tree when a new symbol from style +%End void changeLayer( QgsSymbolLayer *layer ); - +%Docstring +\note: The layer is received from the LayerPropertiesWidget +%End }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbolselectordialog.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgssymbolslistwidget.sip b/python/gui/symbology-ng/qgssymbolslistwidget.sip index 695893777a6..6d9e46c9678 100644 --- a/python/gui/symbology-ng/qgssymbolslistwidget.sip +++ b/python/gui/symbology-ng/qgssymbolslistwidget.sip @@ -1,28 +1,51 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbolslistwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + + + + + class QgsSymbolsListWidget : QWidget { + %TypeHeaderCode -#include +#include "qgssymbolslistwidget.h" %End public: - QgsSymbolsListWidget( QgsSymbol *symbol, QgsStyle *style, QMenu *menu, QWidget *parent /TransferThis/ = 0, const QgsVectorLayer *layer = 0 ); + QgsSymbolsListWidget( QgsSymbol *symbol, QgsStyle *style, QMenu *menu, QWidget *parent /TransferThis/, const QgsVectorLayer *layer = 0 ); + + + virtual ~QgsSymbolsListWidget(); - /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @param context symbol widget context - * @see context() - * @note added in QGIS 3.0 - */ void setContext( const QgsSymbolWidgetContext &context ); +%Docstring + Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. + \param context symbol widget context +.. seealso:: context() +.. versionadded:: 3.0 +%End - /** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. - * @see setContext() - * @note added in QGIS 3.0 - */ QgsSymbolWidgetContext context() const; +%Docstring + Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. +.. seealso:: setContext() +.. versionadded:: 3.0 + :rtype: QgsSymbolWidgetContext +%End - /** Returns the vector layer associated with the widget. - * @note added in QGIS 2.12 - */ const QgsVectorLayer *layer() const; +%Docstring + Returns the vector layer associated with the widget. +.. versionadded:: 2.12 + :rtype: QgsVectorLayer +%End public slots: @@ -33,11 +56,15 @@ class QgsSymbolsListWidget : QWidget void setLineWidth( double width ); void addSymbolToStyle(); void saveSymbol(); + void symbolAddedToStyle( const QString &name, QgsSymbol *symbol ); + void on_mSymbolUnitWidget_changed(); - //! Pupulates the groups combo box with available tags and smartgroups void populateGroups(); +%Docstring +Pupulates the groups combo box with available tags and smartgroups +%End void on_groupsCombo_currentIndexChanged( int index ); void openStyleManager(); @@ -49,4 +76,16 @@ class QgsSymbolsListWidget : QWidget signals: void changed(); + }; + + + + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbolslistwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgssymbolwidgetcontext.sip b/python/gui/symbology-ng/qgssymbolwidgetcontext.sip index b58b0c2a0f7..0e411c29a70 100644 --- a/python/gui/symbology-ng/qgssymbolwidgetcontext.sip +++ b/python/gui/symbology-ng/qgssymbolwidgetcontext.sip @@ -1,67 +1,101 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbolwidgetcontext.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ -/** \ingroup gui - * \class QgsSymbolWidgetContext - * Contains settings which reflect the context in which a symbol (or renderer) widget is shown, e.g., the - * map canvas and relevant expression contexts. - * - * \note added in QGIS 3.0 - */ - class QgsSymbolWidgetContext + + + + + +class QgsSymbolWidgetContext { +%Docstring + Contains settings which reflect the context in which a symbol (or renderer) widget is shown, e.g., the + map canvas and relevant expression contexts. + +.. versionadded:: 3.0 +%End + %TypeHeaderCode -#include +#include "qgssymbolwidgetcontext.h" %End public: QgsSymbolWidgetContext(); QgsSymbolWidgetContext( const QgsSymbolWidgetContext &other ); +%Docstring + Copy constructor. + \param other source QgsSymbolWidgetContext +%End - //QgsSymbolWidgetContext &operator=( const QgsSymbolWidgetContext &other ); - /** Sets the map canvas associated with the widget. This allows the widget to retrieve the current - * map scale and other properties from the canvas. - * @param canvas map canvas - * @see mapCanvas() - */ void setMapCanvas( QgsMapCanvas *canvas ); +%Docstring + Sets the map canvas associated with the widget. This allows the widget to retrieve the current + map scale and other properties from the canvas. + \param canvas map canvas +.. seealso:: mapCanvas() +%End - /** Returns the map canvas associated with the widget. - * @see setMapCanvas() - */ QgsMapCanvas *mapCanvas() const; +%Docstring + Returns the map canvas associated with the widget. +.. seealso:: setMapCanvas() + :rtype: QgsMapCanvas +%End - /** Sets the optional expression context used for the widget. This expression context is used for - * evaluating data defined symbol properties and for populating based expression widgets in - * the layer widget. - * @param context expression context pointer. Ownership is not transferred. - * @see expressionContext() - * @see setAdditionalExpressionContextScopes() - */ void setExpressionContext( QgsExpressionContext *context ); +%Docstring + Sets the optional expression context used for the widget. This expression context is used for + evaluating data defined symbol properties and for populating based expression widgets in + the layer widget. + \param context expression context pointer. Ownership is not transferred. +.. seealso:: expressionContext() +.. seealso:: setAdditionalExpressionContextScopes() +%End - /** Returns the expression context used for the widget, if set. This expression context is used for - * evaluating data defined symbol properties and for populating based expression widgets in - * the layer widget. - * @see setExpressionContext() - */ QgsExpressionContext *expressionContext() const; +%Docstring + Returns the expression context used for the widget, if set. This expression context is used for + evaluating data defined symbol properties and for populating based expression widgets in + the layer widget. +.. seealso:: setExpressionContext() + :rtype: QgsExpressionContext +%End - /** Sets a list of additional expression context scopes to show as available within the layer. - * @param scopes list of additional scopes which will be added in order to the end of the default expression context - * @see setExpressionContext() - */ void setAdditionalExpressionContextScopes( const QList< QgsExpressionContextScope > &scopes ); +%Docstring + Sets a list of additional expression context scopes to show as available within the layer. + \param scopes list of additional scopes which will be added in order to the end of the default expression context +.. seealso:: setExpressionContext() +%End - /** Returns the list of additional expression context scopes to show as available within the layer. - * @see setAdditionalExpressionContextScopes() - */ QList< QgsExpressionContextScope > additionalExpressionContextScopes() const; +%Docstring + Returns the list of additional expression context scopes to show as available within the layer. +.. seealso:: setAdditionalExpressionContextScopes() + :rtype: list of QgsExpressionContextScope +%End + + QList globalProjectAtlasMapLayerScopes( const QgsMapLayer *layer ) const /Factory/; +%Docstring + Returns list of scopes: global, project, atlas, map, layer. + Ownership is transferred to the caller. +.. versionadded:: 3.0 + :rtype: list of QgsExpressionContextScope +%End - /** Returns list of scopes: global, project, atlas, map, layer. - * Ownership is transferred to the caller. - * @note added in QGIS 3.0 - */ - QList globalProjectAtlasMapLayerScopes( const QgsMapLayer *layer ) const /Factory/; }; +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgssymbolwidgetcontext.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/python/gui/symbology-ng/qgsvectorfieldsymbollayerwidget.sip b/python/gui/symbology-ng/qgsvectorfieldsymbollayerwidget.sip index 8b4af4a681f..f72ec4713b2 100644 --- a/python/gui/symbology-ng/qgsvectorfieldsymbollayerwidget.sip +++ b/python/gui/symbology-ng/qgsvectorfieldsymbollayerwidget.sip @@ -1,15 +1,38 @@ +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsvectorfieldsymbollayerwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ + + + class QgsVectorFieldSymbolLayerWidget: QgsSymbolLayerWidget { + %TypeHeaderCode -#include +#include "qgsvectorfieldsymbollayerwidget.h" %End public: QgsVectorFieldSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 ); - ~QgsVectorFieldSymbolLayerWidget(); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) /Factory/; +%Docstring + :rtype: QgsSymbolLayerWidget +%End - // from base class virtual void setSymbolLayer( QgsSymbolLayer *layer ); virtual QgsSymbolLayer *symbolLayer(); + + protected: + }; + +/************************************************************************ + * This file has been generated automatically from * + * * + * src/gui/symbology-ng/qgsvectorfieldsymbollayerwidget.h * + * * + * Do not edit manually ! Edit header and run scripts/sipify.pl again * + ************************************************************************/ diff --git a/scripts/sipify.pl b/scripts/sipify.pl index 54898c5c2e1..a9f336da1c6 100755 --- a/scripts/sipify.pl +++ b/scripts/sipify.pl @@ -442,8 +442,8 @@ while ($LINE_IDX < $LINE_COUNT){ } # class declaration started - # https://regex101.com/r/6FWntP/7 - if ( $LINE =~ m/^(\s*class)\s+([A-Z]+_EXPORT\s+)?(\w+)(\s*\:\s*(public|protected|private)\s+\w+(<([\w]|::)+>)?(::\w+(<\w+>)?)*(,\s*(public|protected|private)\s+\w+(<([\w]|::)+>)?(::\w+(<\w+>)?)*)*)?(?\s*SIP_\w+)?(?!;)$/ ){ + # https://regex101.com/r/6FWntP/8 + if ( $LINE =~ m/^(\s*class)\s+([A-Z]+_EXPORT\s+)?(\w+)(\s*\:\s*(public|protected|private)\s+\w+(<([\w]|::)+>)?(::\w+(<\w+>)?)*(,\s*(public|protected|private)\s+\w+(<([\w]|::)+>)?(::\w+(<\w+>)?)*)*)?(?\s*SIP_\w+)?\s*?(\/\/.*|(?!;))$/ ){ dbg_info("class definition started"); push @ACCESS, PUBLIC; push @EXPORTED, 0; @@ -463,8 +463,9 @@ while ($LINE_IDX < $LINE_COUNT){ # Inheritance if ($4){ my $m = $4; - $m =~ s/public //g; - $m =~ s/[,:]?\s*private \w+(::\w+)?//g; + $m =~ s/public +(\w+, *)*(Ui::\w+,? *)+//g; # remove Ui::xxx public inheritance as the namespace is causing troubles + $m =~ s/public +//g; + $m =~ s/[,:]?\s*private +\w+(::\w+)?//g; # detect template based inheritance while ($m =~ /[,:]\s+((?!QList)\w+)<((\w|::)+)>/g){ dbg_info("template class"); diff --git a/src/core/qgslogger.h b/src/core/qgslogger.h index d282f8b1924..e8e5ca20c13 100644 --- a/src/core/qgslogger.h +++ b/src/core/qgslogger.h @@ -116,7 +116,7 @@ class CORE_EXPORT QgsLogger /** \ingroup core */ -class QgsScopeLogger // clazy:exclude=rule-of-three +class CORE_EXPORT QgsScopeLogger // clazy:exclude=rule-of-three { public: QgsScopeLogger( const char *file, const char *func, int line ) diff --git a/src/gui/symbology-ng/qgs25drendererwidget.h b/src/gui/symbology-ng/qgs25drendererwidget.h index 267afe68209..3c412b51651 100644 --- a/src/gui/symbology-ng/qgs25drendererwidget.h +++ b/src/gui/symbology-ng/qgs25drendererwidget.h @@ -26,7 +26,7 @@ class Qgs25DRenderer; /** \ingroup gui * \class Qgs25DRendererWidget */ -class GUI_EXPORT Qgs25DRendererWidget : public QgsRendererWidget, Ui::Qgs25DRendererWidgetBase +class GUI_EXPORT Qgs25DRendererWidget : public QgsRendererWidget, protected Ui::Qgs25DRendererWidgetBase { Q_OBJECT @@ -37,7 +37,7 @@ class GUI_EXPORT Qgs25DRendererWidget : public QgsRendererWidget, Ui::Qgs25DRend * \param style * \param renderer the mask renderer (will not take ownership) */ - static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer ); + static QgsRendererWidget *create( QgsVectorLayer *layer, QgsStyle *style, QgsFeatureRenderer *renderer SIP_TRANSFER ) SIP_FACTORY; /** Constructor * \param layer the layer where this renderer is applied @@ -52,7 +52,7 @@ class GUI_EXPORT Qgs25DRendererWidget : public QgsRendererWidget, Ui::Qgs25DRend void updateRenderer(); private: - void apply() override; + void apply() override SIP_FORCE; Qgs25DRenderer *mRenderer = nullptr; }; diff --git a/src/gui/symbology-ng/qgsbrushstylecombobox.h b/src/gui/symbology-ng/qgsbrushstylecombobox.h index 90ea46c21a5..d24ca133332 100644 --- a/src/gui/symbology-ng/qgsbrushstylecombobox.h +++ b/src/gui/symbology-ng/qgsbrushstylecombobox.h @@ -18,6 +18,7 @@ #include #include "qgis_gui.h" +#include "qgis_sip.h" /** \ingroup gui * \class QgsBrushStyleComboBox @@ -27,7 +28,7 @@ class GUI_EXPORT QgsBrushStyleComboBox : public QComboBox Q_OBJECT public: - QgsBrushStyleComboBox( QWidget *parent = nullptr ); + QgsBrushStyleComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr ); Qt::BrushStyle brushStyle() const; diff --git a/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h b/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h index 0e54ecdf521..4b5031dcf67 100644 --- a/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h +++ b/src/gui/symbology-ng/qgscategorizedsymbolrendererwidget.h @@ -27,6 +27,8 @@ class QgsRendererCategory; #include "ui_qgscategorizedsymbolrendererv2widget.h" #include "qgis_gui.h" + +#ifndef SIP_RUN ///@cond PRIVATE class GUI_EXPORT QgsCategorizedSymbolRendererModel : public QAbstractItemModel @@ -79,6 +81,8 @@ class QgsCategorizedSymbolRendererViewStyle: public QProxyStyle ///@endcond +#endif + /** \ingroup gui * \class QgsCategorizedSymbolRendererWidget */ diff --git a/src/gui/symbology-ng/qgscptcitycolorrampdialog.h b/src/gui/symbology-ng/qgscptcitycolorrampdialog.h index 6e9541440eb..5485e2340cb 100644 --- a/src/gui/symbology-ng/qgscptcitycolorrampdialog.h +++ b/src/gui/symbology-ng/qgscptcitycolorrampdialog.h @@ -119,6 +119,7 @@ class GUI_EXPORT QgsCptCityColorRampDialog : public QDialog, private Ui::QgsCptC }; +#ifndef SIP_RUN /// @cond PRIVATE /** \ingroup gui @@ -140,6 +141,6 @@ class TreeFilterProxyModel : public QSortFilterProxyModel }; ///@endcond - +#endif #endif diff --git a/src/gui/symbology-ng/qgsdashspacedialog.h b/src/gui/symbology-ng/qgsdashspacedialog.h index f2ce4559d52..10233e63228 100644 --- a/src/gui/symbology-ng/qgsdashspacedialog.h +++ b/src/gui/symbology-ng/qgsdashspacedialog.h @@ -18,6 +18,7 @@ #include "ui_qgsdashspacedialogbase.h" #include "qgis_gui.h" +#include "qgis_sip.h" /** \ingroup gui * A dialog to enter a custom dash space pattern for lines @@ -26,7 +27,7 @@ class GUI_EXPORT QgsDashSpaceDialog: public QDialog, private Ui::QgsDashSpaceDia { Q_OBJECT public: - QgsDashSpaceDialog( const QVector &v, QWidget *parent = nullptr, Qt::WindowFlags f = 0 ); + QgsDashSpaceDialog( const QVector &v, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags f = 0 ); QVector dashDotVector() const; diff --git a/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h b/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h index 47ed4b3c9fb..bfc20dc15a8 100644 --- a/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h +++ b/src/gui/symbology-ng/qgsgraduatedhistogramwidget.h @@ -79,6 +79,8 @@ class GUI_EXPORT QgsGraduatedHistogramWidget : public QgsHistogramWidget }; + +#ifndef SIP_RUN // // NOTE: // For private use by QgsGraduatedHistogramWidget only, @@ -106,5 +108,6 @@ class GUI_EXPORT QgsGraduatedHistogramEventFilter: public QObject double posToValue( QPointF point ) const; }; ///@endcond +#endif #endif //QGSGRADUATEDHISTOGRAMWIDGET_H diff --git a/src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h b/src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h index cd28b4458b4..c9e3a481726 100644 --- a/src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h +++ b/src/gui/symbology-ng/qgsgraduatedsymbolrendererwidget.h @@ -25,6 +25,7 @@ #include "ui_qgsgraduatedsymbolrendererv2widget.h" #include "qgis_gui.h" +#ifndef SIP_RUN /// @cond PRIVATE class GUI_EXPORT QgsGraduatedSymbolRendererModel : public QAbstractItemModel @@ -76,6 +77,7 @@ class QgsGraduatedSymbolRendererViewStyle: public QProxyStyle }; ///@endcond +#endif /** \ingroup gui * \class QgsGraduatedSymbolRendererWidget diff --git a/src/gui/symbology-ng/qgslayerpropertieswidget.h b/src/gui/symbology-ng/qgslayerpropertieswidget.h index 74079d70cf1..5cff6fc8a72 100644 --- a/src/gui/symbology-ng/qgslayerpropertieswidget.h +++ b/src/gui/symbology-ng/qgslayerpropertieswidget.h @@ -42,7 +42,7 @@ class GUI_EXPORT QgsLayerPropertiesWidget : public QgsPanelWidget, public QgsExp Q_OBJECT public: - QgsLayerPropertiesWidget( QgsSymbolLayer *layer, const QgsSymbol *symbol, const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsLayerPropertiesWidget( QgsSymbolLayer *layer, const QgsSymbol *symbol, const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); /** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts. * \param context symbol widget context diff --git a/src/gui/symbology-ng/qgspenstylecombobox.h b/src/gui/symbology-ng/qgspenstylecombobox.h index d377136a8de..5ce6e951cbb 100644 --- a/src/gui/symbology-ng/qgspenstylecombobox.h +++ b/src/gui/symbology-ng/qgspenstylecombobox.h @@ -18,6 +18,7 @@ #include #include "qgis_gui.h" +#include "qgis_sip.h" /** \ingroup gui * \class QgsPenStyleComboBox @@ -27,7 +28,7 @@ class GUI_EXPORT QgsPenStyleComboBox : public QComboBox Q_OBJECT public: - QgsPenStyleComboBox( QWidget *parent = nullptr ); + QgsPenStyleComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr ); Qt::PenStyle penStyle() const; @@ -46,7 +47,7 @@ class GUI_EXPORT QgsPenJoinStyleComboBox : public QComboBox Q_OBJECT public: - QgsPenJoinStyleComboBox( QWidget *parent = nullptr ); + QgsPenJoinStyleComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr ); Qt::PenJoinStyle penJoinStyle() const; @@ -61,7 +62,7 @@ class GUI_EXPORT QgsPenCapStyleComboBox : public QComboBox Q_OBJECT public: - QgsPenCapStyleComboBox( QWidget *parent = nullptr ); + QgsPenCapStyleComboBox( QWidget *parent SIP_TRANSFERTHIS = nullptr ); Qt::PenCapStyle penCapStyle() const; diff --git a/src/gui/symbology-ng/qgsrendererwidget.h b/src/gui/symbology-ng/qgsrendererwidget.h index 2c9bc7e68e3..5ba766abf0c 100644 --- a/src/gui/symbology-ng/qgsrendererwidget.h +++ b/src/gui/symbology-ng/qgsrendererwidget.h @@ -122,7 +122,7 @@ class GUI_EXPORT QgsRendererWidget : public QgsPanelWidget * This will be called whenever the renderer is set on a layer. * This can be overwritten in subclasses. */ - virtual void apply(); + virtual void apply() SIP_FORCE; }; @@ -139,11 +139,13 @@ class QgsFields; #include "ui_widget_set_dd_value.h" #include "qgis_gui.h" + /** \ingroup gui Utility classes for "en masse" size definition */ -class GUI_EXPORT QgsDataDefinedValueDialog : public QDialog, public Ui::QgsDataDefinedValueDialog, private QgsExpressionContextGenerator +class GUI_EXPORT QgsDataDefinedValueDialog : public QDialog, public Ui::QgsDataDefinedValueBaseDialog, private QgsExpressionContextGenerator { + Q_OBJECT public: @@ -186,11 +188,11 @@ class GUI_EXPORT QgsDataDefinedValueDialog : public QDialog, public Ui::QgsDataD void init( int propertyKey ); // needed in children ctor to call virtual private: - QgsProperty symbolDataDefined() const; + QgsProperty symbolDataDefined() const SIP_FORCE; - virtual QgsProperty symbolDataDefined( const QgsSymbol * ) const = 0; - virtual double value( const QgsSymbol * ) const = 0; - virtual void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ) = 0; + virtual QgsProperty symbolDataDefined( const QgsSymbol * ) const = 0 SIP_FORCE; + virtual double value( const QgsSymbol * ) const = 0 SIP_FORCE; + virtual void setDataDefined( QgsSymbol *symbol, const QgsProperty &dd ) = 0 SIP_FORCE; QList mSymbolList; QgsVectorLayer *mLayer = nullptr; diff --git a/src/gui/symbology-ng/qgsrulebasedrendererwidget.h b/src/gui/symbology-ng/qgsrulebasedrendererwidget.h index 430904558d0..68c753cf37f 100644 --- a/src/gui/symbology-ng/qgsrulebasedrendererwidget.h +++ b/src/gui/symbology-ng/qgsrulebasedrendererwidget.h @@ -28,7 +28,7 @@ class QgsSymbolSelectorWidget; #include /* Features count fro rule */ -struct QgsRuleBasedRendererCount +struct QgsRuleBasedRendererCount SIP_SKIP { int count; // number of features int duplicateCount; // number of features present also in other rule(s) @@ -84,7 +84,7 @@ class GUI_EXPORT QgsRuleBasedRendererModel : public QAbstractItemModel void finishedAddingRules(); // call endInsertRows //! \note not available in Python bindungs - void setFeatureCounts( const QHash &countMap ); + void setFeatureCounts( const QHash &countMap ) SIP_SKIP; void clearFeatureCounts(); protected: @@ -192,7 +192,11 @@ class GUI_EXPORT QgsRendererRulePropsWidget : public QgsPanelWidget, private Ui: * \param parent The parent widget. * \param context the symbol widget context */ - QgsRendererRulePropsWidget( QgsRuleBasedRenderer::Rule *rule, QgsVectorLayer *layer, QgsStyle *style, QWidget *parent = nullptr, const QgsSymbolWidgetContext &context = QgsSymbolWidgetContext() ); + QgsRendererRulePropsWidget( QgsRuleBasedRenderer::Rule *rule, + QgsVectorLayer *layer, + QgsStyle *style, + QWidget *parent SIP_TRANSFERTHIS = nullptr, + const QgsSymbolWidgetContext &context = QgsSymbolWidgetContext() ); /** * Return the current set rule. diff --git a/src/gui/symbology-ng/qgssmartgroupeditordialog.h b/src/gui/symbology-ng/qgssmartgroupeditordialog.h index b5e712e5f34..2d70d8b9e6d 100644 --- a/src/gui/symbology-ng/qgssmartgroupeditordialog.h +++ b/src/gui/symbology-ng/qgssmartgroupeditordialog.h @@ -28,7 +28,7 @@ class GUI_EXPORT QgsSmartGroupCondition : public QWidget, private Ui::QgsSmartGr Q_OBJECT public: - QgsSmartGroupCondition( int id, QWidget *parent = nullptr ); + QgsSmartGroupCondition( int id, QWidget *parent SIP_TRANSFERTHIS = nullptr ); //! returns the constraint key QString constraint(); @@ -72,7 +72,7 @@ class GUI_EXPORT QgsSmartGroupEditorDialog : public QDialog, private Ui::QgsSmar Q_OBJECT public: - QgsSmartGroupEditorDialog( QgsStyle *style, QWidget *parent = nullptr ); + QgsSmartGroupEditorDialog( QgsStyle *style, QWidget *parent SIP_TRANSFERTHIS = nullptr ); //! returns the value from mNameLineEdit QString smartgroupName(); diff --git a/src/gui/symbology-ng/qgsstyleexportimportdialog.h b/src/gui/symbology-ng/qgsstyleexportimportdialog.h index f99eccbd08c..76189704e5b 100644 --- a/src/gui/symbology-ng/qgsstyleexportimportdialog.h +++ b/src/gui/symbology-ng/qgsstyleexportimportdialog.h @@ -27,6 +27,7 @@ #include "ui_qgsstyleexportimportdialogbase.h" #include "qgis_gui.h" +#include "qgis_sip.h" class QgsStyle; class QgsStyleGroupSelectionDialog; @@ -47,7 +48,7 @@ class GUI_EXPORT QgsStyleExportImportDialog : public QDialog, private Ui::QgsSty // constructor // mode argument must be 0 for saving and 1 for loading - QgsStyleExportImportDialog( QgsStyle *style, QWidget *parent = nullptr, Mode mode = Export ); + QgsStyleExportImportDialog( QgsStyle *style, QWidget *parent SIP_TRANSFERTHIS = nullptr, Mode mode = Export ); ~QgsStyleExportImportDialog(); /** diff --git a/src/gui/symbology-ng/qgsstylemanagerdialog.h b/src/gui/symbology-ng/qgsstylemanagerdialog.h index 06c60b5fbf8..26f81d6fea5 100644 --- a/src/gui/symbology-ng/qgsstylemanagerdialog.h +++ b/src/gui/symbology-ng/qgsstylemanagerdialog.h @@ -35,7 +35,7 @@ class GUI_EXPORT QgsStyleManagerDialog : public QDialog, private Ui::QgsStyleMan Q_OBJECT public: - QgsStyleManagerDialog( QgsStyle *style, QWidget *parent = nullptr ); + QgsStyleManagerDialog( QgsStyle *style, QWidget *parent SIP_TRANSFERTHIS = nullptr ); //! open add color ramp dialog, return color ramp's name if the ramp has been added static QString addColorRampStatic( QWidget *parent, QgsStyle *style, diff --git a/src/gui/symbology-ng/qgsstylesavedialog.h b/src/gui/symbology-ng/qgsstylesavedialog.h index ec271433729..a7272a7f436 100644 --- a/src/gui/symbology-ng/qgsstylesavedialog.h +++ b/src/gui/symbology-ng/qgsstylesavedialog.h @@ -23,6 +23,7 @@ #include "qgsstyle.h" #include "qgis_gui.h" +#include "qgis_sip.h" /** \ingroup gui * \brief a dialog for setting properties of a newly saved style. @@ -38,7 +39,7 @@ class GUI_EXPORT QgsStyleSaveDialog: public QDialog, private Ui::QgsStyleSaveDia * \param parent parent widget * \param type the QgsStyle entity type being saved */ - QgsStyleSaveDialog( QWidget *parent = nullptr, QgsStyle::StyleEntity type = QgsStyle::SymbolEntity ); + QgsStyleSaveDialog( QWidget *parent SIP_TRANSFERTHIS = nullptr, QgsStyle::StyleEntity type = QgsStyle::SymbolEntity ); //! returns the text value of the name element QString name() const; diff --git a/src/gui/symbology-ng/qgssvgselectorwidget.h b/src/gui/symbology-ng/qgssvgselectorwidget.h index 82a4e919a4b..e2915d6a145 100644 --- a/src/gui/symbology-ng/qgssvgselectorwidget.h +++ b/src/gui/symbology-ng/qgssvgselectorwidget.h @@ -38,6 +38,8 @@ class QListView; class QPushButton; class QTreeView; + +#ifndef SIP_RUN ///@cond PRIVATE /** \ingroup gui @@ -155,7 +157,7 @@ class GUI_EXPORT QgsSvgGroupLoader : public QThread }; ///@endcond -/// +#endif /** \ingroup gui * \class QgsSvgSelectorListModel @@ -272,7 +274,8 @@ class GUI_EXPORT QgsSvgSelectorDialog : public QDialog /** * Constructor for QgsSvgSelectorDialog. */ - QgsSvgSelectorDialog( QWidget *parent = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, + QgsSvgSelectorDialog( QWidget *parent SIP_TRANSFERTHIS = nullptr, + Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, QDialogButtonBox::StandardButtons buttons = QDialogButtonBox::Close | QDialogButtonBox::Ok, Qt::Orientation orientation = Qt::Horizontal ); ~QgsSvgSelectorDialog(); diff --git a/src/gui/symbology-ng/qgssymbollayerwidget.h b/src/gui/symbology-ng/qgssymbollayerwidget.h index 6402a27e1cb..dec741dfed0 100644 --- a/src/gui/symbology-ng/qgssymbollayerwidget.h +++ b/src/gui/symbology-ng/qgssymbollayerwidget.h @@ -116,7 +116,7 @@ class GUI_EXPORT QgsSimpleLineSymbolLayerWidget : public QgsSymbolLayerWidget, p Q_OBJECT public: - QgsSimpleLineSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsSimpleLineSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsSimpleLineSymbolLayerWidget( vl ); } @@ -166,7 +166,7 @@ class GUI_EXPORT QgsSimpleMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, Q_OBJECT public: - QgsSimpleMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsSimpleMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsSimpleMarkerSymbolLayerWidget( vl ); } @@ -216,7 +216,7 @@ class GUI_EXPORT QgsSimpleFillSymbolLayerWidget : public QgsSymbolLayerWidget, p Q_OBJECT public: - QgsSimpleFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsSimpleFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsSimpleFillSymbolLayerWidget( vl ); } @@ -305,7 +305,7 @@ class GUI_EXPORT QgsGradientFillSymbolLayerWidget : public QgsSymbolLayerWidget, Q_OBJECT public: - QgsGradientFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsGradientFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsGradientFillSymbolLayerWidget( vl ); } @@ -348,7 +348,7 @@ class GUI_EXPORT QgsShapeburstFillSymbolLayerWidget : public QgsSymbolLayerWidge Q_OBJECT public: - QgsShapeburstFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsShapeburstFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsShapeburstFillSymbolLayerWidget( vl ); } @@ -387,7 +387,7 @@ class GUI_EXPORT QgsMarkerLineSymbolLayerWidget : public QgsSymbolLayerWidget, p Q_OBJECT public: - QgsMarkerLineSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsMarkerLineSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsMarkerLineSymbolLayerWidget( vl ); } @@ -426,7 +426,7 @@ class GUI_EXPORT QgsSvgMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, pr Q_OBJECT public: - QgsSvgMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsSvgMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsSvgMarkerSymbolLayerWidget( vl ); } @@ -484,7 +484,7 @@ class GUI_EXPORT QgsRasterFillSymbolLayerWidget : public QgsSymbolLayerWidget, p Q_OBJECT public: - QgsRasterFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsRasterFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsRasterFillSymbolLayerWidget( vl ); } @@ -524,7 +524,7 @@ class GUI_EXPORT QgsSVGFillSymbolLayerWidget : public QgsSymbolLayerWidget, priv Q_OBJECT public: - QgsSVGFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsSVGFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsSVGFillSymbolLayerWidget( vl ); } @@ -573,7 +573,7 @@ class GUI_EXPORT QgsLinePatternFillSymbolLayerWidget : public QgsSymbolLayerWidg public: - QgsLinePatternFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsLinePatternFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsLinePatternFillSymbolLayerWidget( vl ); } virtual void setSymbolLayer( QgsSymbolLayer *layer ) override; @@ -604,7 +604,7 @@ class GUI_EXPORT QgsPointPatternFillSymbolLayerWidget: public QgsSymbolLayerWidg Q_OBJECT public: - QgsPointPatternFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsPointPatternFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsPointPatternFillSymbolLayerWidget( vl ); } virtual void setSymbolLayer( QgsSymbolLayer *layer ) override; @@ -639,7 +639,7 @@ class GUI_EXPORT QgsFontMarkerSymbolLayerWidget : public QgsSymbolLayerWidget, p Q_OBJECT public: - QgsFontMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsFontMarkerSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsFontMarkerSymbolLayerWidget( vl ); } @@ -695,7 +695,7 @@ class GUI_EXPORT QgsCentroidFillSymbolLayerWidget : public QgsSymbolLayerWidget, Q_OBJECT public: - QgsCentroidFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsCentroidFillSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); static QgsSymbolLayerWidget *create( const QgsVectorLayer *vl ) SIP_FACTORY { return new QgsCentroidFillSymbolLayerWidget( vl ); } @@ -726,7 +726,7 @@ class GUI_EXPORT QgsGeometryGeneratorSymbolLayerWidget : public QgsSymbolLayerWi Q_OBJECT public: - QgsGeometryGeneratorSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = 0 ); + QgsGeometryGeneratorSymbolLayerWidget( const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); /** * Will be registered as factory diff --git a/src/gui/symbology-ng/qgssymbollevelsdialog.h b/src/gui/symbology-ng/qgssymbollevelsdialog.h index 82fae4677fc..08b8a71581c 100644 --- a/src/gui/symbology-ng/qgssymbollevelsdialog.h +++ b/src/gui/symbology-ng/qgssymbollevelsdialog.h @@ -53,14 +53,19 @@ class GUI_EXPORT QgsSymbolLevelsDialog : public QDialog, private Ui::QgsSymbolLe //! \note not available in Python bindings void setDefaultLevels() SIP_SKIP; - protected: //! maximal number of layers from all symbols int mMaxLayers; QgsLegendSymbolList mList; //! whether symbol layers always should be used (default false) bool mForceOrderingEnabled; + + private: +#ifdef SIP_RUN + QgsSymbolLevelsDialog(); +#endif }; +#ifndef SIP_RUN ///@cond PRIVATE // delegate used from Qt Spin Box example @@ -82,5 +87,6 @@ class SpinBoxDelegate : public QItemDelegate }; ///@endcond +#endif #endif // QGSSYMBOLLEVELSDIALOG_H diff --git a/src/gui/symbology-ng/qgssymbolselectordialog.h b/src/gui/symbology-ng/qgssymbolselectordialog.h index 31a0f2ac337..70d0eb1785e 100644 --- a/src/gui/symbology-ng/qgssymbolselectordialog.h +++ b/src/gui/symbology-ng/qgssymbolselectordialog.h @@ -46,6 +46,7 @@ class QgsLineSymbolLayer; class QgsMapCanvas; +#ifndef SIP_RUN /// @cond PRIVATE class DataDefinedRestorer: public QObject @@ -75,6 +76,7 @@ class DataDefinedRestorer: public QObject void save(); }; ///@endcond +#endif class QgsSymbolSelectorDialog; @@ -96,7 +98,7 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs * \param vl The vector layer for the symbol. * \param parent */ - QgsSymbolSelectorWidget( QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent = nullptr ); + QgsSymbolSelectorWidget( QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr ); //! return menu for "advanced" button - create it if doesn't exist and show the advanced button QMenu *advancedMenu(); @@ -126,14 +128,14 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs * Reload the current symbol in the view. */ void loadSymbol(); - //! \note not available in Python bindings /** - * Load the given symbol into the widget.. + * Load the given symbol into the widget. * \param symbol The symbol to load. * \param parent The parent symbol layer item. + * \note not available in Python bindings */ - void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent ); + void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent ) SIP_SKIP; /** * Update the state of the UI based on the currently set symbol layer. @@ -249,7 +251,7 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog Q_OBJECT public: - QgsSymbolSelectorDialog( QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = 0, bool embedded = false ); + QgsSymbolSelectorDialog( QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent SIP_TRANSFERTHIS = nullptr, bool embedded = false ); ~QgsSymbolSelectorDialog(); //! return menu for "advanced" button - create it if doesn't exist and show the advanced button @@ -279,6 +281,7 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog void keyPressEvent( QKeyEvent *e ) override; void loadSymbol(); + //! \note not available in Python bindings void loadSymbol( QgsSymbol *symbol, SymbolLayerItem *parent ) SIP_SKIP; diff --git a/src/gui/symbology-ng/qgssymbolslistwidget.h b/src/gui/symbology-ng/qgssymbolslistwidget.h index e3f9dbd96ff..e4b366dd081 100644 --- a/src/gui/symbology-ng/qgssymbolslistwidget.h +++ b/src/gui/symbology-ng/qgssymbolslistwidget.h @@ -37,7 +37,7 @@ class GUI_EXPORT QgsSymbolsListWidget : public QWidget, private Ui::SymbolsListW Q_OBJECT public: - QgsSymbolsListWidget( QgsSymbol *symbol, QgsStyle *style, QMenu *menu, QWidget *parent, const QgsVectorLayer *layer = nullptr ); + QgsSymbolsListWidget( QgsSymbol *symbol, QgsStyle *style, QMenu *menu, QWidget *parent SIP_TRANSFERTHIS, const QgsVectorLayer *layer = nullptr ); virtual ~QgsSymbolsListWidget(); diff --git a/src/gui/symbology-ng/qgssymbolwidgetcontext.h b/src/gui/symbology-ng/qgssymbolwidgetcontext.h index 39403db8ea8..a8244d92ee5 100644 --- a/src/gui/symbology-ng/qgssymbolwidgetcontext.h +++ b/src/gui/symbology-ng/qgssymbolwidgetcontext.h @@ -15,9 +15,11 @@ #ifndef QGSSYMBOLWIDGETCONTEXT_H #define QGSSYMBOLWIDGETCONTEXT_H +#include + #include "qgsexpressioncontext.h" #include "qgis_gui.h" -#include + class QgsMapCanvas; @@ -85,7 +87,7 @@ class GUI_EXPORT QgsSymbolWidgetContext // clazy:exclude=rule-of-three * Ownership is transferred to the caller. * \since QGIS 3.0 */ - QList globalProjectAtlasMapLayerScopes( const QgsMapLayer *layer ) const; + QList globalProjectAtlasMapLayerScopes( const QgsMapLayer *layer ) const SIP_FACTORY; private: diff --git a/src/ui/symbollayer/widget_set_dd_value.ui b/src/ui/symbollayer/widget_set_dd_value.ui index f1b5aa9af93..0d6815f211e 100644 --- a/src/ui/symbollayer/widget_set_dd_value.ui +++ b/src/ui/symbollayer/widget_set_dd_value.ui @@ -1,13 +1,13 @@ - QgsDataDefinedValueDialog - + QgsDataDefinedValueBaseDialog + 0 0 - 194 - 78 + 214 + 81 @@ -64,7 +64,7 @@ buttonBox accepted() - QgsDataDefinedValueDialog + QgsDataDefinedValueBaseDialog accept() @@ -80,7 +80,7 @@ buttonBox rejected() - QgsDataDefinedValueDialog + QgsDataDefinedValueBaseDialog reject() diff --git a/tests/src/python/acceptable_missing_doc.py b/tests/src/python/acceptable_missing_doc.py index ad2394f8c9c..1b9aeff3cc0 100644 --- a/tests/src/python/acceptable_missing_doc.py +++ b/tests/src/python/acceptable_missing_doc.py @@ -59,7 +59,7 @@ ACCEPTABLE_MISSING_DOCS = { "QgsCheckBoxConfigDlg": ["QgsCheckBoxConfigDlg(QgsVectorLayer *vl, int fieldIdx, QWidget *parent=nullptr)"], "QgsMessageLog": ["MessageLevel", "instance()", "messageReceived(bool received)", "messageReceived(const QString &message, const QString &tag, QgsMessageLog::MessageLevel level)"], "QgsFontMarkerSymbolLayerWidget": ["setAngle(double angle)", "create(const QgsVectorLayer *vl)", "setFontFamily(const QFont &font)", "QgsFontMarkerSymbolLayerWidget(const QgsVectorLayer *vl, QWidget *parent=nullptr)", "setColor(const QColor &color)", "setOffset()", "setCharacter(QChar chr)", "setSize(double size)"], - "QgsStyleManagerDialog": ["removeItem()", "importItems()", "removeSymbol()", "addColorRamp(QAction *action)", "exportItemsSVG()", "editItem()", "exportSelectedItemsImages(const QString &dir, const QString &format, QSize size)", "editSymbol()", "editColorRamp()", "currentItemType()", "addGroup()", "groupSelectedSymbols()", "groupChanged(const QModelIndex &)", "addItem()", "itemChanged(QStandardItem *item)", "removeGroup()", "QgsStyleManagerDialog(QgsStyle *style, QWidget *parent=nullptr)", "groupRenamed(QStandardItem *)", "removeColorRamp()", "exportItemsPNG()", "exportItems()", "currentItemName()"], + "QgsStyleManagerDialog": ["removeItem()", "importItems()", "removeSymbol()", "addColorRamp(QAction *action)", "exportItemsSVG()", "editItem()", "exportSelectedItemsImages(const QString &dir, const QString &format, QSize size)", "editSymbol()", "editColorRamp()", "currentItemType()", "addGroup()", "groupSelectedSymbols()", "groupChanged(const QModelIndex &)", "addItem()", "itemChanged(QStandardItem *item)", "removeGroup()", "QgsStyleManagerDialog(QgsStyle *style, QWidget *parent SIP_TRANSFERTHIS=nullptr)", "groupRenamed(QStandardItem *)", "removeColorRamp()", "exportItemsPNG()", "exportItems()", "currentItemName()"], "QgsVectorColorBrewerColorRampDialog": ["setSchemeName()", "populateVariants()", "QgsVectorColorBrewerColorRampDialog(QgsVectorColorBrewerColorRamp *ramp, QWidget *parent=nullptr)", "setColors()", "updatePreview()"], "QgsFeatureListModel": ["fidToIndexList(QgsFeatureId fid)", "onBeginInsertRows(const QModelIndex &parent, int first, int last)", "onBeginRemoveRows(const QModelIndex &parent, int first, int last)", "featureByIndex(const QModelIndex &index, QgsFeature &feat)", "mapToMaster(const QModelIndex &proxyIndex) const ", "onEndRemoveRows(const QModelIndex &parent, int first, int last)", "setSourceModel(QgsAttributeTableFilterModel *sourceModel)", "onEndInsertRows(const QModelIndex &parent, int first, int last)", "fidToIdx(const QgsFeatureId fid) const ", "idxToFid(const QModelIndex &index) const ", "layerCache()", "mapSelectionFromMaster(const QItemSelection &selection) const ", "Role", "masterModel()", "displayExpression() const ", "mapFromMaster(const QModelIndex &sourceIndex) const ", "QgsFeatureListModel(QgsAttributeTableFilterModel *sourceModel, QObject *parent=0)", "mapSelectionToMaster(const QItemSelection &selection) const "], "QgsCptCityArchive": ["copyingInfo(const QString &fileName)", "QgsCptCityArchive(const QString &archiveName=DEFAULT_CPTCITY_ARCHIVE, const QString &baseDir=QString())", "baseDir(QString archiveName)", "defaultBaseDir()", "initArchive(const QString &archiveName, const QString &archiveBaseDir)", "archiveRegistry()", "descFileName(const QString &dirName) const ", "initArchives(bool loadAll=false)", "findFileName(const QString &target, const QString &startDir, const QString &baseDir)", "rootItems() const ", "copyingFileName(const QString &dirName) const ", "clearArchives()", "setBaseDir(const QString &dirName)", "isEmpty()", "baseDir() const ", "selectionItems() const ", "defaultArchive()", "initDefaultArchive()", "archiveName() const ", "description(const QString &fileName)"], @@ -189,7 +189,7 @@ ACCEPTABLE_MISSING_DOCS = { "QgsGraphDirector": ["buildProgress(int, int) const ", "buildMessage(const QString &) const ", "addProperter(QgsArcProperter *prop)"], "QgsScaleComboBox": ["QgsScaleComboBox(QWidget *parent=nullptr)", "updateScales(const QStringList &scales=QStringList())"], "QgsLabelingEngine": ["processProvider(QgsAbstractLabelProvider *provider, QgsRenderContext &context, pal::Pal &p)", "Flag"], # spellok - "QgsSymbolSelectorDialog": ["moveLayerByOffset(int offset)", "QgsSymbolSelectorDialog(QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent=0, bool embedded=false)", "lockLayer()", "moveLayerUp()", "updateUi()", "addLayer()", "moveLayerDown()", "layerChanged()", "loadSymbol()", "setWidget(QWidget *widget)", "updateLayerPreview()", "symbolModified()", "updateLockButton()", "removeLayer()", "currentLayer()", "updatePreview()"], + "QgsSymbolSelectorDialog": ["moveLayerByOffset(int offset)", "QgsSymbolSelectorDialog(QgsSymbol *symbol, QgsStyle *style, const QgsVectorLayer *vl, QWidget *parent=nullptr, bool embedded=false)", "lockLayer()", "moveLayerUp()", "updateUi()", "addLayer()", "moveLayerDown()", "layerChanged()", "loadSymbol()", "loadSymbol(QgsSymbol *symbol, SymbolLayerItem *parent)", "setWidget(QWidget *widget)", "updateLayerPreview()", "symbolModified()", "updateLockButton()", "removeLayer()", "currentLayer()", "updatePreview()"], "QgsCacheIndexFeatureId": ["QgsCacheIndexFeatureId(QgsVectorLayerCache *)"], "QgsSymbolLayerWidget": ["setSymbolLayer(QgsSymbolLayer *layer)=0", "updateDataDefinedProperty()", "QgsSymbolLayerWidget(QWidget *parent, const QgsVectorLayer *vl=nullptr)", "symbolLayer()=0"], "QgsRendererPropertiesDialog": ["apply()", "onOK()", "QgsRendererPropertiesDialog(QgsVectorLayer *layer, QgsStyle *style, bool embedded=false)"], @@ -221,7 +221,7 @@ ACCEPTABLE_MISSING_DOCS = { "QgsLinearlyInterpolatedDiagramRenderer": ["setLowerValue(double val)", "setClassificationAttribute(int index)", "classificationAttributeIsExpression() const ", "classificationAttributeExpression() const ", "setUpperSize(QSizeF s)", "setLowerSize(QSizeF s)", "classificationAttribute() const ", "lowerValue() const ", "upperSize() const ", "setClassificationAttributeIsExpression(bool isExpression)", "upperValue() const ", "setDiagramSettings(const QgsDiagramSettings &s)", "setClassificationAttributeExpression(const QString &expression)", "lowerSize() const ", "setUpperValue(double val)"], "QgsNMEAConnection": ["processGSVSentence(const char *data, int len)", "processVTGSentence(const char *data, int len)", "processGGASentence(const char *data, int len)", "QgsNMEAConnection(QIODevice *dev)", "processGSASentence(const char *data, int len)", "processRMCSentence(const char *data, int len)"], "QgsPreviewEffect": ["QgsPreviewEffect(QObject *parent)", "PreviewMode"], - "QgsGeometryGeneratorSymbolLayerWidget": ["QgsGeometryGeneratorSymbolLayerWidget(const QgsVectorLayer *vl, QWidget *parent=0)"], + "QgsGeometryGeneratorSymbolLayerWidget": ["QgsGeometryGeneratorSymbolLayerWidget(const QgsVectorLayer *vl, QWidget *parent=nullptr)"], "QgsProjectFileTransform": ["updateRevision(const QgsProjectVersion &version)", "convertRasterProperties(QDomDocument &doc, QDomNode &parentNode, QDomElement &rasterPropertiesElem, QgsRasterLayer *rlayer)"], "QgsCentroidFillSymbolLayer": ["create(const QgsStringMap &properties=QgsStringMap())", "pointOnSurface() const ", "createFromSld(QDomElement &element)", "setPointOnSurface(bool pointOnSurface)"], "QgsAdvancedDigitizingCanvasItem": ["QgsAdvancedDigitizingCanvasItem(QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget)"],