Add Quassel::scriptDirPaths() to get a list of locations we look for scripts in

[quassel.git] / src / common / quassel.h

diff --git a/src/common/quassel.h b/src/common/quassel.h
index cb29f3f..53d9e0b 100644 (file)
--- a/src/common/quassel.h
+++ b/src/common/quassel.h
@@ -22,6 +22,7 @@
 #define QUASSEL_H_
 
 #include <QCoreApplication>
+#include <QLocale>
 #include <QString>
 
 #include "abstractcliparser.h"
@@ -64,9 +65,33 @@ public:
   static inline RunMode runMode();
 
   static QString configDirPath();
+
+  //! Returns a list of data directory paths
+  /** There are several locations for applications to install their data files in. On Unix,
+  *  a common location is /usr/share; others include $PREFIX/share and additional directories
+  *  specified in the env variable XDG_DATA_DIRS.
+  *  \return A list of directory paths to look for data files in
+  */
   static QStringList dataDirPaths();
+
+  //! Searches for a data file in the possible data directories
+  /** Data files can reside in $DATA_DIR/apps/quassel, where $DATA_DIR is one of the directories
+  *  returned by \sa dataDirPaths().
+  *  \Note With KDE integration enabled, files are searched (only) in KDE's appdata dirs.
+  *  \return The full path to the data file if found; a null QString else
+  */
   static QString findDataFilePath(const QString &filename);
 
+  static QString translationDirPath();
+
+  //! Returns a list of directories we look for scripts in
+  /** We look for a subdirectory named "scripts" in the configdir and in all datadir paths.
+  *   \return A list of directory paths containing executable scripts for /exec
+  */
+  static QStringList scriptDirPaths();
+
+  static void loadTranslation(const QLocale &locale);
+
   static inline void setCliParser(AbstractCliParser *cliParser);
   static inline AbstractCliParser *cliParser();
   static inline QString optionValue(const QString &option);
@@ -100,6 +125,7 @@ private:
   static QString _coreDumpFileName;
   static QString _configDirPath;
   static QStringList _dataDirPaths;
+  static QString _translationDirPath;
 };
 
 const Quassel::BuildInfo & Quassel::buildInfo() { return _buildInfo; }