kselectaction.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1999 Reginald Stadlbauer <reggie@kde.org>
              (C) 1999 Simon Hausmann <hausmann@kde.org>
              (C) 2000 Nicolas Hadacek <haadcek@kde.org>
              (C) 2000 Kurt Granroth <granroth@kde.org>
              (C) 2000 Michael Koch <koch@kde.org>
              (C) 2001 Holger Freyther <freyther@kde.org>
              (C) 2002 Ellis Whitehead <ellis@kde.org>
              (C) 2003 Andras Mantia <amantia@kde.org>
              (C) 2005-2006 Hamish Rodda <rodda@kde.org>
              (C) 2006 Albert Astals Cid <aacid@kde.org>
              (C) 2006 Clarence Dang <dang@kde.org>
              (C) 2006 Michel Hermier <michel.hermier@gmail.com>
              (C) 2007 Nick Shaforostoff <shafff@ukr.net>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.

    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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KSELECTACTION_H
#define KSELECTACTION_H

#include <QtGui/QToolButton>

#include <kaction.h>

class KSelectActionPrivate;

class KDEUI_EXPORT KSelectAction : public KAction
{
    Q_OBJECT
    Q_PROPERTY( QAction* currentAction READ currentAction WRITE setCurrentAction )
    Q_PROPERTY( bool editable READ isEditable WRITE setEditable )
    Q_PROPERTY( int comboWidth READ comboWidth WRITE setComboWidth )
    Q_PROPERTY( QString currentText READ currentText )
    Q_ENUMS( ToolbarMode )
    Q_PROPERTY( ToolBarMode toolBarMode READ toolBarMode WRITE setToolBarMode )
    Q_PROPERTY( QToolButton::ToolButtonPopupMode toolButtonPopupMode READ toolButtonPopupMode WRITE setToolButtonPopupMode )
    Q_PROPERTY( int currentItem READ currentItem WRITE setCurrentItem )
    Q_PROPERTY( QStringList items READ items WRITE setItems )
    Q_DECLARE_PRIVATE(KSelectAction)


public:
    explicit KSelectAction(QObject *parent);

    KSelectAction(const QString& text, QObject *parent);

    KSelectAction(const KIcon& icon, const QString& text, QObject *parent);

    virtual ~KSelectAction();

    enum ToolBarMode {
      MenuMode,
      ComboBoxMode
    };

    ToolBarMode toolBarMode() const;

    void setToolBarMode(ToolBarMode mode);

    QToolButton::ToolButtonPopupMode toolButtonPopupMode() const;

    void setToolButtonPopupMode(QToolButton::ToolButtonPopupMode mode);

    QActionGroup* selectableActionGroup() const;

    QAction* currentAction() const;

    int currentItem() const;

    QString currentText() const;

    QList<QAction*> actions() const;

    QAction* action(int index) const;

    QAction* action(const QString& text, Qt::CaseSensitivity cs = Qt::CaseSensitive) const;

    bool setCurrentAction(QAction* action);

    bool setCurrentItem(int index);

    bool setCurrentAction(const QString& text, Qt::CaseSensitivity cs = Qt::CaseSensitive);

    virtual void addAction(QAction* action);

    KAction* addAction(const QString& text);

    KAction* addAction(const KIcon& icon, const QString& text);

    virtual QAction* removeAction(QAction* action);

    void setItems( const QStringList &lst );

    QStringList items() const;

    bool isEditable() const;

    void setEditable( bool );

    int comboWidth() const;

    void setComboWidth( int width );

    void setMaxComboViewCount( int n );

    void clear();

    void removeAllActions();

    void setMenuAccelsEnabled( bool b );

    bool menuAccelsEnabled() const;

    void changeItem( int index, const QString& text );

Q_SIGNALS:
    void triggered( QAction* action );

    void triggered( int index );

    void triggered( const QString& text );

protected Q_SLOTS:
    virtual void actionTriggered(QAction* action);

    void slotToggled(bool);

protected:
    virtual QWidget *createWidget(QWidget *parent);

    virtual void deleteWidget(QWidget *widget);

    virtual bool event(QEvent *event);

    virtual bool eventFilter (QObject *watched, QEvent *event);

    KSelectAction(KSelectActionPrivate &dd, QObject *parent);

    KSelectActionPrivate *d_ptr;

private:
    Q_PRIVATE_SLOT( d_func(), void _k_comboBoxDeleted(QObject*) )
    Q_PRIVATE_SLOT( d_func(), void _k_comboBoxCurrentIndexChanged(int) )
};

#endif