libkonq Library API Documentation

KFileIVI Class Reference

KFileIVI (short form of "Konq - File - IconViewItem") is, as expected, an improved KIconViewItem, because it represents a file. More...

#include <kfileivi.h>

List of all members.

Public Member Functions

 KFileIVI (KonqIconViewWidget *iconview, KFileItem *fileitem, int size)
virtual void returnPressed ()
KFileItem * item () const
virtual bool acceptDrop (const QMimeSource *mime) const
virtual void setIcon (int size, int state=KIcon::DefaultState, bool recalc=false, bool redraw=false)
void setPixmapDirect (const QPixmap &pixmap, bool recalc=false, bool redraw=false)
void invalidateThumb (int state, bool redraw=false)
void invalidateThumbnail ()
bool isThumbnailInvalid () const
bool hasValidThumbnail () const
int state () const
int iconSize () const
void setDisabled (bool disabled)
void setThumbnailPixmap (const QPixmap &pixmap)
void setEffect (int state)
bool isThumbnail () const
void setOverlay (const QString &iconName)
virtual void refreshIcon (bool redraw)
virtual void setKey (const QString &key)
virtual void paintItem (QPainter *p, const QColorGroup &cg)
virtual bool move (int x, int y)
void setMouseOverAnimation (const QString &movieFileName)
QString mouseOverAnimation () const
bool hasAnimation () const
bool isAnimated () const
void setAnimated (bool)
void setActive (bool active)
KIVDirectoryOverlay * setShowDirectoryOverlay (bool)
bool showDirectoryOverlay ()
virtual int compare (QIconViewItem *i) const

Protected Member Functions

virtual void dropped (QDropEvent *e, const QValueList< QIconDragItem > &)
void paintOverlay (QPainter *p) const
QColorGroup updateColors (const QColorGroup &c) const
void paintFontUpdate (QPainter *p) const


Detailed Description

KFileIVI (short form of "Konq - File - IconViewItem") is, as expected, an improved KIconViewItem, because it represents a file.

All the information about the file is contained in the KFileItem pointer.

Definition at line 38 of file kfileivi.h.


Constructor & Destructor Documentation

KFileIVI::KFileIVI KonqIconViewWidget iconview,
KFileItem *  fileitem,
int  size
 

Create an icon, within a qlistview, representing a file.

Parameters:
parent the parent widget
fileitem the file item created by KDirLister
size the icon size

Definition at line 50 of file kfileivi.cc.

References setMouseOverAnimation().


Member Function Documentation

void KFileIVI::returnPressed  )  [virtual]
 

Handler for return (or single/double click) on ONE icon.

Runs the file through KRun.

Definition at line 345 of file kfileivi.cc.

KFileItem* KFileIVI::item  )  const [inline]
 

Returns:
the file item held by this instance

Definition at line 59 of file kfileivi.h.

Referenced by KonqIconViewWidget::setIcons().

bool KFileIVI::acceptDrop const QMimeSource mime  )  const [virtual]
 

Returns:
true if dropping on this file is allowed Overloads QIconView::acceptDrop()

Definition at line 297 of file kfileivi.cc.

void KFileIVI::setIcon int  size,
int  state = KIcon::DefaultState,
bool  recalc = false,
bool  redraw = false
[virtual]
 

Changes the icon for this item.

Parameters:
size the icon size (0 for default, otherwise size in pixels)
state the state of the icon (enum in KIcon)
recalc whether to update the layout of the icon view when setting the icon
redraw whether to redraw the item after setting the icon

Definition at line 109 of file kfileivi.cc.

References setPixmapDirect().

Referenced by refreshIcon(), and KonqIconViewWidget::setIcons().

void KFileIVI::setPixmapDirect const QPixmap pixmap,
bool  recalc = false,
bool  redraw = false
 

Bypass setIcon.

This is for animated icons, you should use setIcon in all other cases.

Parameters:
pixmap the pixmap to set - it SHOULD really have the right icon size!
recalc whether to update the layout of the icon view when setting the icon
redraw whether to redraw the item after setting the icon

Definition at line 162 of file kfileivi.cc.

Referenced by setIcon().

void KFileIVI::invalidateThumb int  state,
bool  redraw = false
 

Notifies that all icon effects on thumbs should be invalidated, e.g.

because the effect settings have been changed. The thumb itself is assumed to be still valid (use setThumbnailPixmap() instead otherwise).

