QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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, QString name, QString action, bool capture)
 QgsAction (ActionType type, QString name, QString action, const QString &icon, bool capture)
QString name () const
 The name of the action.
const QString iconPath () const
 The path to the icon.
const QIcon icon () const
 The icon.
QString action () const
 The action.
ActionType type () const
 The action type.
bool capture () const
 Whether to capture output for display when this action is run.
bool runable () const
 Whether the action is runable on the current platform.

Detailed Description

Utility class that encapsulates an action based on vector attributes.

Member Enumeration Documentation

Enumerator:
Generic 
GenericPython 
Mac 
Windows 
Unix 
OpenUrl 

Constructor & Destructor Documentation

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

Member Function Documentation

QString QgsAction::action ( ) const
inline

The action.

bool QgsAction::capture ( ) const
inline

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

const QIcon QgsAction::icon ( ) const
inline

The icon.

const QString QgsAction::iconPath ( ) const
inline

The path to the icon.

QString QgsAction::name ( ) const
inline

The name of the action.

bool QgsAction::runable ( ) const
inline

Whether the action is runable on the current platform.

ActionType QgsAction::type ( ) const
inline

The action type.


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