te::vp::qt::VectorProcessingDialogCapabilities Class Reference

A class used to define the base capabilities of an operation, including number of inputs and outputs. More...

#include <VectorProcessingDialogCapabilities.h>

Inheritance diagram for te::vp::qt::VectorProcessingDialogCapabilities:
te::vp::qt::DifferenceDialogCapabilities te::vp::qt::DissolveDialogCapabilities te::vp::qt::DissolveSubdivisionDialogCapabilities te::vp::qt::IdentityDialogCapabilities te::vp::qt::IntersectionDialogCapabilities te::vp::qt::MakeValidDialogCapabilities te::vp::qt::SubdivideDialogCapabilities te::vp::qt::UnionDialogCapabilities

Public Member Functions

const std::string & getCaption () const
 Returns the description of the operation. More...
 
const std::string & getDescription () const
 Returns the icon of the operation. More...
 
const std::string & getHelpPageNamespace () const
 Returns help page referece. More...
 
const std::string & getHelpPageReference () const
 Returns the configuration enable property selection. More...
 
const QPixmap & getHintPixmap () const
 Returns help page namespace. More...
 
const QIcon & getIcon () const
 Returns the hint pixmap of the operation. More...
 
const std::string & getName () const
 Returns the caption of the operation. More...
 
virtual SpecificParametersWidgetgetParametersWidget (QWidget *parent=nullptr) const
 
bool isPropertySelectionEnable () const
 Returns the widget contiaing the specific inputs of the operation. Returns nullptr if there aren't specific parameters for the operation. More...
 
 VectorProcessingDialogCapabilities (const std::string &operationName, const std::string &caption, const std::string &description, const std::string &icon, const std::string &hintPixmap, const std::string &helpPageNamespace, const std::string &helpPageReference, bool enablePropertySelection=true)
 Destructor. More...
 
virtual ~VectorProcessingDialogCapabilities ()
 Returns the name of the operation. More...
 

Protected Attributes

std::string m_caption
 The caption of the widget. More...
 
std::string m_description
 The caption of the widget. More...
 
bool m_enablePropertySelection
 If TRUE, it allows the user to select the properties that will be used to create the output DataSet. More...
 
std::string m_helpPageNamespace
 The help page namespace. More...
 
std::string m_helpPageReference
 The help page referece. More...
 
std::string m_hintPixmap
 The hint pixmap to be used in the widget. More...
 
std::string m_icon
 The icon of the operation. More...
 
std::string m_operationName
 The name of the operation. More...
 
QPixmap m_qHintPixmap
 The hint pixmap to be used in the widget. More...
 
QIcon m_qIcon
 The icon of the operation. More...
 

Detailed Description

A class used to define the base capabilities of an operation, including number of inputs and outputs.

Definition at line 56 of file VectorProcessingDialogCapabilities.h.

Constructor & Destructor Documentation

◆ VectorProcessingDialogCapabilities()

te::vp::qt::VectorProcessingDialogCapabilities::VectorProcessingDialogCapabilities ( const std::string &  operationName,
const std::string &  caption,
const std::string &  description,
const std::string &  icon,
const std::string &  hintPixmap,
const std::string &  helpPageNamespace,
const std::string &  helpPageReference,
bool  enablePropertySelection = true 
)

Destructor.

◆ ~VectorProcessingDialogCapabilities()

virtual te::vp::qt::VectorProcessingDialogCapabilities::~VectorProcessingDialogCapabilities ( )
virtual

Returns the name of the operation.

Member Function Documentation

◆ getCaption()

const std::string& te::vp::qt::VectorProcessingDialogCapabilities::getCaption ( ) const

Returns the description of the operation.

◆ getDescription()

const std::string& te::vp::qt::VectorProcessingDialogCapabilities::getDescription ( ) const

Returns the icon of the operation.

◆ getHelpPageNamespace()

const std::string& te::vp::qt::VectorProcessingDialogCapabilities::getHelpPageNamespace ( ) const

Returns help page referece.

◆ getHelpPageReference()

const std::string& te::vp::qt::VectorProcessingDialogCapabilities::getHelpPageReference ( ) const

Returns the configuration enable property selection.

◆ getHintPixmap()

const QPixmap& te::vp::qt::VectorProcessingDialogCapabilities::getHintPixmap ( ) const

Returns help page namespace.

◆ getIcon()

const QIcon& te::vp::qt::VectorProcessingDialogCapabilities::getIcon ( ) const

Returns the hint pixmap of the operation.

◆ getName()

const std::string& te::vp::qt::VectorProcessingDialogCapabilities::getName ( ) const

Returns the caption of the operation.

◆ getParametersWidget()

virtual SpecificParametersWidget* te::vp::qt::VectorProcessingDialogCapabilities::getParametersWidget ( QWidget *  parent = nullptr) const
virtual

◆ isPropertySelectionEnable()

bool te::vp::qt::VectorProcessingDialogCapabilities::isPropertySelectionEnable ( ) const

Returns the widget contiaing the specific inputs of the operation. Returns nullptr if there aren't specific parameters for the operation.

Member Data Documentation

◆ m_caption

std::string te::vp::qt::VectorProcessingDialogCapabilities::m_caption
protected

The caption of the widget.

Definition at line 103 of file VectorProcessingDialogCapabilities.h.

◆ m_description

std::string te::vp::qt::VectorProcessingDialogCapabilities::m_description
protected

The caption of the widget.

Definition at line 104 of file VectorProcessingDialogCapabilities.h.

◆ m_enablePropertySelection

bool te::vp::qt::VectorProcessingDialogCapabilities::m_enablePropertySelection
protected

If TRUE, it allows the user to select the properties that will be used to create the output DataSet.

Definition at line 111 of file VectorProcessingDialogCapabilities.h.

◆ m_helpPageNamespace

std::string te::vp::qt::VectorProcessingDialogCapabilities::m_helpPageNamespace
protected

The help page namespace.

Definition at line 107 of file VectorProcessingDialogCapabilities.h.

◆ m_helpPageReference

std::string te::vp::qt::VectorProcessingDialogCapabilities::m_helpPageReference
protected

The help page referece.

Definition at line 108 of file VectorProcessingDialogCapabilities.h.

◆ m_hintPixmap

std::string te::vp::qt::VectorProcessingDialogCapabilities::m_hintPixmap
protected

The hint pixmap to be used in the widget.

Definition at line 106 of file VectorProcessingDialogCapabilities.h.

◆ m_icon

std::string te::vp::qt::VectorProcessingDialogCapabilities::m_icon
protected

The icon of the operation.

Definition at line 105 of file VectorProcessingDialogCapabilities.h.

◆ m_operationName

std::string te::vp::qt::VectorProcessingDialogCapabilities::m_operationName
protected

The name of the operation.

Definition at line 102 of file VectorProcessingDialogCapabilities.h.

◆ m_qHintPixmap

QPixmap te::vp::qt::VectorProcessingDialogCapabilities::m_qHintPixmap
protected

The hint pixmap to be used in the widget.

Definition at line 110 of file VectorProcessingDialogCapabilities.h.

◆ m_qIcon

QIcon te::vp::qt::VectorProcessingDialogCapabilities::m_qIcon
protected

The icon of the operation.

Definition at line 109 of file VectorProcessingDialogCapabilities.h.


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