Classes | Public Member Functions | Static Public Member Functions | List of all members
pqExpressionsManager Class Reference

#include <pqExpressionsManager.h>

Classes

struct  pqExpression
 Data structure to handle an expression and its group name. More...
 

Public Member Functions

 pqExpressionsManager ()=default
 
 ~pqExpressionsManager ()=default
 

Static Public Member Functions

static QList< pqExpressiongetExpressionsFromSettings ()
 Read and parse settings to return the list of available expressions. More...
 
static QList< pqExpressiongetExpressionsFromSettings (const QString &group)
 
static bool addExpressionToSettings (const QString &group, const QString &value)
 Add the expression under the given group and store it in the settings. More...
 
static void storeToSettings (const QList< pqExpression > &expressions)
 Store the given list to the settings. More...
 
static constexpr const char * SETTINGS_GROUP ()
 Name of QSettings group containing the expressions. More...
 
static constexpr const char * SETTINGS_KEY ()
 Name of QSettings key containing the expression concatenated in one string. More...
 
static constexpr const char * EXPRESSION_GROUP ()
 Group for classic expressions, like Calculator. More...
 
static constexpr const char * PYTHON_EXPRESSION_GROUP ()
 Group for python expressions, like Python Calculator. More...
 

Detailed Description

Definition at line 14 of file pqExpressionsManager.h.

Constructor & Destructor Documentation

◆ pqExpressionsManager()

pqExpressionsManager::pqExpressionsManager ( )
default

◆ ~pqExpressionsManager()

pqExpressionsManager::~pqExpressionsManager ( )
default

Member Function Documentation

◆ getExpressionsFromSettings() [1/2]

static QList<pqExpression> pqExpressionsManager::getExpressionsFromSettings ( )
static

Read and parse settings to return the list of available expressions.

◆ getExpressionsFromSettings() [2/2]

static QList<pqExpression> pqExpressionsManager::getExpressionsFromSettings ( const QString &  group)
static

◆ addExpressionToSettings()

static bool pqExpressionsManager::addExpressionToSettings ( const QString &  group,
const QString &  value 
)
static

Add the expression under the given group and store it in the settings.

Preserve existent expressions. Return true if the expression was correctly added. Return false if an error occured or if expression was already present.

◆ storeToSettings()

static void pqExpressionsManager::storeToSettings ( const QList< pqExpression > &  expressions)
static

Store the given list to the settings.

Replace previous settings.

◆ SETTINGS_GROUP()

static constexpr const char* pqExpressionsManager::SETTINGS_GROUP ( )
inlinestatic

Name of QSettings group containing the expressions.

Definition at line 104 of file pqExpressionsManager.h.

◆ SETTINGS_KEY()

static constexpr const char* pqExpressionsManager::SETTINGS_KEY ( )
inlinestatic

Name of QSettings key containing the expression concatenated in one string.

Definition at line 108 of file pqExpressionsManager.h.

◆ EXPRESSION_GROUP()

static constexpr const char* pqExpressionsManager::EXPRESSION_GROUP ( )
inlinestatic

Group for classic expressions, like Calculator.

Definition at line 112 of file pqExpressionsManager.h.

◆ PYTHON_EXPRESSION_GROUP()

static constexpr const char* pqExpressionsManager::PYTHON_EXPRESSION_GROUP ( )
inlinestatic

Group for python expressions, like Python Calculator.

Definition at line 116 of file pqExpressionsManager.h.


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