kdualaction.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
 *
 * Copyright (c) 2010 Aurélien Gâteau <agateau@kde.org>
 *
 * This 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
 */
#ifndef KDUALACTION_H
#define KDUALACTION_H

#include <kdeui_export.h>
#include <kaction.h>

class KDualActionPrivate;

class KDEUI_EXPORT KDualAction : public KAction
{
    Q_OBJECT
public:
    explicit KDualAction(QObject *parent);

    KDualAction(const QString &inactiveText, const QString &activeText, QObject *parent);

    ~KDualAction();

    void setActiveGuiItem(const KGuiItem &);

    KGuiItem activeGuiItem() const;

    void setInactiveGuiItem(const KGuiItem &);

    KGuiItem inactiveGuiItem() const;

    void setActiveIcon(const QIcon &);

    QIcon activeIcon() const;

    void setInactiveIcon(const QIcon &);

    QIcon inactiveIcon() const;

    void setActiveText(const QString &);

    QString activeText() const;

    void setInactiveText(const QString &);

    QString inactiveText() const;

    void setActiveToolTip(const QString &);

    QString activeToolTip() const;

    void setInactiveToolTip(const QString &);

    QString inactiveToolTip() const;

    void setIconForStates(const QIcon &icon);

    bool isActive() const;

    void setAutoToggle(bool);

    bool autoToggle() const;

public Q_SLOTS:
    void setActive(bool state);

Q_SIGNALS:
    void activeChanged(bool);

    void activeChangedByUser(bool);

private:
    Q_PRIVATE_SLOT(d, void slotTriggered())
    KDualActionPrivate *const d;
    friend class KDualActionPrivate;
};

#endif /* KDUALACTION_H */