Search for usage in LXR

Marble::MarbleDirs Class Reference

#include <MarbleDirs.h>

Static Public Member Functions

static void debug ()
static QStringList entryList (const QString &relativePath, QDir::Filters filters=QDir::NoFilter)
static QString localPath ()
static QString marbleDataPath ()
static QString marblePluginPath ()
static QStringList oldLocalPaths ()
static QString path (const QString &relativePath)
static QStringList pluginEntryList (const QString &relativePath, QDir::Filters filters=QDir::NoFilter)
static QString pluginLocalPath ()
static QString pluginPath (const QString &relativePath)
static QString pluginSystemPath ()
static void setMarbleDataPath (const QString &adaptedPath)
static void setMarblePluginPath (const QString &adaptedPath)
static QString systemPath ()

Detailed Description

A class that manages data look-up for Marble.

The class basically does for Marble what KStandardDirs did for KDE4. Given that the MarbleWidget is a Qt5-only library and given that it comes with its own model and data we need this class.

The class needs to respect the requirements of the different plattforms, so to avoid very different implementations for each plattform we specify how data should get looked up:

Generally there are two places of which Marble will draw it's data from:

"localPath" and "systemPath".

look-up of the data should happen in the localPath first. Only if the look-up in the localPath failed then MarbleDirs should look up the data in the systemPath.

localPath: The place for localPath should match space that is fully accessible to the user. On Unix-like plattforms this matches QDir::homePath() + "/.marble/data"

systemPath: Ideally the systemPath should match the place where cmake installed the data for marble. However this doesn't work for all plattforms:

  • For Linux and Mac non-bundle deployment the location can be chosen using the cmake MARBLE_DATA_PATH option at compile time.
  • For Mac bundle deployment the location inside the bundle gets chosen as the default location.
  • For Windows a path relative to the application binary can be chosen as this should usually work without problems.

To allow kiosk-like setups and for custom setups in general it should be possible to change the place of the systemPath at runtime. Therefore we introduce a global variable "MarbleDataPath" in the MarbleDirs.h source code. Initially MarbleDataPath is empty. The systemPath will point to MarbleDataPath as soon as it gets changed to a valid non-empty path. So as soon as MarbleDataPath contains a valid path the path specified by cmake will get ignored.

( Possible future extension: if the MarbleDataPath contains several valid paths separated by a colon then each of these paths should be used for look up in the same order as for the KDE kiosk framework. )

It's the duty of each application that uses the MarbleWidget to retrieve the value of the MarbleDataPath from the MarbleWidget and to save it in its settings and restore it on start-up of the application.

Definition at line 74 of file MarbleDirs.h.

Constructor & Destructor Documentation

◆ MarbleDirs()

MarbleDirs::MarbleDirs ( )

Definition at line 43 of file MarbleDirs.cpp.

Member Function Documentation

◆ debug()

void MarbleDirs::debug ( )

Definition at line 335 of file MarbleDirs.cpp.

◆ entryList()

QStringList MarbleDirs::entryList ( const QString & relativePath,
QDir::Filters filters = QDir::NoFilter )

Definition at line 77 of file MarbleDirs.cpp.

◆ localPath()

QString MarbleDirs::localPath ( )

Definition at line 236 of file MarbleDirs.cpp.

◆ marbleDataPath()

QString MarbleDirs::marbleDataPath ( )

Definition at line 302 of file MarbleDirs.cpp.

◆ marblePluginPath()

QString MarbleDirs::marblePluginPath ( )

Definition at line 307 of file MarbleDirs.cpp.

◆ oldLocalPaths()

QStringList MarbleDirs::oldLocalPaths ( )

Definition at line 249 of file MarbleDirs.cpp.

◆ path()

QString MarbleDirs::path ( const QString & relativePath)

Definition at line 49 of file MarbleDirs.cpp.

◆ pluginEntryList()

QStringList MarbleDirs::pluginEntryList ( const QString & relativePath,
QDir::Filters filters = QDir::NoFilter )

Definition at line 96 of file MarbleDirs.cpp.

◆ pluginLocalPath()

QString MarbleDirs::pluginLocalPath ( )

Definition at line 293 of file MarbleDirs.cpp.

◆ pluginPath()

QString MarbleDirs::pluginPath ( const QString & relativePath)

Definition at line 63 of file MarbleDirs.cpp.

◆ pluginSystemPath()

QString MarbleDirs::pluginSystemPath ( )

Definition at line 177 of file MarbleDirs.cpp.

◆ setMarbleDataPath()

void MarbleDirs::setMarbleDataPath ( const QString & adaptedPath)

Definition at line 312 of file MarbleDirs.cpp.

◆ setMarblePluginPath()

void MarbleDirs::setMarblePluginPath ( const QString & adaptedPath)

Definition at line 323 of file MarbleDirs.cpp.

◆ systemPath()

QString MarbleDirs::systemPath ( )

Definition at line 116 of file MarbleDirs.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 7 2024 12:03:14 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.