1QIconViewItem(3qt) QIconViewItem(3qt)
2
6 QIconViewItem - Single item in a QIconView
7
9 #include <qiconview.h>
10 Inherits Qt.
12 Public Members
14 QIconViewItem ( QIconView * parent )
15 QIconViewItem ( QIconView * parent, QIconViewItem * after )
16 QIconViewItem ( QIconView * parent, const QString & text )
17 QIconViewItem ( QIconView * parent, QIconViewItem * after, const
18 QString & text )
19 QIconViewItem ( QIconView * parent, const QString & text, const QPixmap
20 & icon )
21 QIconViewItem ( QIconView * parent, QIconViewItem * after, const
22 QString & text, const QPixmap & icon )
23 QIconViewItem ( QIconView * parent, const QString & text, const
24 QPicture & picture )
25 QIconViewItem ( QIconView * parent, QIconViewItem * after, const
26 QString & text, const QPicture & picture )
27 virtual ~QIconViewItem ()
28 virtual void setRenameEnabled ( bool allow )
29 virtual void setDragEnabled ( bool allow )
30 virtual void setDropEnabled ( bool allow )
31 virtual QString text () const
32 virtual QPixmap * pixmap () const
33 virtual QPicture * picture () const
34 virtual QString key () const
35 bool renameEnabled () const
36 bool dragEnabled () const
37 bool dropEnabled () const
38 QIconView * iconView () const
39 QIconViewItem * prevItem () const
40 QIconViewItem * nextItem () const
41 int index () const
42 virtual void setSelected ( bool s, bool cb )
43 virtual void setSelected ( bool s )
44 virtual void setSelectable ( bool enable )
45 bool isSelected () const
46 bool isSelectable () const
47 virtual void repaint ()
48 virtual bool move ( int x, int y )
49 virtual void moveBy ( int dx, int dy )
50 virtual bool move ( const QPoint & pnt )
51 virtual void moveBy ( const QPoint & pnt )
52 QRect rect () const
53 int x () const
54 int y () const
55 int width () const
56 int height () const
57 QSize size () const
58 QPoint pos () const
59 QRect textRect ( bool relative = TRUE ) const
60 QRect pixmapRect ( bool relative = TRUE ) const
61 bool contains ( const QPoint & pnt ) const
62 bool intersects ( const QRect & r ) const
63 virtual bool acceptDrop ( const QMimeSource * mime ) const
64 void rename ()
65 virtual int compare ( QIconViewItem * i ) const
66 virtual void setText ( const QString & text )
67 virtual void setPixmap ( const QPixmap & icon )
68 virtual void setPicture ( const QPicture & icon )
69 virtual void setText ( const QString & text, bool recalc, bool redraw =
70 TRUE )
71 virtual void setPixmap ( const QPixmap & icon, bool recalc, bool redraw
72 = TRUE )
73 virtual void setKey ( const QString & k )
74 virtual int rtti () const
75 Protected Members
77 virtual void removeRenameBox ()
78 virtual void calcRect ( const QString & text_ = QString::null )
79 virtual void paintItem ( QPainter * p, const QColorGroup & cg )
80 virtual void paintFocus ( QPainter * p, const QColorGroup & cg )
81 virtual void dropped ( QDropEvent * e, const QValueList<QIconDragItem>
82 & lst )
83 virtual void dragEntered ()
84 virtual void dragLeft ()
85 void setItemRect ( const QRect & r )
86 void setTextRect ( const QRect & r )
87 void setPixmapRect ( const QRect & r )
88
90 The QIconViewItem class provides a single item in a QIconView.
91 A QIconViewItem contains an icon, a string and optionally a sort key,
93 and can display itself in a QIconView. The class is designed to be very
94 similar to QListView and QListBox in use, both via instantiation and
95 subclassing.
96 The simplest way to create a QIconViewItem and insert it into a
98 QIconView is to construct the item passing the constructor a pointer to
99 the icon view, a string and an icon:
100 (void) new QIconViewItem(
102 iconView, // A pointer to a QIconView
103 "This is the text of the item",
104 aPixmap );
105 By default the text of an icon view item may not be edited by the user
107 but calling setRenameEnabled(TRUE) will allow the user to perform in-
108 place editing of the item's text.
109 When the icon view is deleted all items in it are deleted
111 automatically.
112 The QIconView::firstItem() and QIconViewItem::nextItem() functions
114 provide a means of iterating over all the items in a QIconView:
115 QIconViewItem *item;
117 for ( item = iconView->firstItem(); item; item = item->nextItem() )
118 do_something_with( item );
119 The item's icon view is available from iconView(), and its position in
121 the icon view from index().
122 The item's selection status is available from isSelected() and is set
124 and controlled by setSelected() and isSelectable().
125 The text and icon can be set with setText() and setPixmap() and
127 retrieved with text() and pixmap(). The item's sort key defaults to
128 text() but may be set with setKey() and retrieved with key(). The
129 comparison function, compare() uses key().
130 Items may be repositioned with move() and moveBy(). An item's geometry
132 is available from rect(), x(), y(), width(), height(), size(), pos(),
133 textRect() and pixmapRect(). You can also test against the position of
134 a point with contains() and intersects().
135 To remove an item from an icon view, just delete the item. The
137 QIconViewItem destructor removes it cleanly from its icon view.
138 Because the icon view is designed to use drag-and-drop, the icon view
140 item also has functions for drag-and-drop which may be reimplemented.
141 Note: Pixmaps with individual dimensions larger than 300 pixels may not
143 be displayed properly, depending on the arrangement in use. For
144 example, pixmaps wider than 300 pixels will not be arranged correctly
145 if the icon view uses a QIconView::TopToBottom arrangement, and pixmaps
146 taller than 300 pixels will not be arranged correctly if the icon view
147 uses a QIconView::LeftToRight arrangement.
148 See also Advanced Widgets.
150
153 Constructs a QIconViewItem and inserts it into icon view parent with no
154 text and a default icon.
155
157 Constructs a QIconViewItem and inserts it into the icon view parent
158 with no text and a default icon, after the icon view item after.
159
161 Constructs an icon view item and inserts it into the icon view parent
162 using text as the text and a default icon.
163
165 const QString & text )
166 Constructs an icon view item and inserts it into the icon view parent
167 using text as the text and a default icon, after the icon view item
168 after.
169
171 QPixmap & icon )
172 Constructs an icon view item and inserts it into the icon view parent
173 using text as the text and icon as the icon.
174
176 const QString & text, const QPixmap & icon )
177 Constructs an icon view item and inserts it into the icon view parent
178 using text as the text and icon as the icon, after the icon view item
179 after.
180 See also setPixmap().
182
184 QPicture & picture )
185 Constructs an icon view item and inserts it into the icon view parent
186 using text as the text and picture as the icon.
187
189 const QString & text, const QPicture & picture )
190 Constructs an icon view item and inserts it into the icon view parent
191 using text as the text and picture as the icon, after the icon view
192 item after.
193
195 Destroys the icon view item and tells the parent icon view that the
196 item has been destroyed.
197
199 Returns TRUE if you can drop things with a QMimeSource of mime onto
200 this item; otherwise returns FALSE.
201 The default implementation always returns FALSE. You must subclass
203 QIconViewItem and reimplement acceptDrop() to accept drops.
204 Examples:
206
208 [virtual protected]
209 This virtual function is responsible for calculating the rectangles
210 returned by rect(), textRect() and pixmapRect(). setRect(),
211 setTextRect() and setPixmapRect() are provided mainly for
212 reimplementations of this function.
213 text_ is an internal parameter which defaults to QString::null.
215
217 Compares this icon view item to i. Returns -1 if this item is less than
218 i, 0 if they are equal, and 1 if this icon view item is greater than i.
219 The default implementation compares the item keys (key()) using
221 QString::localeAwareCompare(). A reimplementation may use different
222 values and a different comparison function. Here is a reimplementation
223 that uses plain Unicode comparison:
224 int MyIconViewItem::compare( QIconViewItem *i ) const
226 {
227 return key().compare( i->key() );
228 }
229 See also key(), QString::localeAwareCompare(), and QString::compare().
231
233 Returns TRUE if the item contains the point pnt (in contents
234 coordinates); otherwise returns FALSE.
235
237 Returns TRUE if the user is allowed to drag the icon view item;
238 otherwise returns FALSE.
239 See also setDragEnabled().
241
243 This function is called when a drag enters the item's bounding
244 rectangle.
245 The default implementation does nothing; subclasses may reimplement
247 this function.
248 Example: fileiconview/qfileiconview.cpp.
250
252 This function is called when a drag leaves the item's bounding
253 rectangle.
254 The default implementation does nothing; subclasses may reimplement
256 this function.
257 Example: fileiconview/qfileiconview.cpp.
259
261 Returns TRUE if the user is allowed to drop something onto the item;
262 otherwise returns FALSE.
263 See also setDropEnabled().
265
267 & lst ) [virtual protected]
268 This function is called when something is dropped on the item. e
269 provides all the information about the drop. If the drag object of the
270 drop was a QIconDrag, lst contains the list of the dropped items. You
271 can get the data by calling QIconDragItem::data() on each item. If the
272 lst is empty, i.e. the drag was not a QIconDrag, you must decode the
273 data in e and work with that.
274 The default implementation does nothing; subclasses may reimplement
276 this function.
277 Examples:
279
281 Returns the height of the item.
282
284 Returns a pointer to this item's icon view parent.
285
287 Returns the index of this item in the icon view, or -1 if an error
288 occurred.
289
291 Returns TRUE if the item intersects the rectangle r (in contents
292 coordinates); otherwise returns FALSE.
293
295 Returns TRUE if the item is selectable; otherwise returns FALSE.
296 See also setSelectable().
298
300 Returns TRUE if the item is selected; otherwise returns FALSE.
301 See also setSelected().
303 Example: fileiconview/qfileiconview.cpp.
305
307 Returns the key of the icon view item or text() if no key has been
308 explicitly set.
309 See also setKey() and compare().
311
313 Moves the item to position (x, y) in the icon view (these are contents
314 coordinates).
315
317 This is an overloaded member function, provided for convenience. It
318 behaves essentially like the above function.
319 Moves the item to the point pnt.
321
323 Moves the item dx pixels in the x-direction and dy pixels in the y-
324 direction.
325
327 This is an overloaded member function, provided for convenience. It
328 behaves essentially like the above function.
329 Moves the item by the x, y values in point pnt.
331
333 Returns a pointer to the next item, or 0 if this is the last item in
334 the icon view.
335 To find the first item use QIconView::firstItem().
337 Example:
339 QIconViewItem *item;
341 for ( item = iconView->firstItem(); item; item = item->nextItem() )
342 do_something_with( item );
343 See also prevItem().
345 Example: fileiconview/qfileiconview.cpp.
347
349 [virtual protected]
350 Paints the focus rectangle of the item using the painter p and the
351 color group cg.
352
354 [virtual protected]
355 Paints the item using the painter p and the color group cg. If you want
356 the item to be drawn with a different font or color, reimplement this
357 function, change the values of the color group or the painter's font,
358 and then call the QIconViewItem::paintItem() with the changed values.
359 Example: fileiconview/qfileiconview.cpp.
361
363 Returns the icon of the icon view item if it is a picture, or 0 if it
364 is a pixmap. In the latter case use pixmap() instead. Normally you set
365 the picture of the item with setPicture(), but sometimes it's
366 inconvenient to call setPicture() for every item. So you can subclass
367 QIconViewItem, reimplement this function and return a pointer to the
368 item's picture. If you do this, you must call calcRect() manually each
369 time the size of this picture changes.
370 See also setPicture().
372
374 Returns the icon of the icon view item if it is a pixmap, or 0 if it is
375 a picture. In the latter case use picture() instead. Normally you set
376 the pixmap of the item with setPixmap(), but sometimes it's
377 inconvenient to call setPixmap() for every item. So you can subclass
378 QIconViewItem, reimplement this function and return a pointer to the
379 item's pixmap. If you do this, you must call calcRect() manually each
380 time the size of this pixmap changes.
381 See also setPixmap().
383 Example: fileiconview/qfileiconview.cpp.
385
387 Returns the bounding rectangle of the item's icon.
388 If relative is TRUE, (the default), the rectangle is relative to the
390 origin of the item's rectangle. If relative is FALSE, the returned
391 rectangle is relative to the origin of the icon view's contents
392 coordinate system.
393 Example: fileiconview/qfileiconview.cpp.
395
397 Returns the position of the item (in contents coordinates).
398
400 Returns a pointer to the previous item, or 0 if this is the first item
401 in the icon view.
402 See also nextItem() and QIconView::firstItem().
404
406 Returns the bounding rectangle of the item (in contents coordinates).
407
409 Removes the editbox that is used for in-place renaming.
410
412 Starts in-place renaming of an icon, if allowed.
413 This function sets up the icon view so that the user can edit the item
415 text, and then returns. When the user is done, setText() will be called
416 and QIconView::itemRenamed() will be emitted (unless the user canceled,
417 e.g. by pressing the Escape key).
418 See also setRenameEnabled().
420 Example: fileiconview/qfileiconview.cpp.
422
424 Returns TRUE if the item can be renamed by the user with in-place
425 renaming; otherwise returns FALSE.
426 See also setRenameEnabled().
428 Example: fileiconview/qfileiconview.cpp.
430
432 Repaints the item.
433
435 Returns 0.
436 Make your derived classes return their own values for rtti(), so that
438 you can distinguish between icon view item types. You should use values
439 greater than 1000, preferably a large random number, to allow for
440 extensions to this class.
441
443 If allow is TRUE, the icon view permits the user to drag the icon view
444 item either to another position within the icon view or to somewhere
445 outside of it. If allow is FALSE, the item cannot be dragged.
446
448 If allow is TRUE, the icon view lets the user drop something on this
449 icon view item.
450
452 Sets the bounding rectangle of the whole item to r. This function is
453 provided for subclasses which reimplement calcRect(), so that they can
454 set the calculated rectangle. Any other use is discouraged.
455 See also calcRect(), textRect(), setTextRect(), pixmapRect(), and
457 setPixmapRect().
458
460 Sets k as the sort key of the icon view item. By default text() is used
461 for sorting.
462 See also compare().
464 Example: fileiconview/qfileiconview.cpp.
466
468 Sets icon as the item's icon in the icon view. This function might be a
469 no-op if you reimplement picture().
470 See also picture().
472
474 Sets icon as the item's icon in the icon view. This function might be a
475 no-op if you reimplement pixmap().
476 Note: Pixmaps with individual dimensions larger than 300 pixels may not
478 be displayed properly, depending on the arrangement in use. See the
479 main class documentation for details.
480 See also pixmap().
482
484 = TRUE ) [virtual]
485 This is an overloaded member function, provided for convenience. It
486 behaves essentially like the above function.
487 Sets icon as the item's icon in the icon view. If recalc is TRUE, the
489 icon view's layout is recalculated. If redraw is TRUE (the default),
490 the icon view is repainted.
491 Note: Pixmaps with individual dimensions larger than 300 pixels may not
493 be displayed properly, depending on the arrangement in use. See the
494 main class documentation for details.
495 See also pixmap().
497
499 Sets the bounding rectangle of the item's icon to r. This function is
500 provided for subclasses which reimplement calcRect(), so that they can
501 set the calculated rectangle. Any other use is discouraged.
502 See also calcRect(), pixmapRect(), setItemRect(), and setTextRect().
504
506 If allow is TRUE, the user can rename the icon view item by clicking on
507 the text (or pressing F2) while the item is selected (in-place
508 renaming). If allow is FALSE, in-place renaming is not possible.
509 Examples:
511
513 Sets this item to be selectable if enable is TRUE (the default) or
514 unselectable if enable is FALSE.
515 The user is unable to select a non-selectable item using either the
517 keyboard or the mouse. (The application programmer can select an item
518 in code regardless of this setting.)
519 See also isSelectable().
521
523 Selects or unselects the item, depending on s; it may also unselect
524 other items, depending on QIconView::selectionMode() and cb.
525 If s is FALSE, the item is unselected.
527 If s is TRUE and QIconView::selectionMode() is Single, the item is
529 selected and the item previously selected is unselected.
530 If s is TRUE and QIconView::selectionMode() is Extended, the item is
532 selected. If cb is TRUE, the selection state of the other items is left
533 unchanged. If cb is FALSE (the default) all other items are unselected.
534 If s is TRUE and QIconView::selectionMode() is Multi, the item is
536 selected.
537 Note that cb is used only if QIconView::selectionMode() is Extended; cb
539 defaults to FALSE.
540 All items whose selection status changes repaint themselves.
542 Example: fileiconview/qfileiconview.cpp.
544
546 This is an overloaded member function, provided for convenience. It
547 behaves essentially like the above function.
548 This variant is equivalent to calling the other variant with cb set to
550 FALSE.
551
553 Sets text as the text of the icon view item. This function might be a
554 no-op if you reimplement text().
555 See also text().
557 Example: fileiconview/qfileiconview.cpp.
559
561 TRUE ) [virtual]
562 This is an overloaded member function, provided for convenience. It
563 behaves essentially like the above function.
564 Sets text as the text of the icon view item. If recalc is TRUE, the
566 icon view's layout is recalculated. If redraw is TRUE (the default),
567 the icon view is repainted.
568 See also text().
570
572 Sets the bounding rectangle of the item's text to r. This function is
573 provided for subclasses which reimplement calcRect(), so that they can
574 set the calculated rectangle. Any other use is discouraged.
575 See also calcRect(), textRect(), setItemRect(), and setPixmapRect().
577
579 Returns the size of the item.
580
582 Returns the text of the icon view item. Normally you set the text of
583 the item with setText(), but sometimes it's inconvenient to call
584 setText() for every item; so you can subclass QIconViewItem,
585 reimplement this function, and return the text of the item. If you do
586 this, you must call calcRect() manually each time the text (and
587 therefore its size) changes.
588 See also setText().
590 Example: fileiconview/qfileiconview.cpp.
592
594 Returns the bounding rectangle of the item's text.
595 If relative is TRUE, (the default), the returned rectangle is relative
597 to the origin of the item's rectangle. If relative is FALSE, the
598 returned rectangle is relative to the origin of the icon view's
599 contents coordinate system.
600 Example: fileiconview/qfileiconview.cpp.
602
604 Returns the width of the item.
605
607 Returns the x-coordinate of the item (in contents coordinates).
608
610 Returns the y-coordinate of the item (in contents coordinates).
611
614 http://doc.trolltech.com/qiconviewitem.html
615 http://www.trolltech.com/faq/tech.html
616
618 Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
619 license file included in the distribution for a complete license
620 statement.
621
623 Generated automatically from the source code.
624
626 If you find a bug in Qt, please report it as described in
627 http://doc.trolltech.com/bughowto.html. Good bug reports help us to
628 help you. Thank you.
629 The definitive Qt documentation is provided in HTML format; it is
631 located at $QTDIR/doc/html and can be read using Qt Assistant or with a
632 web browser. This man page is provided as a convenience for those users
633 who prefer man pages, although this format is not officially supported
634 by Trolltech.
635 If you find errors in this manual page, please report them to qt-
637 bugs@trolltech.com. Please include the name of the manual page
638 (qiconviewitem.3qt) and the Qt version (3.3.8).
639Trolltech AS 2 February 2007 QIconViewItem(3qt)