ActionListModel.h

Go to the documentation of this file.

/*
 *   Copyright (C) 2007, 2008, 2009, 2010 Ivan Cukic <ivan.cukic(at)kde.org>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser/Library General Public License version 2,
 *   or (at your option) any later version, as published by the Free
 *   Software Foundation
 *
 *   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 Lesser/Library General Public License for more details
 *
 *   You should have received a copy of the GNU Lesser/Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef LANCELOT_ACTION_LIST_MODEL_H
#define LANCELOT_ACTION_LIST_MODEL_H

#include <QtCore/QMimeData>
#include <QtCore/QString>
#include <QtGui/QIcon>
#include <QtGui/QAction>

#include <lancelot/lancelot_export.h>
#include <lancelot/widgets/PopupMenu.h>

namespace Lancelot
{

class LANCELOT_EXPORT ActionListModel: public QObject {
    Q_OBJECT
public:
    ActionListModel();

    virtual ~ActionListModel();

    virtual QString title(int index) const = 0;

    virtual QString description(int index) const;

    virtual QIcon icon(int index) const;

    virtual QMimeData * mimeData(int index) const;

    virtual void dataDragFinished(int index, Qt::DropAction action);

    virtual bool dataDropAvailable(int where, const QMimeData * mimeData);

    virtual void dataDropped(int where, const QMimeData * mimeData);

    virtual void setDropActions(int index, Qt::DropActions & actions, Qt::DropAction & defaultAction);

    virtual bool isCategory(int index) const;

    virtual int size() const = 0;

    virtual bool hasContextActions(int index) const;

    virtual void setContextActions(int index, Lancelot::PopupMenu * menu);

    virtual void contextActivate(int index, QAction * context);

    virtual QString selfTitle() const;
    virtual QString selfShortTitle() const;
    virtual QIcon selfIcon() const;
    virtual QMimeData * selfMimeData() const;

public Q_SLOTS:
    void activated(int index);

Q_SIGNALS:
    void itemActivated(int index);

    void updated();

    void itemInserted(int index);

    void itemDeleted(int index);

    void itemAltered(int index);

protected:
    virtual void activate(int index);
};

} // namespace Lancelot

#endif /* LANCELOT_ACTION_LIST_MODEL_H */