Parameters:
state the state of the icon (enum in KIcon)
redraw whether to redraw the item after setting the icon

Definition at line 83 of file kfileivi.cc.

Referenced by KonqIconViewWidget::setIcons().

void KFileIVI::invalidateThumbnail  ) 
 

Our current thumbnail is not longer "current".

Called when the file contents have changed.

Definition at line 287 of file kfileivi.cc.

int KFileIVI::state  )  const [inline]
 

Return the current state of the icon (KIcon::DefaultState, KIcon::ActiveState etc.).

Definition at line 113 of file kfileivi.h.

Referenced by KonqIconViewWidget::setIcons().

int KFileIVI::iconSize  )  const [inline]
 

Return the theorical size of the icon.

Definition at line 118 of file kfileivi.h.

void KFileIVI::setDisabled bool  disabled  ) 
 

Set to true when this icon is 'cut'.

Definition at line 190 of file kfileivi.cc.

References setEffect().

void KFileIVI::setThumbnailPixmap const QPixmap pixmap  ) 
 

Set this when the thumbnail was loaded.

Definition at line 201 of file kfileivi.cc.

void KFileIVI::setEffect int  state  ) 
 

Set the icon to use the specified KIconEffect See the docs for KIconEffect for details.

Definition at line 228 of file kfileivi.cc.

Referenced by setActive(), and setDisabled().

bool KFileIVI::isThumbnail  )  const [inline]
 

Returns:
true if this item is a thumbnail

Definition at line 139 of file kfileivi.h.

Referenced by refreshIcon(), and KonqIconViewWidget::setIcons().

void KFileIVI::setOverlay const QString iconName  ) 
 

Sets an icon to be shown over the bottom left corner of the icon.

Currently used for directory overlays. setOverlay(QString::null) to remove icon.

Definition at line 133 of file kfileivi.cc.

References refreshIcon().

Referenced by setShowDirectoryOverlay().

void KFileIVI::refreshIcon bool  redraw  )  [virtual]
 

Redetermines the icon (useful if KFileItem might return another icon).

Does nothing with thumbnails

Definition at line 281 of file kfileivi.cc.

References isThumbnail(), and setIcon().

Referenced by setOverlay().

void KFileIVI::paintItem QPainter p,
const QColorGroup cg
[virtual]
 

Paints this item.

Takes care of using the normal or alpha blending methods depending on the configuration.

Definition at line 351 of file kfileivi.cc.

References paintFontUpdate(), paintOverlay(), and updateColors().

void KFileIVI::setMouseOverAnimation const QString movieFileName  ) 
 

Enable an animation on mouseover, if there is an available mng.

Parameters:
movieFileName the base name for the mng, e.g. "folder". Nothing happens if there is no animation available.

Definition at line 415 of file kfileivi.cc.

Referenced by KFileIVI().

bool KFileIVI::hasAnimation  )  const
 

Return true if the icon _might_ have an animation available.

This doesn't mean the .mng exists (only determined when hovering on the icon - and if it doesn't exist setMouseOverAnimation(QString::null) is called), and it doesn't mean that it's currently running either.

Definition at line 410 of file kfileivi.cc.

bool KFileIVI::isAnimated  )  const
 

Return true if we are currently animating this icon.

Definition at line 429 of file kfileivi.cc.

void KFileIVI::setActive bool  active  ) 
 

Called when the mouse is over the icon.

Definition at line 220 of file kfileivi.cc.

References setEffect().

KIVDirectoryOverlay * KFileIVI::setShowDirectoryOverlay bool   ) 
 

Sets showing of directory overlays.

Does nothing if this does not represent a folder.

Definition at line 140 of file kfileivi.cc.

References setOverlay().

void KFileIVI::paintOverlay QPainter p  )  const [protected]
 

Contains the logic and code for painting the overlay pixmap.

Definition at line 370 of file kfileivi.cc.

Referenced by paintItem().

QColorGroup KFileIVI::updateColors const QColorGroup c  )  const [protected]
 

Updates the colorgroup.

Definition at line 388 of file kfileivi.cc.

Referenced by paintItem().

void KFileIVI::paintFontUpdate QPainter p  )  const [protected]
 

Contains the logic and code for painting links.

Definition at line 378 of file kfileivi.cc.

Referenced by paintItem().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkonq Library Version 3.3.90.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Apr 4 11:21:35 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003