tdeactionselector.h

/* 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 _TDEACTION_SELECTOR_H_
#define _TDEACTION_SELECTOR_H_
 
#include <tqwidget.h>
 
#include <tdelibs_export.h>
 
class TQListBox;
class TQListBoxItem;
class TQKeyEvent;
class TQEvent;
class TQIconSet;
 
class TDEActionSelectorPrivate;

 
class TDEUI_EXPORT TDEActionSelector : public TQWidget {
  TQ_OBJECT
  TQ_ENUMS( ButtonIconSize InsertionPolicy )
  TQ_PROPERTY( bool moveOnDoubleClick READ moveOnDoubleClick WRITE setMoveOnDoubleClick )
  TQ_PROPERTY( bool keyboardEnabled READ keyboardEnabled WRITE setKeyboardEnabled )
  TQ_PROPERTY( TQString availableLabel READ availableLabel WRITE setAvailableLabel )
  TQ_PROPERTY( TQString selectedLabel READ selectedLabel WRITE setSelectedLabel )
  TQ_PROPERTY( ButtonIconSize buttonIconSize READ buttonIconSize WRITE setButtonIconSize )
  TQ_PROPERTY( InsertionPolicy availableInsertionPolicy READ availableInsertionPolicy WRITE setAvailableInsertionPolicy )
  TQ_PROPERTY( InsertionPolicy selectedInsertionPolicy READ selectedInsertionPolicy WRITE setSelectedInsertionPolicy )
  TQ_PROPERTY( bool showUpDownButtons READ showUpDownButtons WRITE setShowUpDownButtons )
 
public:
  TDEActionSelector( TQWidget *parent=0, const char *name=0 );
  ~TDEActionSelector();

  TQListBox *availableListBox() const;

  TQListBox *selectedListBox() const;

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

  enum ButtonIconSize {
    SmallIcon,
    Small,
    Medium,
    Large,
    XLarge
  };

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

  bool moveOnDoubleClick() const;

  void setMoveOnDoubleClick( bool enable );

  bool keyboardEnabled() const;

  void setKeyboardEnabled( bool enable );

  TQString availableLabel() const;

  void setAvailableLabel( const TQString & text );

  TQString selectedLabel() const;

  void setSelectedLabel( const TQString & text );

  ButtonIconSize buttonIconSize() const;

  void setButtonIconSize( ButtonIconSize size );

  InsertionPolicy availableInsertionPolicy() const;

  void setAvailableInsertionPolicy( InsertionPolicy policy );

  InsertionPolicy selectedInsertionPolicy() const;

  void setSelectedInsertionPolicy( InsertionPolicy policy );

  bool showUpDownButtons() const;

  void setShowUpDownButtons( bool show );

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

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

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

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

  void setButtonsEnabled();
 
signals:
  void added( TQListBoxItem *item );

  void removed( TQListBoxItem *item );

  void movedUp( TQListBoxItem *item );

  void movedDown( TQListBoxItem *item );

//  void addedToSelection( TQListBoxItem *item );
 
public slots:
  void polish();
 
protected:
  void keyPressEvent( TQKeyEvent * );

  bool eventFilter( TQObject *, TQEvent * );
 
private slots:
  void buttonAddClicked();

  void buttonRemoveClicked();

  void buttonUpClicked();

  void buttonDownClicked();

  void  itemDoubleClicked( TQListBoxItem *item );

  void slotCurrentChanged( TQListBoxItem * ) { setButtonsEnabled(); }
 
private:

  void moveItem( TQListBoxItem *item );

  void loadIcons();

  int insertionIndex( TQListBox *lb, InsertionPolicy policy );

  TDEActionSelectorPrivate *d;
};
 
#endif // _TDEACTION_SELECTOR_H_