Source: klistbox.h

# Source: klistbox.h |
Annotated List
Files
Globals
Hierarchy
Index

    /* This file is part of the KDE libraries
       Copyright (C) 2000 Reginald Stadlbauer

       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., 59 Temple Place - Suite 330,
       Boston, MA 02111-1307, USA.
    */
    #ifndef KLISTBOX_H
    #define KLISTBOX_H

    #include

    /**
     * Extends the functionality of @ref QListBox to honor the system
     * wide settings for Single Click/Double Click mode, Auto Selection and
     * Change Cursor over Link.
     *
     * There is a new signal @ref executed(). It gets connected to either
     * @ref QListBox::clicked() or @ref QListBox::doubleClicked()
     * depending on the KDE wide Single Click/Double Click settings. It is
     * strongly recomended that you use this signal instead of the above
     * mentioned. This way you donīt need to care about the current
     * settings.  If you want to get informed when the user selects
     * something connect to the @ref QListBox::selectionChanged() signal.
     *
     * @short A variant of @ref QListBox that honors KDE's system-wide settings.
     **/
    class KListBox : public QListBox
    {
        Q_OBJECT

    public:
      KListBox( QWidget *parent = 0, const char *name = 0, WFlags f = 0 );

    signals:

      /**
       * Emitted whenever the user executes an listbox item.
       *
       * That means depending on the KDE wide Single Click/Double Click
       * setting the user clicked or double clicked on that item.
       * @param item is the pointer to the executed listbox item.
       *
       * Note that you may not delete any @ref QListBoxItem objects in slots
       * connected to this signal.
       */
      void executed( QListBoxItem *item );

      /**
       * Emitted whenever the user executes an listbox item.
       *
       * That means depending on the KDE wide Single Click/Double Click
       * setting the user clicked or double clicked on that item.
       * @param item is the pointer to the executed listbox item.
       * @param pos is the position where the user has clicked
       *
       * Note that you may not delete any @ref QListBoxItem objects in slots
       * connected to this signal.
       */
      void executed( QListBoxItem *item, const QPoint &pos );

      /**
       * This signal gets emitted whenever the user double clicks into the
       * listbox.
       *
       * @param item The pointer to the clicked listbox item.
       * @param pos The position where the user has clicked.
       *
       * Note that you may not delete any @ref QListBoxItem objects in slots
       * connected to this signal.
       *
       * This signal is more or less here for the sake of completeness.
       * You should normally not need to use this. In most cases itīs better
       * to use @ref executed() instead.
       */
      void doubleClicked( QListBoxItem *item, const QPoint &pos );

    protected slots:
      void slotOnItem( QListBoxItem *item );
      void slotOnViewport();

      void slotSettingsChanged(int);

      /**
       * Auto selection happend.
       */
      void slotAutoSelect();

    protected:
      void emitExecute( QListBoxItem *item, const QPoint &pos );

      /**
       * @reimplemented
       */
      virtual void keyPressEvent(QKeyEvent *e);
      /**
       * @reimplemented
       */
      virtual void focusOutEvent( QFocusEvent *fe );
      /**
       * @reimplemented
       */
      virtual void leaveEvent( QEvent *e );
      /**
       * @reimplemented
       */
      virtual void contentsMousePressEvent( QMouseEvent *e );
      /**
       * @reimplemented
       */
      virtual void contentsMouseDoubleClickEvent ( QMouseEvent *e );

      bool m_bUseSingle;
      bool m_bChangeCursorOverItem;

      QListBoxItem* m_pCurrentItem;

      QTimer* m_pAutoSelect;
      int m_autoSelectDelay;

    private slots:
      void slotMouseButtonClicked( int btn, QListBoxItem *item, const QPoint &pos );

    protected:
      virtual void virtual_hook( int id, void* data );
    private:
      class KListBoxPrivate;
      KListBoxPrivate *d;
    };

    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.