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

#include <pqCoreUtilities.h>

Inherits QObject.

Static Public Member Functions
static void	setMainWidget (QWidget *widget)
	When popping 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 QString	getParaViewApplicationDataDirectory ()
	Return the AppData directory for Paraview. More...

static QStringList	getParaViewApplicationConfigDirectories ()
	Return the list of directories that can contains ParaView configurations. More...

static QStringList	findParaviewPaths (const 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 see getApplicationDirectories() More...

static QStringList	getApplicationDirectories (bool lookupInAppDir, bool lookupInUserDir)
	Return the list of possible directories for share application path and user directory. More...

static QString	findInApplicationDirectories (const QString &relativePath)
	Returns the first app directory found that contains the given relative path. 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=nullptr)
	This provides a mechanism to prompt the user to make a choice or to show them some information. More...

static QMessageBox::Button	promptUserGeneric (const QString &title, const QString &message, QMessageBox::Icon icon, QMessageBox::StandardButtons buttons, QWidget *parentWidget)
	This show a QMessageBox to the user and returns the clicked button. More...

static QString	number (double value, int lowExponent=-6, int highExponent=20)
	Converts a double value to a full precision QString. More...

static QString	formatFullNumber (double value)
	Convert double value to string according to FullNotation settings, rely on pqCoreUtilities::number. More...

static QString	formatMemoryFromKiBValue (double memoryInKB, int precision=2)
	Convert a double KiB value to an easily readable QString For example, if this function is called with 1500.0 as an input and the default precision, the QString "1.46 MiB" will be returned. More...

static void	initializeClickMeButton (QAbstractButton *button)
	Setups up appearance for buttons such as Apply button that we want to draw user's attention to when enabled. More...

static void	setPaletteHighlightToOk (QPalette &palette)
	Set the Hightlight value of the palette to CDash green Also set HightlightedText to black. More...

static void	setPaletteHighlightToWarning (QPalette &palette)
	Set the Hightlight value of the palette to CDash yellow Also set HightlightedText to white. More...

static void	setPaletteHighlightToCritical (QPalette &palette)
	Set the Hightlight value of the palette to CDash red Also set HightlightedText to white. More...

static void	removeRecursively (QDir dir)
	Safely delete a directory recursively. More...

static void	remove (const QString &filePath)
	Safely delete a file. More...

static bool	isDarkTheme ()
	Returns true if the current application is running in dark mode. More...


static QString	formatDouble (double value, int notation, bool shortAccurate, int precision, int fullLowExponent=-6, int fullHighExponent=20)
	Convert double value to string, handling formating. More...

static QString	formatNumber (double value)
	Convert double value to string, handling formating. More...

static QString	formatTime (double value)
	Convert double value to string, handling formating. More...

Detailed Description

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

Definition at line 52 of file pqCoreUtilities.h.

Member Function Documentation

◆ setMainWidget()

static void pqCoreUtilities::setMainWidget ( QWidget * widget )

inlinestatic

When popping 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 62 of file pqCoreUtilities.h.

◆ mainWidget()

static QWidget* pqCoreUtilities::mainWidget ( )

inlinestatic

Definition at line 63 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 75 of file pqCoreUtilities.h.

◆ getParaViewUserDirectory()

static QString pqCoreUtilities::getParaViewUserDirectory ( )

static

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

In disable registry mode (–dr), return the test directory instead. If the test directory is empty, fall back to the usual user directory.

◆ getParaViewApplicationDirectory()

static QString pqCoreUtilities::getParaViewApplicationDirectory ( )

static

Return the path of the launched application.

◆ getParaViewApplicationDataDirectory()

static QString pqCoreUtilities::getParaViewApplicationDataDirectory ( )

static

Return the AppData directory for Paraview.

Relies on Qt QStandardPaths::AppLocalDataLocation to get platform specific values. The directory will created if needed.

◆ getParaViewApplicationConfigDirectories()

static QStringList pqCoreUtilities::getParaViewApplicationConfigDirectories ( )

static

Return the list of directories that can contains ParaView configurations.

First is the User Directory.

See also: getParaViewUserDirectory(), getApplicationDirectories()

◆ findParaviewPaths()

static QStringList pqCoreUtilities::findParaviewPaths	(	const 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 see getApplicationDirectories()

◆ getApplicationDirectories()

static QStringList pqCoreUtilities::getApplicationDirectories	(	bool	lookupInAppDir,
		bool	lookupInUserDir
	)

static

Return the list of possible directories for share application path and user directory.

App directories are computed from current application installation. see getParaViewApplicationDirectory(), vtkPVStandardPaths::GetInstallDirectories()

◆ findInApplicationDirectories()

static QString pqCoreUtilities::findInApplicationDirectories ( const QString & relativePath )

static

Returns the first app directory found that contains the given relative path.

Return an empty string if not found. Do not look in user space.

See also: getApplicationDirectories(true, false)

◆ 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 = `nullptr`
	)

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:

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.
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.

