Quantum GIS API Documentation  master-ce49b66
QgsAction Class Reference

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

#include <qgsattributeaction.h>

List of all members.

Public Types

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

Public Member Functions

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

Private Attributes

QString mAction
bool mCaptureOutput
QString mName
ActionType mType

Detailed Description

Utility class that encapsulates an action based on vector attributes.

Definition at line 40 of file qgsattributeaction.h.


Member Enumeration Documentation

Enumerator:
Generic 
GenericPython 
Mac 
Windows 
Unix 
OpenUrl 

Definition at line 43 of file qgsattributeaction.h.


Constructor & Destructor Documentation

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

Definition at line 53 of file qgsattributeaction.h.


Member Function Documentation

QString QgsAction::action ( ) const [inline]

The action.

Definition at line 60 of file qgsattributeaction.h.

Referenced by QgsAttributeAction::doAction(), and QgsAttributeAction::runAction().

bool QgsAction::capture ( ) const [inline]

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

Definition at line 66 of file qgsattributeaction.h.

Referenced by QgsAttributeAction::doAction(), and QgsAttributeAction::runAction().

QString QgsAction::name ( ) const [inline]

The name of the action.

Definition at line 57 of file qgsattributeaction.h.

Referenced by QgsAttributeAction::doAction(), and QgsDualView::viewWillShowContextMenu().

bool QgsAction::runable ( ) const [inline]

Whether the action is runable on the current platform.

Definition at line 69 of file qgsattributeaction.h.

Referenced by QgsAttributeAction::doAction(), and QgsDualView::viewWillShowContextMenu().

ActionType QgsAction::type ( ) const [inline]

The action type.

Definition at line 63 of file qgsattributeaction.h.

Referenced by QgsAttributeAction::doAction(), and QgsAttributeAction::runAction().


Member Data Documentation

QString QgsAction::mAction [private]

Definition at line 87 of file qgsattributeaction.h.

bool QgsAction::mCaptureOutput [private]

Definition at line 88 of file qgsattributeaction.h.

QString QgsAction::mName [private]

Definition at line 86 of file qgsattributeaction.h.

Definition at line 85 of file qgsattributeaction.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines