Fix python bindings for QgsAttributeAction

2025-04-17 00:04:02 -04:00 · 2016-05-11 10:02:43 +02:00 · 2016-05-11 10:02:43 +02:00 · 1e9a40fb62
commit 1e9a40fb62
parent d088fe072d
1 changed files with 108 additions and 2 deletions
--- a/python/core/qgsattributeaction.sip
+++ b/python/core/qgsattributeaction.sip
@ -18,8 +18,114 @@
 *                                                                         *
 ***************************************************************************/

-/**
+/** \class QgsAttributeAction
 * QgsAttributeAction is deprecated and has been replaced with
 * QgsActionManager. This legacy typedef will be removed with QGIS 3.
 */
-typedef QgsActionManager QgsAttributeAction;
+
+class QgsAttributeAction
+{
+%TypeHeaderCode
+#include <qgsattributeaction.h>
+%End
+  public:
+    //! Constructor
+    QgsAttributeAction( QgsVectorLayer *layer );
+
+    //! Destructor
+    virtual ~QgsAttributeAction();
+
+    /** Add an action with the given name and action details.
+     * Will happily have duplicate names and actions. If
+     * capture is true, when running the action using doAction(),
+     * any stdout from the process will be captured and displayed in a
+     * dialog box.
+     */
+    void addAction( QgsAction::ActionType type, const QString& name, const QString& action, bool capture = false );
+
+    /** Add an action with the given name and action details.
+     * Will happily have duplicate names and actions. If
+     * capture is true, when running the action using doAction(),
+     * any stdout from the process will be captured and displayed in a
+     * dialog box.
+     */
+    void addAction( QgsAction::ActionType type, const QString& name, const QString& action, const QString& icon, bool capture = false );
+
+    //! Remove an action at given index
+    void removeAction( int index );
+
+    /** Does the given values. defaultValueIndex is the index of the
+     *  field to be used if the action has a $currfield placeholder.
+     *  @note available in python bindings as doActionFeature
+     */
+    void doAction( int index,
+                   const QgsFeature &feat,
+                   int defaultValueIndex = 0 ) /PyName=doActionFeature/;
+
+    /** Does the action using the expression builder to expand it
+     *  and getting values from the passed feature attribute map.
+     *  substitutionMap is used to pass custom substitutions, to replace
+     *  each key in the map with the associated value
+     *  @note available in python bindings as doActionFeatureWithSubstitution
+     */
+    void doAction( int index,
+                   const QgsFeature &feat,
+                   const QMap<QString, QVariant> *substitutionMap ) /PyName=doActionFeatureWithSubstitution/;
+
+    //! Removes all actions
+    void clearActions();
+
+    //! List all actions
+    QList<QgsAction> listActions() const;
+
+    //! Return the layer
+    QgsVectorLayer* layer() const;
+
+    /** Expands the given action, replacing all %'s with the value as
+     *  given.
+     */
+    QString expandAction( QString action, const QMap<int, QVariant> &attributes, uint defaultValueIndex );
+
+    /** Expands the given action using the expression builder
+     *  This function currently replaces each expression between [% and %]
+     *  placeholders in the action with the result of its evaluation on
+     *  the feature passed as argument.
+     *
+     *  Additional substitutions can be passed through the substitutionMap
+     *  parameter
+     */
+    QString expandAction( const QString& action,
+                          QgsFeature &feat,
+                          const QMap<QString, QVariant> *substitutionMap = 0 );
+
+
+    //! Writes the actions out in XML format
+    bool writeXML( QDomNode& layer_node, QDomDocument& doc ) const;
+
+    //! Reads the actions in in XML format
+    bool readXML( const QDomNode& layer_node );
+
+    int size() const;
+    /**
+     * Get the action at the specified index.
+     */
+    QgsAction at( int idx ) const;
+    /**
+     * Get the action at the specified index.
+     */
+    QgsAction operator[]( int idx ) const;
+
+    /** @deprecated Initialize QgsPythonRunner instead
+     * @note not available in Python bindings
+     */
+    // Q_DECL_DEPRECATED static void setPythonExecute( void ( * )( const QString & ) );
+
+    /**
+     * Get the index of the default action
+     */
+    int defaultAction() const;
+    /**
+     * Set the index of the default action
+     */
+    void setDefaultAction( int actionNumber );
+};