◆ promptUserGeneric()

static QMessageBox::Button pqCoreUtilities::promptUserGeneric	(	const QString &	title,
		const QString &	message,
		QMessageBox::Icon	icon,
		QMessageBox::StandardButtons	buttons,
		QWidget *	parentWidget
	)

static

This show a QMessageBox to the user and returns the clicked button.

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,
		int	lowExponent = `-6`,
		int	highExponent = `20`
	)

static

Converts a double value to a full precision QString.

Internally uses pqDoubleLineEdit with FullConversion, which relies on vtkNumberToString for lossless conversion from double to string. Set lowExponent and highExponent to control the range of exponents where a fixed precision should be used instead of scientific notation. Outside this range, scientific notation is preferred. Default values of -6 and 20 correspond to the ECMAScript standard.

◆ formatFullNumber()

static QString pqCoreUtilities::formatFullNumber ( double value )

static

Convert double value to string according to FullNotation settings, rely on pqCoreUtilities::number.

◆ formatDouble()

static QString pqCoreUtilities::formatDouble	(	double	value,
		int	notation,
		bool	shortAccurate,
		int	precision,
		int	fullLowExponent = `-6`,
		int	fullHighExponent = `20`
	)

static

Convert double value to string, handling formating.

◆ formatNumber()

static QString pqCoreUtilities::formatNumber ( double value )

static

Convert double value to string, handling formating.

◆ formatTime()

static QString pqCoreUtilities::formatTime ( double value )

static

Convert double value to string, handling formating.

◆ formatMemoryFromKiBValue()

static QString pqCoreUtilities::formatMemoryFromKiBValue	(	double	memoryInKB,
		int	precision = `2`
	)

static

Convert a double KiB value to an easily readable QString For example, if this function is called with 1500.0 as an input and the default precision, the QString "1.46 MiB" will be returned.

◆ initializeClickMeButton()

static void pqCoreUtilities::initializeClickMeButton ( QAbstractButton * button )

static

Setups up appearance for buttons such as Apply button that we want to draw user's attention to when enabled.

Currently, this changes the palette to use a green background when enabled.

◆ setPaletteHighlightToOk()

static void pqCoreUtilities::setPaletteHighlightToOk ( QPalette & palette )

static

Set the Hightlight value of the palette to CDash green Also set HightlightedText to black.

◆ setPaletteHighlightToWarning()

static void pqCoreUtilities::setPaletteHighlightToWarning ( QPalette & palette )

static

Set the Hightlight value of the palette to CDash yellow Also set HightlightedText to white.

◆ setPaletteHighlightToCritical()

static void pqCoreUtilities::setPaletteHighlightToCritical ( QPalette & palette )

static

Set the Hightlight value of the palette to CDash red Also set HightlightedText to white.

◆ removeRecursively()

static void pqCoreUtilities::removeRecursively ( QDir dir )

static

Safely delete a directory recursively.

This function indicates any errors with a modal popup dialog.

◆ remove()

static void pqCoreUtilities::remove ( const QString & filePath )

static

Safely delete a file.

This function indicates any errors with a modal popup dialog.

◆ isDarkTheme()

static bool pqCoreUtilities::isDarkTheme ( )

static

Returns true if the current application is running in dark mode.

This is determined based on the current application palette.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Core/pqCoreUtilities.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ setMainWidget()

◆ mainWidget()

◆ processEvents()

◆ getParaViewUserDirectory()

◆ getParaViewApplicationDirectory()

◆ getParaViewApplicationDataDirectory()

◆ getParaViewApplicationConfigDirectories()

◆ findParaviewPaths()

◆ getApplicationDirectories()

◆ findInApplicationDirectories()

◆ getNoneExistingFileName()

◆ connect()

◆ promptUser()

◆ promptUserGeneric()

◆ number()

◆ formatFullNumber()

◆ formatDouble()

◆ formatNumber()

◆ formatTime()

◆ formatMemoryFromKiBValue()

◆ initializeClickMeButton()

◆ setPaletteHighlightToOk()

◆ setPaletteHighlightToWarning()

◆ setPaletteHighlightToCritical()

◆ removeRecursively()

◆ remove()

◆ isDarkTheme()