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

pqCoreUtilities is a collection of arbitrary utility functions that can be used by the application. More...

#include <pqCoreUtilities.h>

Static Public Member Functions

static void setMainWidget (QWidget *widget)
 When popuping up dialogs, it's generally better if we set the parent widget for those dialogs to be the QMainWindow so that the dialogs show up centered correctly in the application. More...
 
static QWidget * mainWidget ()
 
static void processEvents (QEventLoop::ProcessEventsFlags flags=QEventLoop::AllEvents)
 Call QApplication::processEvents plus make sure the testing framework is. More...
 
static QString getParaViewUserDirectory ()
 Return the path of the root ParaView user specific configuration directory. More...
 
static QString getParaViewApplicationDirectory ()
 Return the path of the launched application. More...
 
static QStringList findParaviewPaths (QString directoryOrFileName, bool lookupInAppDir, bool lookupInUserDir)
 Return the list of full available path that exists inside the shared application path and the user specific one. More...
 
static QString getNoneExistingFileName (QString expectedFilePath)
 
static unsigned long connect (vtkObject *vtk_object, int vtk_event_id, QObject *qobject, const char *signal_or_slot, Qt::ConnectionType type=Qt::AutoConnection)
 Method used to connect VTK events to Qt slots (or signals). More...
 
static bool promptUser (const QString &settingsKey, QMessageBox::Icon icon, const QString &title, const QString &message, QMessageBox::StandardButtons buttons, QWidget *parentWdg=NULL)
 This provides a mechanism to prompt the user to make a choice or to show them some information. More...
 
static QString number (double value)
 Converts a double value to a full precision QString. More...
 

Detailed Description

pqCoreUtilities is a collection of arbitrary utility functions that can be used by the application.

Definition at line 79 of file pqCoreUtilities.h.

Member Function Documentation

◆ setMainWidget()

static void pqCoreUtilities::setMainWidget ( QWidget *  widget)
inlinestatic

When popuping up dialogs, it's generally better if we set the parent widget for those dialogs to be the QMainWindow so that the dialogs show up centered correctly in the application.

For that purpose this convenience method is provided. It locates a QMainWindow and returns it.

Definition at line 88 of file pqCoreUtilities.h.

◆ mainWidget()

static QWidget* pqCoreUtilities::mainWidget ( )
inlinestatic

Definition at line 89 of file pqCoreUtilities.h.

◆ processEvents()

static void pqCoreUtilities::processEvents ( QEventLoop::ProcessEventsFlags  flags = QEventLoop::AllEvents)
inlinestatic

Call QApplication::processEvents plus make sure the testing framework is.

Definition at line 102 of file pqCoreUtilities.h.

◆ getParaViewUserDirectory()

static QString pqCoreUtilities::getParaViewUserDirectory ( )
static

Return the path of the root ParaView user specific configuration directory.

◆ getParaViewApplicationDirectory()

static QString pqCoreUtilities::getParaViewApplicationDirectory ( )
static

Return the path of the launched application.

◆ findParaviewPaths()

static QStringList pqCoreUtilities::findParaviewPaths ( QString  directoryOrFileName,
bool  lookupInAppDir,
bool  lookupInUserDir 
)
static

Return the list of full available path that exists inside the shared application path and the user specific one.

◆ getNoneExistingFileName()

static QString pqCoreUtilities::getNoneExistingFileName ( QString  expectedFilePath)
static

◆ connect()

static unsigned long pqCoreUtilities::connect ( vtkObject vtk_object,
int  vtk_event_id,
QObject *  qobject,
const char *  signal_or_slot,
Qt::ConnectionType  type = Qt::AutoConnection 
)
static

Method used to connect VTK events to Qt slots (or signals).

This is an alternative to using vtkEventQtSlotConnect. This method gives a cleaner API to connect vtk-events to Qt slots. It manages cleanup correctly i.e. either vtk-object or the qt-object can be deleted and the observers will be cleaned up correctly. One can disconnect the connection made explicitly by vtk_object->RemoveObserver(eventId) where eventId is the returned value.

◆ promptUser()

static bool pqCoreUtilities::promptUser ( const QString &  settingsKey,
QMessageBox::Icon  icon,
const QString &  title,
const QString &  message,
QMessageBox::StandardButtons  buttons,
QWidget *  parentWdg = NULL 
)
static

This provides a mechanism to prompt the user to make a choice or to show them some information.

The user can decide to make their choice persistent. Two configurations are supported:

  1. The method prompts the user with a "Yes", "No", and "Yes, and don't ask again" message box. Returns true for "Yes" and false for "No". If "Yes, and don't ask again" was clicked, the selection is remembered in pqSettings and next time this method is called with the same settingsKey it will simply return true.
  2. The method shows a message box with a "Ok" and "Ok and don't show again" If "Ok, and don't show again" was clicked, the next time this method is called with the same settingsKey it will simply return. The 'don't ask/show again' button is created by or-ing 'buttons' with QMessageBox::Save. NOTE: due to issues with test recording and playback, currently, this dialog is not prompted (instead always returning true) when DASHBOARD_TEST_FROM_CTEST environment variable is set. This may change in future.

◆ number()

static QString pqCoreUtilities::number ( double  value)
static

Converts a double value to a full precision QString.

Internally uses vtkNumberToString for lossless conversion from double to string.


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