Skip to content
Permalink
Browse files
Autogenerate some sip files
  • Loading branch information
m-kuhn committed Mar 31, 2017
1 parent 8a44161 commit 6208986852dbdd67cfe939fbca4a9b3c3bf76373
@@ -3,12 +3,8 @@ core/qgsexception.sip
core/qgis.sip
core/qgsapplication.sip
core/qgsaction.sip
core/qgssettings.sip
core/qgsactionmanager.sip
core/qgsactionscope.sip
core/qgsactionscoperegistry.sip
core/qgsaggregatecalculator.sip
core/qgsanimatedicon.sip
core/qgsattributetableconfig.sip
core/qgsattributeeditorelement.sip
core/qgsbearingutils.sip
@@ -1,116 +1,95 @@
/***************************************************************************
qgsactionscope.sip - QgsActionScope

---------------------
begin : 1.11.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
* An action scope defines a "place" for an action to be shown and may add
* additional expression variables.
* Each QgsAction can be available in one or several action scopes.
*
* Examples:
* ---------
*
* <dl>
* <dt>Canvas</dt>
* <dd>Show for canvas tools. Adds `@clicked_x` and `@clicked_y` in map coordinates.</dd>
* <dt>Feature</dt>
* <dd>Show in feature specific places like the attribute table or feature
* form.</dd>
* <dt>Field</dt>
* <dd>Show in context menus for individual fields (e.g. attribute table). Adds `@field_index`, `@field_name` and `@field_value`.</dd>
* <dt>Layer</dt>
* <dd>Show in attribute table and work on the layer or selection.</dd>
* </dl>
*
* @note Added in QGIS 3.0
*/
/******************************************************************
* This file has been generated automatically by sipify.pl *
* Do not edit manually ! Edit header file and generate it again. *
*****************************************************************/



class QgsActionScope
{

%TypeHeaderCode
#include "qgsactionscope.h"
%End
public:
/**
* Creates a new invalid action scope.
*
* @note Added in QGSI 3.0
*/

explicit QgsActionScope();
%Docstring
Creates a new invalid action scope.

@note Added in QGSI 3.0
%End

explicit QgsActionScope( const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope = QgsExpressionContextScope() );
%Docstring
Creates a new action scope.
For details concerning the parameters check the documentation
of the corresponding properties.
%End

bool operator==( const QgsActionScope &other ) const;
%Docstring
Compares two action scopes
%End

/**
* Creates a new action scope.
* For details concerning the parameters check the documentation
* of the corresponding properties.
*/
explicit QgsActionScope( const QString& id, const QString& title, const QString& description, const QgsExpressionContextScope& expressionContextScope = QgsExpressionContextScope() );

/**
* Compares two action scopes
*/
bool operator==( const QgsActionScope& other ) const;

/**
* An expression scope may offer additional variables for an action scope.
* This can be an `field_name` for the attribute which was clicked or
* `clicked_x` and `clicked_y` for actions which are available as map canvas clicks.
*
* @note Added in QGIS 3.0
*/
QgsExpressionContextScope expressionContextScope() const;
%Docstring
An expression scope may offer additional variables for an action scope.
This can be an `field_name` for the attribute which was clicked or
`clicked_x` and `clicked_y` for actions which are available as map canvas clicks.

/**
* \copydoc expressionContextScope()
*/
void setExpressionContextScope( const QgsExpressionContextScope& expressionContextScope );
@note Added in QGIS 3.0
%End

void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
%Docstring
\copydoc expressionContextScope()
%End

/**
* A unique identifier for this action scope.
*
* @note Added in QGIS 3.0
*/
QString id() const;
%Docstring
A unique identifier for this action scope.

//! \copydoc id()
void setId( const QString& id );
@note Added in QGIS 3.0
%End

void setId( const QString &id );
%Docstring
\copydoc id()
%End

/**
* The title is a human readable and translated string that will be
* presented to the user in the properties dialog.
*
* @note Added in QGIS 3.0
*/
QString title() const;
//! \copydoc title()
void setTitle( const QString& title );

/**
* The description should be a longer description of where actions in this scope
* are available. It is not necessary to list the available expression variables
* in here, they are extracted automatically from the expressionContextScope().
*
* @note Added in QGIS 3.0
*/
%Docstring
The title is a human readable and translated string that will be
presented to the user in the properties dialog.

@note Added in QGIS 3.0
%End
void setTitle( const QString &title );
%Docstring
\copydoc title()
%End

QString description() const;
//! \copydoc description()
void setDescription( const QString& description );

/**
* Returns if this scope is valid.
*
* @note Added in QGIS 3.0
*/
%Docstring
The description should be a longer description of where actions in this scope
are available. It is not necessary to list the available expression variables
in here, they are extracted automatically from the expressionContextScope().

@note Added in QGIS 3.0
%End
void setDescription( const QString &description );
%Docstring
\copydoc description()
%End

bool isValid() const;
%Docstring
Returns if this scope is valid.

@note Added in QGIS 3.0
%End

};


