Public Member Functions | Static Public Member Functions | List of all members
pqProxyInfo Class Reference

Proxy meta data structure for the User Interface. More...

#include <pqProxyInfo.h>

Inherits QObject.

Public Member Functions

 pqProxyInfo (pqProxyCategory *parent, const QString &name, const QString &group, const QString &label, const QString &icon="", const QStringList &omitFromToolbar=QStringList(), bool hideFromMenu=false)
 
 pqProxyInfo (pqProxyCategory *parent, pqProxyInfo *other)
 create a pqProxyInfo with same attributes as other. More...
 
 pqProxyInfo (pqProxyCategory *parent, vtkPVXMLElement *xmlElement)
 
 pqProxyInfo ()=default
 
void setLabel (const QString &label)
 Set label. More...
 
void setHideFromMenu (bool hidden)
 Set HideFromMenu. More...
 
void setIcon (const QString &iconPath)
 Set Icon path. More...
 
void merge (pqProxyInfo *other)
 Merge pqProxyInfo meta data into self. More...
 
void convertToXML (vtkPVXMLElement *root)
 Create the xml element and add it under given root. More...
 
QString name ()
 Return member. More...
 
QString group ()
 Return member. More...
 
QString label ()
 return the translated label, or create one from name if empty. More...
 
QString icon ()
 Return member. More...
 
QStringList omitFromToolbar ()
 Return member. More...
 
bool hideFromMenu ()
 Return member. More...
 

Static Public Member Functions

static QMap< QString, QPointer< pqProxyInfo > > mergeProxies (const QMap< QString, QPointer< pqProxyInfo >> &proxies, const QMap< QString, QPointer< pqProxyInfo >> &otherProxies)
 Merge otherProxies into proxies and return a new map. More...
 

Detailed Description

Proxy meta data structure for the User Interface.

Definition at line 20 of file pqProxyInfo.h.

Constructor & Destructor Documentation

◆ pqProxyInfo() [1/4]

pqProxyInfo::pqProxyInfo ( pqProxyCategory parent,
const QString &  name,
const QString &  group,
const QString &  label,
const QString &  icon = "",
const QStringList &  omitFromToolbar = QStringList(),
bool  hideFromMenu = false 
)

◆ pqProxyInfo() [2/4]

pqProxyInfo::pqProxyInfo ( pqProxyCategory parent,
pqProxyInfo other 
)

create a pqProxyInfo with same attributes as other.

◆ pqProxyInfo() [3/4]

pqProxyInfo::pqProxyInfo ( pqProxyCategory parent,
vtkPVXMLElement xmlElement 
)

◆ pqProxyInfo() [4/4]

pqProxyInfo::pqProxyInfo ( )
default

Member Function Documentation

◆ setLabel()

void pqProxyInfo::setLabel ( const QString &  label)

Set label.

◆ setHideFromMenu()

void pqProxyInfo::setHideFromMenu ( bool  hidden)

Set HideFromMenu.

◆ setIcon()

void pqProxyInfo::setIcon ( const QString &  iconPath)

Set Icon path.

◆ merge()

void pqProxyInfo::merge ( pqProxyInfo other)

Merge pqProxyInfo meta data into self.

Append OmitFromToolbar values. For other properties, keep those from self if non empty, else copy other.

◆ mergeProxies()

static QMap<QString, QPointer<pqProxyInfo> > pqProxyInfo::mergeProxies ( const QMap< QString, QPointer< pqProxyInfo >> &  proxies,
const QMap< QString, QPointer< pqProxyInfo >> &  otherProxies 
)
static

Merge otherProxies into proxies and return a new map.

◆ convertToXML()

void pqProxyInfo::convertToXML ( vtkPVXMLElement root)

Create the xml element and add it under given root.

◆ name()

QString pqProxyInfo::name ( )
inline

Return member.

Definition at line 75 of file pqProxyInfo.h.

◆ group()

QString pqProxyInfo::group ( )
inline

Return member.

Definition at line 76 of file pqProxyInfo.h.

◆ label()

QString pqProxyInfo::label ( )

return the translated label, or create one from name if empty.

◆ icon()

QString pqProxyInfo::icon ( )
inline

Return member.

Definition at line 79 of file pqProxyInfo.h.

◆ omitFromToolbar()

QStringList pqProxyInfo::omitFromToolbar ( )
inline

Return member.

Definition at line 80 of file pqProxyInfo.h.

◆ hideFromMenu()

bool pqProxyInfo::hideFromMenu ( )

Return member.


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