summaryrefslogtreecommitdiffstats
path: root/chalk/ui/squeezedcombobox.h
blob: 03a1cdb930e2b8e4649c2c99cf69740ae398b676 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/* ============================================================
 * Author: Tom Albers <tomalbers@kde.nl>
 * Date  : 2005-01-01
 * Description : 
 * 
 * Copyright 2005 by Tom Albers
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 * 
 * This program 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 General Public License for more details.
 * 
 * ============================================================ */

/** @file squeezedcombobox.h */

#ifndef STQUEEZEDCOMBOBOX_H
#define STQUEEZEDCOMBOBOX_H

class TQTimer;

// TQt includes.

#include <tqcombobox.h>
#include <tqtooltip.h>

class SqueezedComboBox;

/** @class SqueezedComboBoxTip
 * This class shows a tooltip for a SqueezedComboBox
 * the tooltip will contain the full text and helps
 * the user find the correct entry. It is automatically
 * activated when starting a SqueezedComboBox. This is
 * inherited from TQToolTip
 * 
 * @author Tom Albers
 */
class SqueezedComboBoxTip : public TQToolTip
{
public:
    /**
     * Constructor. An example call (as done in
     * SqueezedComboBox::SqueezedComboBox):
     * @code
     * t = new SqueezedComboBoxTip( this->listBox()->viewport(), this );
     * @endcode
     * 
     * @param parent parent widget (viewport)
     * @param name parent widget
     */
    SqueezedComboBoxTip( TQWidget *parent, SqueezedComboBox *name );

protected:
    /**
     * Reimplemented version from TQToolTip which shows the
     * tooltip when needed.
     * @param  pos the point where the mouse currently is
     */
    void maybeTip( const TQPoint& pos );

private:
    SqueezedComboBox*        m_originalWidget;
};

/** @class SqueezedComboBox
 *
 * This widget is a TQComboBox, but then a little bit
 * different. It only shows the right part of the items
 * depending on de size of the widget. When it is not
 * possible to show the complete item, it will be shortened
 * and "..." will be prepended.
 *
 * @image html squeezedcombobox.png "This is how it looks"
 * @author Tom Albers
 */
class SqueezedComboBox : public TQComboBox
{
    Q_OBJECT
  TQ_OBJECT

public:
    /**
     * Constructor
     * @param parent parent widget
     * @param name name to give to the widget
     */
    SqueezedComboBox(TQWidget *parent = 0, const char *name = 0 );

    /**
     * destructor
     */
    virtual ~SqueezedComboBox();

    bool contains(const TQString & text) const;

    /**
     * This inserts a item to the list. See TQComboBox::insertItem()
     * for detaills. Please do not use TQComboBox::insertItem() to this
     * widget, as that will fail.
     * @param newItem the original (long version) of the item which needs
     *                to be added to the combobox
     * @param index the position in the widget.
     */
    void insertSqueezedItem(const TQString& newItem, int index);

    /**
     * This method returns the full text (not squeezed) of the currently
     * highlighted item.
     * @return full text of the highlighted item
     */
    TQString itemHighlighted( );

    /**
     * Sets the tqsizeHint() of this widget.
     */
    virtual TQSize tqsizeHint() const;

private slots:
    void slotTimeOut();
    void slotUpdateToolTip( int index );

private:
    void resizeEvent ( TQResizeEvent * );
    TQString squeezeText( const TQString& original);

    TQMap<int,TQString>   m_originalItems;
    TQTimer*             m_timer;
    SqueezedComboBoxTip*      m_tooltip;
};

#endif // STQUEEZEDCOMBOBOX_H