@@ -1,84 +1,80 @@
/***************************************************************************
qgsactionscoperegistry.h - QgsActionScopeRegistry

---------------------
begin : 1.11.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
* The action scope registry is an application wide registry that
* contains a list of available action scopes.
* Some scopes are available by default, additional ones can be registered
* at runtime by plugins or custom applications.
*
* To get access use the QgsApplication:
*
* ```
* QgsApplication::actionScopeRegistry()
* ```
*
* @note Added in QGIS 3.0
*/
/******************************************************************
* This file has been generated automatically by sipify.pl *
* Do not edit manually ! Edit header file and generate it again. *
*****************************************************************/


class QgsActionScopeRegistry : QObject
{
%Docstring
\ingroup core
The action scope registry is an application wide registry that
contains a list of available action scopes.
Some scopes are available by default, additional ones can be registered
at runtime by plugins or custom applications.

To get access use the QgsApplication:

```
QgsApplication::actionScopeRegistry()
```

@note Added in QGIS 3.0
%End

%TypeHeaderCode
#include "qgsactionscoperegistry.h"
%End

public:
/**
* Create a new QgsActionScopeRegistry.
* QGIS already creates a central registry. You will normally
* want to use QgsApplication::actionScopeRegistry() to get access
* to that one instead.
*
* @note Added in QGIS 3.0
*/
explicit QgsActionScopeRegistry( QObject* parent = nullptr );

/**
* Get all registered action scopes.
*
* @note Added in QGIS 3.0
*/

explicit QgsActionScopeRegistry( QObject *parent = 0 );
%Docstring
Create a new QgsActionScopeRegistry.
QGIS already creates a central registry. You will normally
want to use QgsApplication::actionScopeRegistry() to get access
to that one instead.

@note Added in QGIS 3.0
%End

QSet<QgsActionScope> actionScopes() const;
%Docstring
Get all registered action scopes.

@note Added in QGIS 3.0
%End

/**
* Register an additional action scope.
*
* @note Added in QGIS 3.0
*/
void registerActionScope( const QgsActionScope& actionScope );

/**
* Unregister an additional action scope.
*
* @note Added in QGIS 3.0
*/
void unregisterActionScope( const QgsActionScope& actionScope );

/**
* Get an action scope by its id.
*
* @note Added in QGIS 3.0
*/
QgsActionScope actionScope( const QString& id );
void registerActionScope( const QgsActionScope &actionScope );
%Docstring
Register an additional action scope.

@note Added in QGIS 3.0
%End

void unregisterActionScope( const QgsActionScope &actionScope );
%Docstring
Unregister an additional action scope.

@note Added in QGIS 3.0
%End

QgsActionScope actionScope( const QString &id );
%Docstring
Get an action scope by its id.

@note Added in QGIS 3.0
%End

signals:
/**
* Emitted whenever a new action scope is registered or an action scope
* is unregistered.
*
* @note Added in QGIS 3.0
*/

void actionScopesChanged();
%Docstring
Emitted whenever a new action scope is registered or an action scope
is unregistered.

@note Added in QGIS 3.0
%End

};

0 comments on commit 6208986

Please sign in to comment.