QGIS API Documentation  2.14.0-Essen
Public Types | Public Member Functions | List of all members
QgsAction Class Reference

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

#include <qgsattributeaction.h>

Public Types

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

Public Member Functions

 QgsAction (ActionType type, const QString &name, const QString &action, bool capture)
 
 QgsAction (ActionType type, const QString &name, const QString &action, const QString &icon, bool capture)
 
QString action () const
 The action. More...
 
bool capture () const
 Whether to capture output for display when this action is run. More...
 
const QIcon icon () const
 The icon. More...
 
const QString iconPath () const
 The path to the icon. More...
 
QString name () const
 The name of the action. More...
 
bool runable () const
 Whether the action is runable on the current platform. More...
 
ActionType type () const
 The action type. More...
 

Detailed Description

Utility class that encapsulates an action based on vector attributes.

Definition at line 41 of file qgsattributeaction.h.

Member Enumeration Documentation

Enumerator
Generic 
GenericPython 
Mac 
Windows 
Unix 
OpenUrl 

Definition at line 44 of file qgsattributeaction.h.

Constructor & Destructor Documentation

QgsAction::QgsAction ( ActionType  type,
const QString name,
const QString action,
bool  capture 
)
inline

Definition at line 54 of file qgsattributeaction.h.

QgsAction::QgsAction ( ActionType  type,
const QString name,
const QString action,
const QString icon,
bool  capture 
)
inline

Definition at line 57 of file qgsattributeaction.h.

Member Function Documentation

QString QgsAction::action ( ) const
inline

The action.

Definition at line 70 of file qgsattributeaction.h.

bool QgsAction::capture ( ) const
inline

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

Definition at line 76 of file qgsattributeaction.h.

const QIcon QgsAction::icon ( ) const
inline

The icon.

Definition at line 67 of file qgsattributeaction.h.

const QString QgsAction::iconPath ( ) const
inline

The path to the icon.

Definition at line 64 of file qgsattributeaction.h.

QString QgsAction::name ( ) const
inline

The name of the action.

Definition at line 61 of file qgsattributeaction.h.

bool QgsAction::runable ( ) const
inline

Whether the action is runable on the current platform.

Definition at line 79 of file qgsattributeaction.h.

ActionType QgsAction::type ( ) const
inline

The action type.

Definition at line 73 of file qgsattributeaction.h.


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