pqCoreUtilities.h

Go to the documentation of this file.

/*=========================================================================

   Program: ParaView
   Module:    pqCoreUtilities.h

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.2.

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

========================================================================*/
#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 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:
  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 QStringList findParaviewPaths(
    QString directoryOrFileName, bool lookupInAppDir, bool lookupInUserDir);
  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 = NULL);

  static QString number(double value);

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

#endif