taggingactionfactory.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of Tumorprofil
 *
 * Date        : 11.09.2015
 *
 * Copyright (C) 2012 by Marcel Wiesweg <marcel dot wiesweg at uk-essen dot de>
 *
 * 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_TAGGING_ACTION_FACTORY_H
#define DIGIKAM_TAGGING_ACTION_FACTORY_H
 
// Qt includes
 
#include <QList>
 
// Local includes
 
#include "taggingaction.h"
 
namespace Digikam
{
 
class TaggingActionFactory
{
public:
 
    class ConstraintInterface
    {
    public:
 
        ConstraintInterface()           = default;
        virtual ~ConstraintInterface()  = default;
        virtual bool matches(int tagId) = 0;
 
    private:
 
        Q_DISABLE_COPY(ConstraintInterface)
    };
 
public:
 
    enum NameMatchMode
    {
        MatchStartingWithFragment,
 
        MatchContainingFragment
    };
 
public:
 
    explicit TaggingActionFactory();
    virtual ~TaggingActionFactory();
 
    void setFragment(const QString& fragment);
    QString fragment() const;
 
    void setParentTag(int parentTagId);
    int parentTagId() const;
 
    void setConstraintInterface(ConstraintInterface* const iface);
    ConstraintInterface* constraintInterface() const;
 
    void setNameMatchMode(NameMatchMode mode);
    NameMatchMode nameMatchMode() const;
 
    void reset();
 
    QList<TaggingAction> actions() const;
 
    TaggingAction defaultTaggingAction() const;
 
    int indexOfDefaultAction() const;
 
    int indexOfLastRecentAction() const;
 
    QString suggestedUIString(const TaggingAction& action) const;
 
    static TaggingAction defaultTaggingAction(const QString& tagName, int parentTagId = 0);
 
private:
 
    // Disable
    TaggingActionFactory(const TaggingActionFactory&)            = delete;
    TaggingActionFactory& operator=(const TaggingActionFactory&) = delete;
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_TAGGING_ACTION_FACTORY_H