rule.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-05-01
 * Description : an abstract rule class
 *
 * Copyright (C) 2009-2012 by Andi Clemens <andi dot clemens at gmail dot 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, 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_RULE_H
#define DIGIKAM_RULE_H
 
// Local includes
 
#include "parseresults.h"
#include "parsesettings.h"
#include "token.h"
 
class QAction;
class QMenu;
class QPushButton;
class QString;
 
namespace Digikam
{
 
class Rule : public QObject
{
    Q_OBJECT
 
public:
 
    enum IconType
    {
        Action = 0,
        Dialog
    };
 
public:
 
    explicit Rule(const QString& name);
    Rule(const QString& name, const QString& icon);
    ~Rule() override;
 
    QRegularExpression& regExp() const;
 
    QString description() const;
    QPixmap icon(Rule::IconType type = Rule::Action) const;
 
    TokenList& tokens() const;
 
    QPushButton* registerButton(QWidget* parent);
 
    QAction* registerMenu(QMenu* parent);
 
    bool useTokenMenu() const;
 
    bool isValid() const;
 
    virtual void reset();
 
    static QString escapeToken(const QString& token);
 
    ParseResults parse(ParseSettings& settings);
 
Q_SIGNALS:
 
    void signalTokenTriggered(const QString&);
 
protected:
 
    virtual QString parseOperation(ParseSettings& settings, const QRegularExpressionMatch &match) = 0;
 
    bool addToken(const QString& id, const QString& description, const QString& actionName = QString());
 
    void setRegExp(const QRegularExpression& regExp);
    void setDescription(const QString& desc);
    void setIcon(const QString& pixmap);
 
    void setUseTokenMenu(bool value);
 
protected Q_SLOTS:
 
    virtual void slotTokenTriggered(const QString&);
 
private:
 
    QPushButton* createButton(const QString& name, const QIcon& icon);
 
private:
 
    // Disable
    Rule(QObject*)               = delete;
    Rule(const Rule&)            = delete;
    Rule& operator=(const Rule&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
typedef QList<Rule*> RulesList;
 
} // namespace Digikam
 
#endif // DIGIKAM_RULE_H