You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdelibs/tdeui/klistbox.h

129 lines
4.0 KiB

/* This file is part of the KDE libraries
Copyright (C) 2000 Reginald Stadlbauer <reggie@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 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 KLISTBOX_H
#define KLISTBOX_H
#include <tqlistbox.h>
#include <kdelibs_export.h>
/**
* @short A variant of TQListBox that honors KDE's system-wide settings.
*
* Extends the functionality of TQListBox to honor the system
* wide settings for Single Click/Double Click mode, Auto Selection and
* Change Cursor over Link.
*
* There is a new signal executed(). It gets connected to either
* TQListBox::clicked() or TQListBox::doubleClicked()
* depending on the KDE wide Single Click/Double Click settings. It is
* strongly recommended 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 TQListBox::selectionChanged() signal.
**/
class TDEUI_EXPORT KListBox : public TQListBox
{
Q_OBJECT
public:
KListBox( TQWidget *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 TQListBoxItem objects in slots
* connected to this signal.
*/
void executed( TQListBoxItem *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 TQListBoxItem objects in slots
* connected to this signal.
*/
void executed( TQListBoxItem *item, const TQPoint &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 TQListBoxItem 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 executed() instead.
*/
void doubleClicked( TQListBoxItem *item, const TQPoint &pos );
protected slots:
void slotOnItem( TQListBoxItem *item );
void slotOnViewport();
void slotSettingsChanged(int);
/**
* Auto selection happend.
*/
void slotAutoSelect();
protected:
void emitExecute( TQListBoxItem *item, const TQPoint &pos );
virtual void keyPressEvent(TQKeyEvent *e);
virtual void focusOutEvent( TQFocusEvent *fe );
virtual void leaveEvent( TQEvent *e );
virtual void contentsMousePressEvent( TQMouseEvent *e );
virtual void contentsMouseDoubleClickEvent ( TQMouseEvent *e );
bool m_bUseSingle;
bool m_bChangeCursorOverItem;
TQListBoxItem* m_pCurrentItem;
TQTimer* m_pAutoSelect;
int m_autoSelectDelay;
private slots:
void slotMouseButtonClicked( int btn, TQListBoxItem *item, const TQPoint &pos );
protected:
virtual void virtual_hook( int id, void* data );
private:
class KListBoxPrivate;
KListBoxPrivate* const d;
};
#endif