.TH "KURLBarItem" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KURLBarItem \- An item to be used in \fBKURLBar\fP / \fBKURLBarListBox\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kurlbar.h>\fP
.PP
Inherits \fBQListBoxPixmap\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKURLBarItem\fP (\fBKURLBar\fP *parent, const \fBKURL\fP &url, bool persistent, const \fBQString\fP &description=QString::null, const \fBQString\fP &icon=QString::null, \fBKIcon::Group\fP group=\fBKIcon::Panel\fP)"
.br
.ti -1c
.RI "\fBKURLBarItem\fP (\fBKURLBar\fP *parent, const \fBKURL\fP &url, const \fBQString\fP &description=QString::null, const \fBQString\fP &icon=QString::null, \fBKIcon::Group\fP group=\fBKIcon::Panel\fP)"
.br
.ti -1c
.RI "\fB~KURLBarItem\fP ()"
.br
.ti -1c
.RI "void \fBsetURL\fP (const \fBKURL\fP &url)"
.br
.ti -1c
.RI "void \fBsetIcon\fP (const \fBQString\fP &icon, \fBKIcon::Group\fP group=\fBKIcon::Panel\fP)"
.br
.ti -1c
.RI "void \fBsetDescription\fP (const \fBQString\fP &desc)"
.br
.ti -1c
.RI "void \fBsetToolTip\fP (const \fBQString\fP &tip)"
.br
.ti -1c
.RI "\fBQSize\fP \fBsizeHint\fP () const "
.br
.ti -1c
.RI "virtual int \fBwidth\fP (const \fBQListBox\fP *) const "
.br
.ti -1c
.RI "virtual int \fBheight\fP (const \fBQListBox\fP *) const "
.br
.ti -1c
.RI "const \fBKURL\fP & \fBurl\fP () const "
.br
.ti -1c
.RI "const \fBQString\fP & \fBdescription\fP () const "
.br
.ti -1c
.RI "const \fBQString\fP & \fBicon\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBtoolTip\fP () const "
.br
.ti -1c
.RI "\fBKIcon::Group\fP \fBiconGroup\fP () const "
.br
.ti -1c
.RI "virtual const \fBQPixmap\fP * \fBpixmap\fP () const "
.br
.ti -1c
.RI "void \fBsetApplicationLocal\fP (bool local)"
.br
.ti -1c
.RI "bool \fBapplicationLocal\fP () const "
.br
.ti -1c
.RI "bool \fBisPersistent\fP () const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBpaint\fP (\fBQPainter\fP *p)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
An item to be used in \fBKURLBar\fP / \fBKURLBarListBox\fP. 

All the properties (url, icon, description, tooltip) can be changed dynamically.
.PP
\fBAuthor:\fP
.RS 4
Carsten Pfeiffer <pfeiffer@kde.org> 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBKURLBar\fP 
.PP
\fBKURLBarListBox\fP 
.RE
.PP

