omgui.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2006 by Tim Sutton   *
 *   tim@linfiniti.com   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef OMGUI_H
#define OMGUI_H
#include "omgmodellerplugininterface.h"
#include "omgscraperplugininterface.h"
class QString;
class QColor;
class QDomDocument;
class QDomElement;
class OmgLocality;
class OmgLayerSet;
#include <QHash>
#include <QPair>
#include <QImage>
class OMG_LIB_EXPORT Omgui 
{
  public: 
    static const QString userSettingsDirPath();
    static const QString userAlgorithmProfilesDirPath();
    
    static const QString fileSelectorCachePath();
    static const QString userLayersetDirPath();
    static const QString pluginDirPath();


    static const QString getModelOutputDir();

    typedef QMap<QString,OmgLayerSet> LayerSetMap;
    static Omgui::LayerSetMap getAvailableLayerSets();

    static QStringList sortList(QStringList theList);

    static QStringList uniqueList(QStringList theList);

    static QString getLayers(QString theBaseDir);

    static QStringList getExperimentsList();

    static QHash<QString,QString> getOutputFormats();
    static QHash<QString,QPair<double,double> > getOutputFormatRanges();
    
    static QHash<QString,float> getOutputFormatNoData();

    static QHash<QString,QString> getOutputFormatNotes();
    
    static QString getOutputFormatExtension();

    static bool createTextFile(QString theFileName, QString theData);

    static QString readTextFile(QString theFileName);

    static QString xmlEncodeAmpersands(QString theString);
    static QString xmlEncode(QString theString);

    static void xmlEncodeInPlace(QString &theString);

    static QString xmlDecode(QString theString);

    static void xmlDecodeInPlace(QString &theString);

    static QColor randomColour();
    static QString defaultStyleSheet();
    static QString getHtmlHeader();
    static QString getHtmlFooter();
    static bool deleteShapeFile(QString theFileBase);
    static bool localitiesToShapefile(QString theShapefileName,OmgLocalities const &theLocalities); 
    static QString i18nPath();
    static QStringList i18nList();

     enum TimeForm {longTimeForm,shortTimeForm} ;

    static QString version();

    static void createThumbnail(QString theTopLabel,
                           QString theBottomLabel,
                           QString theSourceImageFileName,
                           QString theOutputFileName);

    template <class T> 
      static QString secondsToString(T theSeconds, Omgui::TimeForm theForm=Omgui::shortTimeForm)
    {
      QString myString;
      //division and modulus must be done with the same type as the template class 
      //otherwise a warning is generated
      int mySecsPerHour = 3600;
      int mySecsPerMinute = 60;
      int myHours = static_cast<int> (theSeconds / mySecsPerHour);
      int myRemainder = static_cast<int> (theSeconds % mySecsPerHour);
      int myMinutes = static_cast<int> (myRemainder / mySecsPerMinute);
      int mySeconds = static_cast<int> (myRemainder % mySecsPerMinute);
      if (theForm == Omgui::shortTimeForm)
      { //short form
        if (myHours > 0)
        {
          myString += QString::number(myHours) + " " + QObject::tr("h") + " ";
        }
        if (myMinutes > 0)
        {
          myString += QString::number(myMinutes) + " " + QObject::tr("m") + " ";
        }
        if (mySeconds > 0)
        {
          myString += QString::number(mySeconds) + " " + QObject::tr("s") + " ";
        }
      }
      else
      { //long form
        if (myHours > 0)
        {
          myString += QString::number(myHours) + " " + QObject::tr("Hours") + " ";
        }
        if (myMinutes > 0)
        {
          myString += QString::number(myMinutes) + " " + QObject::tr("Minutes") + " ";
        }
        if (mySeconds > 0)
        {
          myString += QString::number(mySeconds) + " " + QObject::tr("Seconds") + " ";
        }

      }
      return myString;
    }

  private:
    static void traverseDirectories(const QString theDirName, QDomDocument &theDocument, QDomElement &theParentElement);

};
  

#endif

---