keditlistbox.h

/* This file is part of the KDE libraries
    Copyright (C) 2000 David Faure <faure@kde.org>, Alexander Neundorf <neundorf@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 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
    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 KEDITLISTBOX_H
#define KEDITLISTBOX_H
 
#include <tqgroupbox.h>
#include <tqlistbox.h>
 
#include <tdelibs_export.h>
 
class KLineEdit;
class KComboBox;
class TQPushButton;
 
class KEditListBoxPrivate;
class TDEUI_EXPORT KEditListBox : public TQGroupBox
{
   TQ_OBJECT
   
 
   TQ_SETS( Button )
   TQ_PROPERTY( Button buttons READ buttonsProp WRITE setButtonsProp )
   TQ_PROPERTY( TQStringList items READ items WRITE setItems )
 
public:
   class CustomEditor;
 
   public:
 
      enum Button { Add = 1, Remove = 2, UpDown = 4 };
      enum { All = Add|Remove|UpDown }; // separated so that it doesn't appear in Qt designer
 
      KEditListBox(TQWidget *parent = 0, const char *name = 0,
           bool checkAtEntering=false, int buttons = All );
      KEditListBox(const TQString& title, TQWidget *parent = 0,
           const char *name = 0, bool checkAtEntering=false,
           int buttons = All );
 
      KEditListBox( const TQString& title,
                    const CustomEditor &customEditor,
                    TQWidget *parent = 0, const char *name = 0,
                    bool checkAtEntering = false, int buttons = All );
 
      virtual ~KEditListBox();
 
      TQListBox* listBox() const     { return m_listBox; }
      KLineEdit* lineEdit() const     { return m_lineEdit; }
      TQPushButton* addButton() const     { return servNewButton; }
      TQPushButton* removeButton() const     { return servRemoveButton; }
      TQPushButton* upButton() const     { return servUpButton; }
      TQPushButton* downButton() const     { return servDownButton; }
 
      int count() const   { return int(m_listBox->count()); }
      void insertStringList(const TQStringList& list, int index=-1);
      void insertStrList(const TQStrList* list, int index=-1);
      void insertStrList(const TQStrList& list, int index=-1);
      void insertStrList(const char ** list, int numStrings=-1, int index=-1);
      void insertItem(const TQString& text, int index=-1) {m_listBox->insertItem(text,index);}
      void clear();
      TQString text(int index) const { return m_listBox->text(index); }
      int currentItem() const;
      TQString currentText() const  { return m_listBox->currentText(); }
 
      TQStringList items() const;
 
      void setItems(const TQStringList& items);
 
      int buttons() const;
      inline Button buttonsProp() const { return (Button)buttons(); }
 
      void setButtons( uint buttons );
      inline void setButtonsProp( Button buttons ) { setButtons((uint)buttons); }
 
   signals:
      void changed();
 
      void added( const TQString & text );
 
      void added( int item, const TQString & text );
 
      void removed( const TQString & text );
 
      void removed( int item, const TQString & text );
 
      void renamed( const TQString &from, const TQString &to );
 
      void renamed( int item, const TQString &from, const TQString &to );
 
   protected slots:
      //the names should be self-explaining
      void moveItemUp();
      void moveItemDown();
      void addItem();
      void removeItem();
      void enableMoveButtons(int index);
      void typedSomething(const TQString& text);
 
   private:
      TQListBox *m_listBox;
      TQPushButton *servUpButton, *servDownButton;
      TQPushButton *servNewButton, *servRemoveButton;
      KLineEdit *m_lineEdit;
 
      //this is called in both ctors, to avoid code duplication
      void init( bool checkAtEntering, int buttons,
                 TQWidget *representationWidget = 0L );
 
   protected:
      virtual void virtual_hook( int id, void* data );
   private:
      //our lovely private d-pointer
      KEditListBoxPrivate* const d;
 
    // ### KDE4: add virtual destructor
    public:
    class CustomEditor
    {
    public:
        TDEUI_EXPORT CustomEditor()
            : m_representationWidget( 0L ),
              m_lineEdit( 0L ) {}
        TDEUI_EXPORT CustomEditor( TQWidget *repWidget, KLineEdit *edit )
            : m_representationWidget( repWidget ),
              m_lineEdit( edit ) {}
        TDEUI_EXPORT CustomEditor( KComboBox *combo );
 
        TDEUI_EXPORT void setRepresentationWidget( TQWidget *repWidget ) {
            m_representationWidget = repWidget;
        }
        TDEUI_EXPORT void setLineEdit( KLineEdit *edit ) {
            m_lineEdit = edit;
        }
 
        TDEUI_EXPORT virtual TQWidget   *representationWidget() const {
            return m_representationWidget;
        }
        TDEUI_EXPORT  virtual KLineEdit *lineEdit() const {
            return m_lineEdit;
        }
 
    protected:
        TQWidget *m_representationWidget;
        KLineEdit *m_lineEdit;
    };
};
 
#endif