kactionselector.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2002 Anders Lund <anders.lund@lund.tdcadsl.dk>

   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 _KACTION_SELECTOR_H_
#define _KACTION_SELECTOR_H_

#include <kdeui_export.h>
#include <QtGui/QWidget>

class QListWidget;
class QListWidgetItem;
class QKeyEvent;
class QEvent;
class QIcon;

class KActionSelectorPrivate;

class KDEUI_EXPORT KActionSelector : public QWidget {
  Q_OBJECT
  Q_ENUMS( InsertionPolicy MoveButton )
  Q_PROPERTY( bool moveOnDoubleClick READ moveOnDoubleClick WRITE setMoveOnDoubleClick )
  Q_PROPERTY( bool keyboardEnabled READ keyboardEnabled WRITE setKeyboardEnabled )
  Q_PROPERTY( QString availableLabel READ availableLabel WRITE setAvailableLabel )
  Q_PROPERTY( QString selectedLabel READ selectedLabel WRITE setSelectedLabel )
  Q_PROPERTY( InsertionPolicy availableInsertionPolicy READ availableInsertionPolicy WRITE setAvailableInsertionPolicy )
  Q_PROPERTY( InsertionPolicy selectedInsertionPolicy READ selectedInsertionPolicy WRITE setSelectedInsertionPolicy )
  Q_PROPERTY( bool showUpDownButtons READ showUpDownButtons WRITE setShowUpDownButtons )

public:
  explicit KActionSelector( QWidget *parent=0 );
  ~KActionSelector();

  QListWidget *availableListWidget() const;

  QListWidget *selectedListWidget() const;

  enum MoveButton {
    ButtonAdd,
    ButtonRemove,
    ButtonUp,
    ButtonDown
  };

  enum InsertionPolicy {
    BelowCurrent,
    Sorted,
    AtTop,
    AtBottom
  };

  bool moveOnDoubleClick() const;

  void setMoveOnDoubleClick( bool enable );

  bool keyboardEnabled() const;

  void setKeyboardEnabled( bool enable );

  QString availableLabel() const;

  void setAvailableLabel( const QString & text );

  QString selectedLabel() const;

  void setSelectedLabel( const QString & text );

  InsertionPolicy availableInsertionPolicy() const;

  void setAvailableInsertionPolicy( InsertionPolicy policy );

  InsertionPolicy selectedInsertionPolicy() const;

  void setSelectedInsertionPolicy( InsertionPolicy policy );

  bool showUpDownButtons() const;

  void setShowUpDownButtons( bool show );

  void setButtonIcon( const QString &icon, MoveButton button );

  void setButtonIconSet( const QIcon &iconset, MoveButton button );

  void setButtonTooltip( const QString &tip, MoveButton button );

  void setButtonWhatsThis( const QString &text, MoveButton button );

  void setButtonsEnabled();

Q_SIGNALS:
  void added( QListWidgetItem *item );

  void removed( QListWidgetItem *item );

  void movedUp( QListWidgetItem *item );

  void movedDown( QListWidgetItem *item );

//  void addedToSelection( QListWidgetItem *item );

public Q_SLOTS:
  void polish();

protected:
  void keyPressEvent( QKeyEvent * );

  bool eventFilter( QObject *, QEvent * );

private:
  Q_PRIVATE_SLOT(d, void buttonAddClicked())

  
  Q_PRIVATE_SLOT(d, void buttonRemoveClicked())

  Q_PRIVATE_SLOT(d, void buttonUpClicked())

  Q_PRIVATE_SLOT(d, void buttonDownClicked())

  Q_PRIVATE_SLOT(d, void itemDoubleClicked( QListWidgetItem *item ))

  Q_PRIVATE_SLOT(d, void slotCurrentChanged( QListWidgetItem * ))

private:

  friend class KActionSelectorPrivate;
  KActionSelectorPrivate * const d;
  
  Q_DISABLE_COPY(KActionSelector)
};

#endif // _KACTION_SELECTOR_H_