QgsAction Class Reference

Utility class that encapsulates an action based on vector attributes. More...

#include <qgsaction.h>

Public Types
enum	ActionType {   Generic, GenericPython, Mac, Windows,   Unix, OpenUrl }

Public Member Functions
	QgsAction (ActionType type, const QString &description, const QString &action, bool capture)
	Create a new QgsAction. More...
	QgsAction (ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, const QString &shortTitle=QString())
	Create a new QgsAction. More...
	QgsAction (ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, bool showInAttributeTable, const QString &shortTitle=QString())
	Create a new QgsAction. More...
QString	action () const
	The action. More...
bool	capture () const
	Whether to capture output for display when this action is run. More...
QIcon	icon () const
	The icon. More...
QString	iconPath () const
	The path to the icon. More...
QString	name () const
	The name of the action. This may be a longer description. More...
bool	runable () const
	Checks if the action is runable on the current platform. More...
QString	shortTitle () const
	The short title is used to label user interface elements like buttons. More...
bool	showInAttributeTable () const
	Whether this action should be shown on the attribute table. More...
ActionType	type () const
	The action type. More...

Detailed Description

Utility class that encapsulates an action based on vector attributes.

Definition at line 25 of file qgsaction.h.

Member Enumeration Documentation

ActionType

enum QgsAction::ActionType

Enumerator
Generic
GenericPython
Mac
Windows
Unix
OpenUrl

Definition at line 28 of file qgsaction.h.

Constructor & Destructor Documentation

QgsAction() [1/3]

QgsAction::QgsAction ( ActionType  type, const QString &  description, const QString &  action, bool  capture  )

inline

Create a new QgsAction.

Parameters

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

Definition at line 46 of file qgsaction.h.

QgsAction() [2/3]

QgsAction::QgsAction ( ActionType  type, const QString &  description, const QString &  action, const QString &  icon, bool  capture, const QString &  shortTitle = QString()  )

inline

Create a new QgsAction.

Parameters

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

Definition at line 65 of file qgsaction.h.

QgsAction() [3/3]

QgsAction::QgsAction ( ActionType  type, const QString &  description, const QString &  action, const QString &  icon, bool  capture, bool  showInAttributeTable, const QString &  shortTitle = QString()  )

inline

Create a new QgsAction.

Parameters

type	The type of this action
description	A human readable description string
action	The action text. Its interpretation depends on the type
icon	Path to an icon for this action
capture	If this is set to true, the output will be captured when an action is run
showInAttributeTable	If this is false, the action will be hidden on the attribute table action widget
shortTitle	A short string used to label user interface elements like buttons

Definition at line 86 of file qgsaction.h.

Member Function Documentation

action()

QString QgsAction::action ( ) const

inline

The action.

Definition at line 109 of file qgsaction.h.

capture()

bool QgsAction::capture ( ) const

inline

Whether to capture output for display when this action is run.

Definition at line 115 of file qgsaction.h.

icon()

QIcon QgsAction::icon ( ) const

inline

The icon.

Definition at line 106 of file qgsaction.h.

iconPath()

QString QgsAction::iconPath ( ) const

inline

The path to the icon.

Definition at line 103 of file qgsaction.h.

name()

QString QgsAction::name ( ) const

inline

The name of the action. This may be a longer description.

Definition at line 97 of file qgsaction.h.

runable()

bool QgsAction::runable

(

)

const

Checks if the action is runable on the current platform.

Definition at line 19 of file qgsaction.cpp.

shortTitle()

QString QgsAction::shortTitle ( ) const

inline

The short title is used to label user interface elements like buttons.

Definition at line 100 of file qgsaction.h.

showInAttributeTable()

bool QgsAction::showInAttributeTable ( ) const

inline

Whether this action should be shown on the attribute table.

Definition at line 118 of file qgsaction.h.

type()

ActionType QgsAction::type ( ) const

inline

The action type.

Definition at line 112 of file qgsaction.h.

---

The documentation for this class was generated from the following files:

• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsaction.h
• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsaction.cpp