Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KURLBarItem Class Reference

#include <kurlbar.h>

List of all members.

Public Methods

 KURLBarItem (KURLBar *parent, const KURL &url, const QString &description=QString::null, const QString &icon=QString::null, KIcon::Group group=KIcon::Panel)
 ~KURLBarItem ()
void setURL (const KURL &url)
void setIcon (const QString &icon, KIcon::Group group=KIcon::Panel)
void setDescription (const QString &desc)
void setToolTip (const QString &tip)
QSize sizeHint () const
virtual int width (const QListBox *) const
virtual int height (const QListBox *) const
const KURLurl () const
const QString & description () const
const QString & icon () const
QString toolTip () const
KIcon::Group iconGroup () const
virtual const QPixmap * pixmap () const
void setApplicationLocal (bool local)
bool applicationLocal () const


Detailed Description

An item to be used in KURLBar / KURLBarListBox. All the properties (url, icon, descroption, tooltip) can be changed dynamically.

Author:
Carsten Pfeiffer <pfeiffer@kde.org>
See also:
KURLBar , KURLBarListBox

Definition at line 42 of file kurlbar.h.


Constructor & Destructor Documentation

KURLBarItem::KURLBarItem KURLBar   parent,
const KURL   url,
const QString &    description = QString::null,
const QString &    icon = QString::null,
KIcon::Group    group = KIcon::Panel
 

Creates a KURLBarItem to be used in the parent KURLBar. You need to insert the item into the listbox manually, if you don't use KURLBar::insertItem().

If description is empty, it will try to use the filename/directory of url, which will be shown as text of the item. url will be used as tooltip, unless you set a different tip with setToolTip()

KURLBarItem::~KURLBarItem  
 

Destroys the item


Member Function Documentation

bool KURLBarItem::applicationLocal   const [inline]
 

returns whether this is a global item or a local one. KURLBar can differentiate between global and local items (only for the current application) for easy extensiblity.

See also:
setApplicationLocal

Definition at line 143 of file kurlbar.h.

const QString& KURLBarItem::description   const [inline]
 

returns the description of this item.

See also:
setDescription

Definition at line 111 of file kurlbar.h.

virtual int KURLBarItem::height const QListBox *    const [virtual]
 

returns the height of this item.

const QString& KURLBarItem::icon   const [inline]
 

returns the icon of this item.

See also:
setIcon

Definition at line 116 of file kurlbar.h.

KIcon::Group KURLBarItem::iconGroup   const [inline]
 

returns the icon-group of this item (determines icon-effects).

See also:
setIcon

Definition at line 126 of file kurlbar.h.

References KIcon::Group.

virtual const QPixmap* KURLBarItem::pixmap   const [inline, virtual]
 

returns the pixmap of this item.

Definition at line 130 of file kurlbar.h.

void KURLBarItem::setApplicationLocal bool    local [inline]
 

Makes this item a local or global one.

See also:
applicationLocal

Definition at line 136 of file kurlbar.h.

void KURLBarItem::setDescription const QString &    desc
 

Sets the description of this item that will be shown as item-text.

See also:
description

void KURLBarItem::setIcon const QString &    icon,
KIcon::Group    group = KIcon::Panel
 

sets the icon for this item. See KIconLoader for a description of the icon groups.

See also:
icon

void KURLBarItem::setToolTip const QString &    tip
 

Sets a tooltip to be used for this item.

See also:
tooolTip

void KURLBarItem::setURL const KURL   url
 

Sets url for this item. Also updates the visible text to the filename/directory of the url, if no description is set.

See also:
url

QSize KURLBarItem::sizeHint  
 

returns the preferred size of this item

Since:
3.1

QString KURLBarItem::toolTip  
 

returns the tooltip of this item.

See also:
setToolTip

const KURL& KURLBarItem::url   const [inline]
 

returns the url of this item.

See also:
setURL

Definition at line 106 of file kurlbar.h.

virtual int KURLBarItem::width const QListBox *    const [virtual]
 

returns the width of this item.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:27 2003 for kdelibs by doxygen1.2.18