.PP
Definition at line 42 of file kurlbar.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KURLBarItem::KURLBarItem (\fBKURLBar\fP * parent, const \fBKURL\fP & url, bool persistent, const \fBQString\fP & description = \fCQString::null\fP, const \fBQString\fP & icon = \fCQString::null\fP, \fBKIcon::Group\fP group = \fC\fBKIcon::Panel\fP\fP)"
.PP
Creates a KURLBarItem to be used in the \fCparent\fP \fBKURLBar\fP. 
.PP
You need to insert the item into the listbox manually, if you don't use \fBKURLBar::insertItem()\fP.
.PP
If description is empty, it will try to use the filename/directory of \fCurl\fP, which will be shown as text of the item. \fCurl\fP will be used as tooltip, unless you set a different tip with \fBsetToolTip()\fP. \fCpersistent\fP specifies whether this item is a persistent item or a dynamic item, that is not saved with \fBKURLBar::writeConfig()\fP. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 88 of file kurlbar.cpp.
.PP
References description(), icon(), and url().
.SS "KURLBarItem::KURLBarItem (\fBKURLBar\fP * parent, const \fBKURL\fP & url, const \fBQString\fP & description = \fCQString::null\fP, const \fBQString\fP & icon = \fCQString::null\fP, \fBKIcon::Group\fP group = \fC\fBKIcon::Panel\fP\fP)"
.PP
Creates a persistent KURLBarItem to be used in the \fCparent\fP \fBKURLBar\fP. 
.PP
You need to insert the item into the listbox manually, if you don't use \fBKURLBar::insertItem()\fP.
.PP
If description is empty, it will try to use the filename/directory of \fCurl\fP, which will be shown as text of the item. \fCurl\fP will be used as tooltip, unless you set a different tip with \fBsetToolTip()\fP. \fCpersistent\fP specifies whether this item is a persistent item or a dynamic item, that is not saved with \fBKURLBar::writeConfig()\fP. 
.PP
Definition at line 100 of file kurlbar.cpp.
.PP
References description(), and icon().
.SS "KURLBarItem::~\fBKURLBarItem\fP ()"
.PP
Destroys the item. 
.PP
Definition at line 123 of file kurlbar.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KURLBarItem::setURL (const \fBKURL\fP & url)"
.PP
Sets \fCurl\fP for this item. 
.PP
Also updates the visible text to the filename/directory of the url, if no description is set. 
.PP
\fBSee also:\fP
.RS 4
\fBurl\fP 
.RE
.PP

.PP
Definition at line 128 of file kurlbar.cpp.
.PP
References KURL::fileName(), QString::isEmpty(), and url().
.SS "void KURLBarItem::setIcon (const \fBQString\fP & icon, \fBKIcon::Group\fP group = \fC\fBKIcon::Panel\fP\fP)"
.PP
\fCsets\fP the icon for this item. 
.PP
See \fBKIconLoader\fP for a description of the icon groups. 
.PP
\fBSee also:\fP
.RS 4
\fBicon\fP 
.RE
.PP

.PP
Definition at line 135 of file kurlbar.cpp.
.PP
References icon(), KGlobal::iconLoader(), QString::isEmpty(), KIconLoader::loadIcon(), and KMimeType::pixmapForURL().
.PP
Referenced by KURLBar::setIconSize().
.SS "void KURLBarItem::setDescription (const \fBQString\fP & desc)"
.PP
Sets the description of this item that will be shown as item-text. 
.PP
\fBSee also:\fP
.RS 4
\fBdescription\fP 
.RE
.PP

.PP
Definition at line 147 of file kurlbar.cpp.
.PP
References KURL::fileName().
.SS "void KURLBarItem::setToolTip (const \fBQString\fP & tip)"
.PP
Sets a tooltip to be used for this item. 
.PP
\fBSee also:\fP
.RS 4
\fBtoolTip\fP 
.RE
.PP

.PP
Definition at line 164 of file kurlbar.cpp.
.SS "\fBQSize\fP KURLBarItem::sizeHint () const"
.PP
returns the preferred size of this item 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 269 of file kurlbar.cpp.
.PP
References QPixmap::height(), QListBoxPixmap::height(), KURLBar::iconSize(), KURLBarListBox::isVertical(), pixmap(), KDialog::spacingHint(), QPixmap::width(), and QListBoxPixmap::width().
.PP
Referenced by height(), KURLBar::sizeHint(), and width().
.SS "int KURLBarItem::width (const \fBQListBox\fP *) const\fC [virtual]\fP"
.PP
returns the width of this item. 
.PP
Reimplemented from \fBQListBoxPixmap\fP.
.PP
Definition at line 292 of file kurlbar.cpp.
.PP
References sizeHint(), and QSize::width().
.SS "int KURLBarItem::height (const \fBQListBox\fP *) const\fC [virtual]\fP"
.PP
returns the height of this item. 
.PP
Reimplemented from \fBQListBoxPixmap\fP.
.PP
Definition at line 300 of file kurlbar.cpp.
.PP
References QSize::height(), and sizeHint().
.SS "const \fBKURL\fP& KURLBarItem::url () const\fC [inline]\fP"
.PP
returns the url of this item. 
.PP
\fBSee also:\fP
.RS 4
\fBsetURL\fP 
.RE
.PP

