Skip to content
Permalink
Browse files
Autogenerate more sip files
  • Loading branch information
m-kuhn committed Apr 2, 2017
1 parent 16594da commit f4f45bf6c6b96377de07b445e78b5c13a9fd487b
Showing with 260 additions and 226 deletions.
  1. +0 −2 python/auto_sip.blacklist
  2. +136 −110 python/core/qgsaction.sip
  3. +122 −112 python/core/qgsactionmanager.sip
  4. +2 −2 src/core/qgsactionmanager.h
@@ -2,8 +2,6 @@ core/conversions.sip
core/qgsexception.sip
core/qgis.sip
core/qgsapplication.sip
core/qgsaction.sip
core/qgsactionmanager.sip
core/qgsaggregatecalculator.sip
core/qgsattributetableconfig.sip
core/qgsattributeeditorelement.sip
@@ -1,26 +1,22 @@
/***************************************************************************
qgsaction.h - QgsAction

---------------------
begin : 18.4.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. *
* *
***************************************************************************/

/** \ingroup core
* Utility class that encapsulates an action based on vector attributes.
*/
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsaction.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/




class QgsAction
{
%Docstring
Utility class that encapsulates an action based on vector attributes.
%End

%TypeHeaderCode
#include <qgsaction.h>
#include "qgsaction.h"
%End
public:
enum ActionType
@@ -33,118 +29,148 @@ class QgsAction
OpenUrl,
};

/**
* Default constructor
*/
QgsAction();
%Docstring
Default constructor
%End

QgsAction( ActionType type, const QString &description, const QString &command, bool capture = false );
%Docstring
Create a new QgsAction

@param type The type of this action
@param description A human readable description string
@param command The action text. Its interpretation depends on the type
@param capture If this is set to true, the output will be captured when an action is run
%End

QgsAction( ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, const QString &shortTitle = QString(), const QSet<QString> &actionScopes = QSet<QString>() );
%Docstring
Create a new QgsAction

@param type The type of this action
@param description A human readable description string
@param action The action text. Its interpretation depends on the type
@param icon Path to an icon for this action
@param capture If this is set to true, the output will be captured when an action is run
@param shortTitle A short string used to label user interface elements like buttons
@param actionScopes A set of scopes in which this action will be available
%End

/**
* Create a new QgsAction
*
* @param type The type of this action
* @param description A human readable description string
* @param command The action text. Its interpretation depends on the type
* @param capture If this is set to true, the output will be captured when an action is run
*/
QgsAction( ActionType type, const QString& description, const QString& command, bool capture = false );

/**
* Create a new QgsAction
*
* @param type The type of this action
* @param description A human readable description string
* @param action The action text. Its interpretation depends on the type
* @param icon Path to an icon for this action
* @param capture If this is set to true, the output will be captured when an action is run
* @param shortTitle A short string used to label user interface elements like buttons
* @param actionScopes A set of scopes in which this action will be available
*/
QgsAction( ActionType type, const QString& description, const QString& action, const QString& icon, bool capture, const QString& shortTitle = QString(), const QSet<QString>& actionScopes = QSet<QString>() );

//! The name of the action. This may be a longer description.
QString name() const;
%Docstring
The name of the action. This may be a longer description.
%End

//! The short title is used to label user interface elements like buttons
QString shortTitle() const;
%Docstring
The short title is used to label user interface elements like buttons
%End

/**
* Returns a unique id for this action.
*
* @note Added in QGIS 3.0
*/
QUuid id() const;
%Docstring
Returns a unique id for this action.

.. versionadded:: 3.0
%End

/**
* Returns true if this action was a default constructed one.
*
* @note Added in QGIS 3.0
*/
bool isValid() const;
%Docstring
Returns true if this action was a default constructed one.

.. versionadded:: 3.0
%End

//! The path to the icon
QString iconPath() const;
%Docstring
The path to the icon
%End

//! The icon
QIcon icon() const;
%Docstring
The icon
%End

//! The command
QString command() const;
%Docstring
Returns the command that is executed by this action.
How the content is interpreted depends on the type() and
the actionScope().

.. versionadded:: 3.0
%End

//! The action type
ActionType type() const;
%Docstring
The action type
%End

//! Whether to capture output for display when this action is run
bool capture() const;
%Docstring
Whether to capture output for display when this action is run
%End

//! Checks if the action is runable on the current platform
bool runable() const;
%Docstring
Checks if the action is runable on the current platform
%End

void run( QgsVectorLayer *layer, const QgsFeature &feature, const QgsExpressionContext &expressionContext ) const;
%Docstring
Run this action.

.. versionadded:: 3.0
%End

void run( const QgsExpressionContext &expressionContext ) const;
%Docstring
Run this action.

.. versionadded:: 3.0
%End

/**
* Run this action.
*
* @note Added in QGIS 3.0
*/
void run( QgsVectorLayer* layer, const QgsFeature& feature, const QgsExpressionContext& expressionContext ) const;

/**
* Run this action.
*
* @note Added in QGIS 3.0
*/
void run( const QgsExpressionContext& expressionContext ) const;

/**
* The action scopes define where an action will be available.
* Action scopes may offer additional variables like the clicked
* coordinate.
*
* @see QgsActionScope
* @note Added in QGIS 3.0
*/
QSet<QString> actionScopes() const;
%Docstring
The action scopes define where an action will be available.
Action scopes may offer additional variables like the clicked
coordinate.

@see QgsActionScope
.. versionadded:: 3.0
%End

void setActionScopes( const QSet<QString> &actionScopes );
%Docstring
The action scopes define where an action will be available.
Action scopes may offer additional variables like the clicked
coordinate.

.. versionadded:: 3.0
%End

void readXml( const QDomNode &actionNode );
%Docstring
Reads an XML definition from actionNode
into this object.

.. versionadded:: 3.0
%End

void writeXml( QDomNode &actionsNode ) const;
%Docstring
Appends an XML definition for this action as a new
child node to actionsNode.

.. versionadded:: 3.0
%End

/**
* The action scopes define where an action will be available.
* Action scopes may offer additional variables like the clicked
* coordinate.
*
* @note Added in QGIS 3.0
*/
void setActionScopes( const QSet<QString>& actionScopes );

/**
* Reads an XML definition from actionNode
* into this object.
*
* @note Added in QGIS 3.0
*/
void readXml( const QDomNode& actionNode );

/**
* Appends an XML definition for this action as a new
* child node to actionsNode.
*
* @note Added in QGIS 3.0
*/
void writeXml(QDomNode& actionsNode ) const;
};


/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsaction.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
Loading

0 comments on commit f4f45bf

Please sign in to comment.