You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
128 lines
3.6 KiB
128 lines
3.6 KiB
/* BEGIN_COMMON_COPYRIGHT_HEADER
|
|
* (c)LGPL2+
|
|
*
|
|
* Razor - a lightweight, Qt based, desktop toolset
|
|
* http://razor-qt.org
|
|
*
|
|
* Copyright: 2010-2011 Razor team
|
|
* Authors:
|
|
* Alexander Sokoloff <sokoloff.a@gmail.com>
|
|
*
|
|
* This program or library 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 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU Lesser General
|
|
* Public License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301 USA
|
|
*
|
|
* END_COMMON_COPYRIGHT_HEADER */
|
|
|
|
#ifndef QTXDG_XDGMENU_H
|
|
#define QTXDG_XDGMENU_H
|
|
|
|
#include "xdgmacros.h"
|
|
#include <QObject>
|
|
#include <QString>
|
|
#include <QStringList>
|
|
#include <QtXml/QDomDocument>
|
|
|
|
class QDomDocument;
|
|
class QDomElement;
|
|
class XdgMenuPrivate;
|
|
|
|
|
|
/*! @brief The XdgMenu class implements the "Desktop Menu Specification" from freedesktop.org.
|
|
|
|
Freedesktop menu is a user-visible hierarchy of applications, typically displayed as a menu.
|
|
|
|
Example usage:
|
|
@code
|
|
QString menuFile = XdgMenu::getMenuFileName();
|
|
XdgMenu xdgMenu();
|
|
|
|
bool res = xdgMenu.read(menuFile);
|
|
if (!res)
|
|
{
|
|
QMessageBox::warning(this, "Parse error", xdgMenu.errorString());
|
|
}
|
|
|
|
QDomElement rootElement = xdgMenu.xml().documentElement()
|
|
@endcode
|
|
|
|
@sa http://specifications.freedesktop.org/menu-spec/menu-spec-latest.html
|
|
*/
|
|
|
|
class QTXDG_API XdgMenu : public QObject
|
|
{
|
|
Q_OBJECT
|
|
friend class XdgMenuReader;
|
|
friend class XdgMenuApplinkProcessor;
|
|
|
|
public:
|
|
explicit XdgMenu(QObject *parent = 0);
|
|
virtual ~XdgMenu();
|
|
|
|
bool read(const QString& menuFileName);
|
|
void save(const QString& fileName);
|
|
|
|
const QDomDocument xml() const;
|
|
QString menuFileName() const;
|
|
|
|
QDomElement findMenu(QDomElement& baseElement, const QString& path, bool createNonExisting);
|
|
|
|
/*! Returns a list of strings identifying the environments that should
|
|
* display a desktop entry. Internally all comparisions involving the
|
|
* desktop enviroment names are made case insensitive.
|
|
*/
|
|
QStringList environments();
|
|
|
|
/*!
|
|
* Set currently running environments. Example: RAZOR, KDE, or GNOME...
|
|
* Internally all comparisions involving the desktop enviroment names
|
|
* are made case insensitive.
|
|
*/
|
|
void setEnvironments(const QStringList &envs);
|
|
void setEnvironments(const QString &env);
|
|
|
|
/*!
|
|
* Returns a string description of the last error that occurred if read() returns false.
|
|
*/
|
|
const QString errorString() const;
|
|
|
|
/*!
|
|
* @brief The name of the directory for the debug XML-files.
|
|
*/
|
|
const QString logDir() const;
|
|
|
|
/*!
|
|
* @brief The name of the directory for the debug XML-files. If a directory is specified,
|
|
* then after you run the XdgMenu::read, you can see and check the results of the each step.
|
|
*/
|
|
void setLogDir(const QString& directory);
|
|
|
|
static QString getMenuFileName(const QString& baseName = QLatin1String("applications.menu"));
|
|
|
|
bool isOutDated() const;
|
|
|
|
signals:
|
|
void changed();
|
|
|
|
protected:
|
|
void addWatchPath(const QString& path);
|
|
|
|
private:
|
|
XdgMenuPrivate* const d_ptr;
|
|
Q_DECLARE_PRIVATE(XdgMenu)
|
|
};
|
|
|
|
|
|
#endif // QTXDG_XDGMENU_H
|