.PP
Definition at line 127 of file kurlbar.h.
.PP
Referenced by KURLBar::currentURL(), KURLBarListBox::dragObject(), KURLBar::editItem(), KURLBarItem(), KURLBar::setCurrentItem(), setURL(), KURLBar::slotContextMenuRequested(), KURLBar::slotSelected(), and KFileDialog::toggleSpeedbar().
.SS "const \fBQString\fP& KURLBarItem::description () const\fC [inline]\fP"
.PP
returns the description of this item. 
.PP
\fBSee also:\fP
.RS 4
\fBsetDescription\fP 
.RE
.PP

.PP
Definition at line 132 of file kurlbar.h.
.PP
Referenced by KURLBarItem().
.SS "const \fBQString\fP& KURLBarItem::icon () const\fC [inline]\fP"
.PP
returns the icon of this item. 
.PP
\fBSee also:\fP
.RS 4
\fBsetIcon\fP 
.RE
.PP

.PP
Definition at line 137 of file kurlbar.h.
.PP
Referenced by KURLBarItem(), setIcon(), and KURLBar::setIconSize().
.SS "\fBQString\fP KURLBarItem::toolTip () const"
.PP
returns the tooltip of this item. 
.PP
\fBSee also:\fP
.RS 4
\fBsetToolTip\fP 
.RE
.PP

.PP
Definition at line 169 of file kurlbar.cpp.
.PP
References QString::isEmpty(), and KURL::prettyURL().
.SS "\fBKIcon::Group\fP KURLBarItem::iconGroup () const\fC [inline]\fP"
.PP
returns the icon-group of this item (determines icon-effects). 
.PP
\fBSee also:\fP
.RS 4
\fBsetIcon\fP 
.RE
.PP

.PP
Definition at line 147 of file kurlbar.h.
.PP
Referenced by KURLBar::setIconSize().
.SS "virtual const \fBQPixmap\fP* KURLBarItem::pixmap () const\fC [inline, virtual]\fP"
.PP
returns the pixmap of this item. 
.PP
Reimplemented from \fBQListBoxPixmap\fP.
.PP
Definition at line 151 of file kurlbar.h.
.PP
Referenced by sizeHint().
.SS "void KURLBarItem::setApplicationLocal (bool local)"
.PP
Makes this item a local or global one. 
.PP
This has only an effect on persistent items of course. 
.PP
\fBSee also:\fP
.RS 4
\fBisPersistent\fP 
.PP
\fBapplicationLocal\fP 
.RE
.PP

.PP
Definition at line 153 of file kurlbar.cpp.
.PP
References endl(), isPersistent(), and kdWarning().
.PP
Referenced by KURLBar::insertItem().
.SS "bool KURLBarItem::applicationLocal () const\fC [inline]\fP"
.PP
returns whether this is a global item or a local one. 
.PP
\fBKURLBar\fP can differentiate between global and local items (only for the current application) for easy extensiblity. 
.PP
\fBSee also:\fP
.RS 4
\fBsetApplicationLocal\fP 
.RE
.PP

.PP
Definition at line 167 of file kurlbar.h.
.PP
Referenced by KURLBar::writeConfig().
.SS "bool KURLBarItem::isPersistent () const"
.PP
returns whether this item is persistent (via \fBKURLBar::writeConfig()\fP and \fBKURLBar::readConfig()\fP) or not. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 308 of file kurlbar.cpp.
.PP
Referenced by setApplicationLocal(), KURLBar::slotContextMenuRequested(), and KURLBar::writeConfig().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
