mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-26 00:02:08 -05:00
99 lines
3.8 KiB
Plaintext
99 lines
3.8 KiB
Plaintext
/***************************************************************************
|
|
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.
|
|
*/
|
|
class QgsAction
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgsaction.h>
|
|
%End
|
|
public:
|
|
enum ActionType
|
|
{
|
|
Generic,
|
|
GenericPython,
|
|
Mac,
|
|
Windows,
|
|
Unix,
|
|
OpenUrl,
|
|
};
|
|
|
|
/**
|
|
* 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 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& action, bool capture );
|
|
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
QgsAction( ActionType type, const QString& description, const QString& action, const QString& icon, bool capture, const QString& shortTitle = QString() );
|
|
|
|
/**
|
|
* 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 showInAttributeTable If this is false, the action will be hidden on the attribute table action widget
|
|
* @param shortTitle A short string used to label user interface elements like buttons
|
|
*/
|
|
QgsAction( ActionType type, const QString& description, const QString& action, const QString& icon, bool capture, bool showInAttributeTable, const QString& shortTitle = QString() );
|
|
|
|
//! The name of the action. This may be a longer description.
|
|
QString name() const;
|
|
|
|
//! The short title is used to label user interface elements like buttons
|
|
QString shortTitle() const;
|
|
|
|
//! The path to the icon
|
|
QString iconPath() const;
|
|
|
|
//! The icon
|
|
QIcon icon() const;
|
|
|
|
//! The action
|
|
QString action() const;
|
|
|
|
//! The action type
|
|
ActionType type() const;
|
|
|
|
//! Whether to capture output for display when this action is run
|
|
bool capture() const;
|
|
|
|
//! Wheter this action should be shown on the attribute table
|
|
bool showInAttributeTable() const;
|
|
|
|
//! Whether the action is runable on the current platform
|
|
bool runable() const;
|
|
};
|