TulipSettings.h

/*
 *
 * This file is part of Tulip (www.tulip-software.org)
 *
 * Authors: David Auber and the Tulip development Team
 * from LaBRI, University of Bordeaux 1 and Inria Bordeaux - Sud Ouest
 *
 * Tulip is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tulip 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.
 *
 */
///@cond DOXYGEN_HIDDEN


#ifndef TULIPSETTINGS_H
#define TULIPSETTINGS_H

#include <QtCore/QSettings>
#include <QtCore/QStringList>
#include <tulip/tulipconf.h>
#include <tulip/Graph.h>
#include <tulip/Color.h>
#include <tulip/Size.h>
#include <QtNetwork/QNetworkProxy>

/**
  * @brief This class provides convenience functions to access the Tulip settings file (using QSettings)
  * TulipSettings is a wrapper for QSettings providing quick access to common keys provided in the tulip configuration file.
  * This object does not mask any method from the QSettings class, which mean that the user can still access custom keys by invoking the QSettings::value method.
  */
class TLP_QT_SCOPE TulipSettings: public QSettings {
  Q_OBJECT
  Q_ENUMS(DisplayProperty)

public:

  static const QString RemoteLocationsConfigEntry;
  static const QString RecentDocumentsConfigEntry;
  static const QString PluginsToRemoveConfigEntry;
  static const QString DefaultColorConfigEntry;
  static const QString DefaultSizeConfigEntry;
  static const QString DefaultShapeConfigEntry;
  static const QString DefaultSelectionColorEntry;
  static const QString FavoriteAlgorithmsEntry;
  static const QString FirstRunEntry;

  static const QString ProxyEnabledEntry;
  static const QString ProxyTypeEntry;
  static const QString ProxyHostEntry;
  static const QString ProxyPortEntry;
  static const QString ProxyUseAuthEntry;
  static const QString ProxyUsernameEntry;
  static const QString ProxyPasswordEntry;

  static const QString AutomaticPerfectAspectRatioEntry;
  static const QString AutomaticMapMetricEntry;

  static TulipSettings &instance();

  static QString elementKey(const QString& configEntry, tlp::ElementType elem);

  /**
    @brief Retrieves the list of documents recently opened with tulip.
    */
  QStringList recentDocuments() const;

  /**
    @brief Registers a file in the list of recently opened documents.
    If the list already contains 5 elements, the last one (in chronological order) will be removed.
    */
  void addToRecentDocuments(const QString &);

  /**
    @brief Check recently opened documents list and remove non-existing ones
    */
  void checkRecentDocuments();

  /**
   * @brief Adds a remote location from which to list plugins.
   *
   * @param remoteLocation The URL of the plugin server.
   * @return void
   **/
  void addRemoteLocation(const QString& remoteLocation);

  /**
   * @brief Removes a location from which to list plugins.
   *
   * @param remoteLocation The URL of the plugin server.
   * @return void
   **/
  void removeRemoteLocation(const QString& remoteLocation);

  /**
   * @brief Retrieves the list of locations from which to list plugins.
   *
   * @return const QStringList
   **/
  const QStringList remoteLocations() const;
  const QStringList pluginsToRemove() const;

  void markPluginForRemoval(const QString& pluginLibrary);
  void unmarkPluginForRemoval(const QString& pluginLibrary);

  tlp::Color defaultColor(tlp::ElementType elem);
  void setDefaultColor(tlp::ElementType elem, const tlp::Color& color);

  tlp::Size defaultSize(tlp::ElementType elem);
  void setDefaultSize(tlp::ElementType elem, const tlp::Size& size);

  int defaultShape(tlp::ElementType elem);
  void setDefaultShape(tlp::ElementType elem, int shape);

  tlp::Color defaultSelectionColor();
  void setDefaultSelectionColor(const tlp::Color& color);

  QSet<QString> favoriteAlgorithms() const;
  void addFavoriteAlgorithm(const QString&name);
  void removeFavoriteAlgorithm(const QString&name);

  // Proxy settings
  bool isProxyEnabled() const;
  void setProxyEnabled(bool);

  QNetworkProxy::ProxyType proxyType() const;
  void setProxyType(QNetworkProxy::ProxyType);

  QString proxyHost() const;
  void setProxyHost(const QString&);

  unsigned int proxyPort() const;
  void setProxyPort(unsigned int);

  bool isUseProxyAuthentification() const;
  void setUseProxyAuthentification(bool);

  QString proxyUsername() const;
  void setProxyUsername(const QString&);

  QString proxyPassword() const;
  void setProxyPassword(const QString&);

  void applyProxySettings();

  bool isFirstRun() const;
  void setFirstRun(bool);

  bool isAutomaticMapMetric() const;
  void setAutomaticMapMetric(bool);

  bool isAutomaticRatio() const;
  void setAutomaticRatio(bool);

private:
  TulipSettings();
  static TulipSettings *_instance;

  void setFavoriteAlgorithms(const QSet<QString> &lst);
};

#endif // TULIPSETTINGS_H
///@endcond