summaryrefslogtreecommitdiff
path: root/libopie2/opieui/olistview.h
blob: 8195a6270d37734d9b1d0ac36516ac8765b3d85e (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
/*
                             This file is part of the Opie Project
              =.             (C) 2003-2004 Michael 'Mickey' Lauer <mickey@vanille.de>
            .=l.
           .>+-=
 _;:,     .>    :=|.         This program is free software; you can
.> <`_,   >  .   <=          redistribute it and/or  modify it under
:`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
.="- .-=="i,     .._         License as published by the Free Software
 - .   .-<_>     .<>         Foundation; either version 2 of the License,
     ._= =}       :          or (at your option) any later version.
    .%`+i>       _;_.
    .i_,=:_.      -<s.       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
..}^=.=       =       ;      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 OLISTVIEW_H
#define OLISTVIEW_H

#include <qcolor.h>
#include <qlistview.h>
#include <qpen.h>
#include <qdatastream.h>
#include <qstringlist.h>


namespace Opie {
namespace Ui   {
class OListViewItem;


/*======================================================================================
 * OListView
 *======================================================================================*/

/**
 * @brief A list/tree widget.
 *
 * A @ref QListView variant featuring visual and functional enhancements
 * like an alternate background for odd rows, an autostretch mode
 * for the width of the widget ( >= Qt 3 only ) and persistence capabilities.
 *
 * @author Michael 'Mickey' Lauer <mickey@vanille.de>
 */
class OListView: public QListView
{
    Q_OBJECT
  public:
   /**
    * Constructor.
    *
    * The parameters @a parent and @a name are handled by
    * @ref QListView, as usual.
    */
    OListView( QWidget* parent = 0, const char* name = 0 );
   /**
    * Destructor.
    */
    virtual ~OListView();
   /**
    * Let the last column fit exactly all the available width.
    */
    void setFullWidth( bool fullWidth );
   /**
    * Returns whether the last column is set to fit the available width.
    */
    bool fullWidth() const;
   /**
    * Reimplemented for full width support
    */
    virtual int addColumn( const QString& label, int width = -1 );
   /**
    * Reimplemented for full width support
    */
    virtual int addColumn( const QIconSet& iconset, const QString& label, int width = -1 );
   /**
    * Reimplemented for full width support
    */
    virtual void removeColumn(int index);
   /**
    * Set the alternate background background @a color.
    * Set to an invalid color to disable alternate colors.
    * This only has an effect if the items are OListViewItems
    */
    void setAlternateBackground( const QColor& color );
   /**
    * Sets the column separator @a pen.
    */
    void setColumnSeparator( const QPen& pen );

   /**
    * @returns the alternate background color
    */
    const QColor& alternateBackground() const;
   /**
    * @return the column separator pen
    */
    const QPen& columnSeparator() const;
   /**
    * Create a list view item as child of this object
    * @returns the new object
    */
    virtual OListViewItem* childFactory();
#ifndef QT_NO_DATASTREAM
   /**
    * Serialize this object to @ref QDataStream @a stream
    */
    virtual void serializeTo( QDataStream& stream ) const;
   /**
    * Serialize this object from a @ref QDataStream @a stream
    */
    virtual void serializeFrom( QDataStream& s );
#endif

  public slots:
    /**
     * Expand all items
     */
     void expand();
    /**
     * Collapse all items
     */
     void collapse();

  protected slots:
    /**
     * expand the current OListViewItem
     */
    void expand(QListViewItem*);

  private:
    QColor m_alternateBackground;
    bool m_fullWidth : 1;
    QPen m_columnSeparator;
    class Private;
    Private *d;
};

#ifndef QT_NO_DATASTREAM
/**
  * @relates OListView
  * Writes @a listview to the @a stream and returns a reference to the stream.
  */
QDataStream& operator<<( QDataStream& stream, const OListView& listview );
/**
  * @relates OListView
  * Reads @a listview from the @a stream and returns a reference to the stream.
  */
QDataStream& operator>>( QDataStream& stream, OListView& listview );
#endif // QT_NO_DATASTREAM

/*======================================================================================
 * OListViewItem
 *======================================================================================*/

class OListViewItem: public QListViewItem
{
    friend class OCheckListItem;
  public:
    /**
     * Constructors.
     */
    OListViewItem( QListView * parent );
    OListViewItem( QListViewItem * parent );
    OListViewItem( QListView * parent, QListViewItem * after );
    OListViewItem( QListViewItem * parent, QListViewItem * after );

    OListViewItem( QListView * parent,
        QString,     QString = QString::null,
        QString = QString::null, QString = QString::null,
        QString = QString::null, QString = QString::null,
        QString = QString::null, QString = QString::null );

    OListViewItem( QListViewItem * parent,
        QString,     QString = QString::null,
        QString = QString::null, QString = QString::null,
        QString = QString::null, QString = QString::null,
        QString = QString::null, QString = QString::null );

    OListViewItem( QListView * parent, QListViewItem * after,
        QString,     QString = QString::null,
        QString = QString::null, QString = QString::null,
        QString = QString::null, QString = QString::null,
        QString = QString::null, QString = QString::null );

    OListViewItem( QListViewItem * parent, QListViewItem * after,
        QString,     QString = QString::null,
        QString = QString::null, QString = QString::null,
        QString = QString::null, QString = QString::null,
        QString = QString::null, QString = QString::null );
    /**
     * Destructor.
     */
    virtual ~OListViewItem();
    /**
     * @returns the background color of the list item.
     */
    const QColor& backgroundColor();
    /**
     * @returns true, if the item is at an odd position and
     * thus have to be painted with the alternate background color.
     */
    bool isAlternate();
    /**
     * @note: Reimplemented for internal purposes - the API is not affected
     *
     */
    void paintCell( QPainter *p, const QColorGroup &cg, int column, int width, int alignment );
    /**
     * Perform object initialization.
     */
    void init();
   /**
    * create a list view item as child of this object
    * @returns the new object
    */
    virtual OListViewItem* childFactory();
    #ifndef QT_NO_DATASTREAM
   /**
    * serialize this object to or from a @ref QDataStream
    * @param s the stream used to serialize this object.
    */
    virtual void serializeTo( QDataStream& s ) const;

   /**
    * serialize this object to or from a @ref QDataStream
    * @param s the stream used to serialize this object.
    */
    virtual void serializeFrom( QDataStream& s );
    #endif

    /**
     * expand the the item
     */
    virtual void expand(){};

  private:
    bool m_known : 1;
    bool m_odd   : 1;
    class Private;
    Private *d;
};

#ifndef QT_NO_DATASTREAM
/**
  * @relates QListViewItem
  * Writes listview @a item and all subitems recursively to @a stream
  * and returns a reference to the stream.
  */
QDataStream& operator<<( QDataStream& stream, const OListViewItem& item );
/**
  * @relates QListViewItem
  * Reads listview @a item from @a stream and returns a reference to the stream.
  */
QDataStream& operator>>( QDataStream& stream, OListViewItem& item );
#endif // QT_NO_DATASTREAM


/*======================================================================================
 * OCheckListItem
 *======================================================================================*/

class OCheckListItem : public QCheckListItem
{
  public:

    OCheckListItem( QCheckListItem *parent, const QString &text,
                    Type = Controller );
    OCheckListItem( QListViewItem *parent, const QString &text,
                    Type = Controller );
    OCheckListItem( QListView *parent, const QString &text,
                    Type = Controller );
    OCheckListItem( QListViewItem *parent, const QString &text,
                    const QPixmap & );
    OCheckListItem( QListView *parent, const QString &text,
                    const QPixmap & );
    ~OCheckListItem();
    /**
     * @returns the background color of the list item.
     */
    const QColor& backgroundColor();
    /**
     * @returns true, if the item is at an odd position and
     * thus have to be painted with the alternate background color.
     */
    bool isAlternate();
    /**
     * @note: Reimplemented for internal purposes - the API is not affected
     *
     */
    void paintCell( QPainter *p, const QColorGroup &cg, int column, int width, int alignment );
    /**
     * Perform object initialization.
     */
    void init();

  private:
    bool m_known;
    bool m_odd;
};


/*======================================================================================
 * ONamedListView
 *======================================================================================*/

class ONamedListViewItem;

/**
 * @brief An OListView variant with named columns.
 *
 * This class provides a higher-level interface to an OListView.
 *
 * @author Michael 'Mickey' Lauer <mickey@vanille.de>
 */
class ONamedListView: public OListView
{
  public:
    /**
     * Constructor.
     *
     * The parameters @a parent and @a name are handled by
     * @ref OListView, as usual.
     */
    ONamedListView( QWidget* parent = 0, const char* name = 0 );
    /**
     * Destructor.
     */
    virtual ~ONamedListView();
    /**
     * Add a number of @a columns to the listview.
     */
    virtual void addColumns( const QStringList& columns );
    /**
     * @returns the column index matching to @a text or -1 if not found.
     */
    virtual int findColumn( const QString& text ) const;
    /**
     * @returns the first item which has a @a text in column @a column.
     * Set @a recurse to indicate how much subchild levels to search, e.g.<ul>
     * <li>set it to 0 to search only among direct childs,
     * <li>set it to 1 to search direct childs and all 1st order subchilds
     * <li>set it to -1 for maximum recursion.
     * </ul>
     * @sa ONamedListViewItem::find()
     */
    virtual ONamedListViewItem* find( ONamedListViewItem* start, int column, const QString& text, int recurse = -1 ) const;
    virtual ONamedListViewItem* find( int column, const QString& text, int recurse = -1 ) const;

    virtual ONamedListViewItem* find( ONamedListViewItem* start, const QString& column, const QString& text, int recurse = -1 ) const;
    virtual ONamedListViewItem* find( const QString& column, const QString& text, int recurse = -1 ) const;
  private:
    class Private;
    Private *d;
};

/*======================================================================================
 * ONamedListViewItem
 *======================================================================================*/

/**
 * @brief An OListView variant with named columns.
 *
 * This class provides a higher-level interface to an OListViewItem.
 *
 * @author Michael 'Mickey' Lauer <mickey@vanille.de>
 */
class ONamedListViewItem: public OListViewItem
{
  public:
    /**
     * Constructor. Accepts the same parameters as a @ref OListViewItem,
     * plus a @ref QStringList which holds an arbitrary number of @a texts.
     */
    ONamedListViewItem( QListView* parent, const QStringList& texts );
    ONamedListViewItem( QListViewItem* parent, const QStringList& texts );
    ONamedListViewItem( QListView* parent, QListViewItem* after, const QStringList& texts );
    ONamedListViewItem( QListViewItem* parent, QListViewItem* after, const QStringList& texts );
    /**
     * Destructor.
     */
    virtual ~ONamedListViewItem();
    /**
     * Sets the text in column @a column to @a text.
     * This method differs from @ref QListViewItem::setText() in that it
     * accepts a string as column indicator instead of an int.
     */
    virtual void setText( const QString& column, const QString& text );
    /**
     * Sets a number of @a texts for this item.
     */
    virtual void setText( const QStringList& texts );
    /**
     * @returns the first child which has a @a text in column @a column.
     * Set @a recurse to indicate how much subchild levels to search, e.g.<ul>
     * <li>set it to 0 to search only among direct childs,
     * <li>set it to 1 to search direct childs and all 1st order subchilds
     * <li>set it to -1 for maximum recursion.
     * </ul>
     * @sa ONamedListView::find()
     */
    virtual ONamedListViewItem* find( int column, const QString& text, int recurse = -1 ) const;
    virtual ONamedListViewItem* find( const QString& column, const QString& text, int recurse = -1 ) const;

  private:
    class Private;
    Private *d;

};
}
}

#endif // OLISTVIEW_H