pqCoreUtilities.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqCoreUtilities_h
#define pqCoreUtilities_h

#include "pqCoreModule.h"
#include "pqEventDispatcher.h"

#include <QDir>
#include <QEventLoop>
#include <QFile>
#include <QFileInfo>
#include <QMessageBox>
#include <QPointer>
#include <QString>
#include <QStringList>
#include <QWidget>

class QPalette;
class vtkObject;

class PQCORE_EXPORT pqCoreUtilitiesEventHelper : public QObject
{
  Q_OBJECT;
  typedef QObject Superclass;

public:
  pqCoreUtilitiesEventHelper(QObject* parent);
  ~pqCoreUtilitiesEventHelper() override;

Q_SIGNALS:
  void eventInvoked(vtkObject*, unsigned long, void*);

private:
  Q_DISABLE_COPY(pqCoreUtilitiesEventHelper)

  void executeEvent(vtkObject*, unsigned long, void*);
  class pqInternal;
  pqInternal* Interal;
  friend class pqCoreUtilities;
};

class PQCORE_EXPORT pqCoreUtilities : public QObject
{
  Q_OBJECT
public:
  static void setMainWidget(QWidget* widget) { pqCoreUtilities::MainWidget = widget; }
  static QWidget* mainWidget()
  {
    if (!pqCoreUtilities::MainWidget)
    {
      pqCoreUtilities::MainWidget = pqCoreUtilities::findMainWindow();
    }
    return pqCoreUtilities::MainWidget;
  }

  static void processEvents(QEventLoop::ProcessEventsFlags flags = QEventLoop::AllEvents)
  {
    pqEventDispatcher::processEvents(flags);
  }

  static QString getParaViewUserDirectory();

  static QString getParaViewApplicationDirectory();

  static QString getParaViewApplicationDataDirectory();

  static QStringList getParaViewApplicationConfigDirectories();

  static QStringList findParaviewPaths(
    const QString& directoryOrFileName, bool lookupInAppDir, bool lookupInUserDir);

  static QStringList getApplicationDirectories(bool lookupInAppDir, bool lookupInUserDir);

  static QString findInApplicationDirectories(const QString& relativePath);

  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);

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

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

  static QString number(double value, int lowExponent = -6, int highExponent = 20);

  static QString formatFullNumber(double value);


  // Format with given precision and notation and shortAccurate flag
  static QString formatDouble(double value, int notation, bool shortAccurate, int precision,
    int fullLowExponent = -6, int fullHighExponent = 20);

  // Format with RealNumberDisplayed settings
  static QString formatNumber(double value);

  // Format with AnimationTime settings
  static QString formatTime(double value);

  static QString formatMemoryFromKiBValue(double memoryInKB, int precision = 2);

  static void initializeClickMeButton(QAbstractButton* button);

  static void setPaletteHighlightToOk(QPalette& palette);

  static void setPaletteHighlightToWarning(QPalette& palette);

  static void setPaletteHighlightToCritical(QPalette& palette);

  static void removeRecursively(QDir dir);

  static void remove(const QString& filePath);

  static bool isDarkTheme();

private:
  static QWidget* findMainWindow();
  static QPointer<QWidget> MainWidget;
};

#endif