.TH "KURLBarItemDialog" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KURLBarItemDialog \- A dialog that allows editing entries of a \fBKURLBar\fP (\fBKURLBarItem\fP).  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kurlbar.h>\fP
.PP
Inherits \fBKDialogBase\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBurlChanged\fP (const  \fBQString\fP &)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKURLBarItemDialog\fP (bool allowGlobal, const  \fBKURL\fP &url, const  \fBQString\fP &description, \fBQString\fP icon, bool appLocal=true, int iconSize=\fBKIcon::SizeMedium\fP, \fBQWidget\fP *parent=0, const  char *name=0)"
.br
.RI "\fIConstructs a KURLBarItemDialog. \fP"
.ti -1c
.RI "\fB~KURLBarItemDialog\fP ()"
.br
.RI "\fIDestroys the dialog. \fP"
.ti -1c
.RI "\fBKURL\fP \fBurl\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBdescription\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBicon\fP () const "
.br
.ti -1c
.RI "bool \fBapplicationLocal\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "bool \fBgetInformation\fP (bool allowGlobal, \fBKURL\fP &url, \fBQString\fP &description, \fBQString\fP &icon, bool &appLocal, int iconSize, \fBQWidget\fP *parent=0)"
.br
.RI "\fIA convenience method to show up the dialog and retrieve all the properties via the given parameters. \fP"
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBKURLRequester\fP * \fBm_urlEdit\fP"
.br
.RI "\fIThe \fBKURLRequester\fP used for editing the url. \fP"
.ti -1c
.RI "\fBKLineEdit\fP * \fBm_edit\fP"
.br
.RI "\fIThe \fBKLineEdit\fP used for editing the description. \fP"
.ti -1c
.RI "\fBKIconButton\fP * \fBm_iconButton\fP"
.br
.RI "\fIThe \fBKIconButton\fP to configure the icon. \fP"
.ti -1c
.RI "\fBQCheckBox\fP * \fBm_appLocal\fP"
.br
.RI "\fIThe \fBQCheckBox\fP to modify the local/global setting. \fP"
.in -1c
.SH "Detailed Description"
.PP 
A dialog that allows editing entries of a \fBKURLBar\fP (\fBKURLBarItem\fP). 

The dialog offers to configure a given url, description and icon. See the class-method \fBgetInformation\fP() for easy usage.
.PP
\fBAuthor:\fP
.RS 4
Carsten Pfeiffer <pfeiffer@kde.org> 
.RE
.PP

.PP
Definition at line 523 of file kurlbar.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KURLBarItemDialog::KURLBarItemDialog (bool allowGlobal, const \fBKURL\fP & url, const \fBQString\fP & description, \fBQString\fP icon, bool appLocal = true, int iconSize = \fBKIcon::SizeMedium\fP, \fBQWidget\fP * parent = 0, const char * name = 0)"
.PP
Constructs a KURLBarItemDialog. \fCallowGlobal\fP if you set this to true, the dialog will have a checkbox for the user to decide if he wants the entry to be available globally or just for the current application. \fCurl\fP the url of the item \fCdescription\fP a short, translated description of the item \fCicon\fP an icon for the item \fCappLocal\fP tells whether the item should be local for this application or available globalle \fCiconSize\fP determines the size of the icon that is shown/selectable \fCparent\fP the parent-widget for the dialog
.PP
If you leave the icon empty, the default icon for the given url will be used (\fBKMimeType::pixmapForURL()\fP). Definition at line 793 of file kurlbar.cpp.
.PP
References KInstance::aboutData(), QWhatsThis::add(), QString::arg(), KStdAccel::description(), KURL::fileName(), QString::fromLatin1(), QDir::homeDirPath(), KMimeType::iconForURL(), KGlobal::instance(), QString::isEmpty(), KStdAccel::label(), KURLRequester::lineEdit(), m_appLocal, m_edit, m_iconButton, m_urlEdit, KStdAccel::name(), KURL::prettyURL(), KAboutData::programName(), QCheckBox::setChecked(), KIconButton::setIcon(), KIconButton::setIconSize(), KDialogBase::setMainWidget(), KURLRequester::setMode(), QGrid::setSpacing(), KIconButton::setStrictIconSize(), QLineEdit::setText(), and KDialog::spacingHint().
.PP
Referenced by getInformation().
.SS "KURLBarItemDialog::~\fBKURLBarItemDialog\fP ()"
.PP
Destroys the dialog. Definition at line 865 of file kurlbar.cpp.
.SH "Member Function Documentation"
.PP 
.SS "bool KURLBarItemDialog::getInformation (bool allowGlobal, \fBKURL\fP & url, \fBQString\fP & description, \fBQString\fP & icon, bool & appLocal, int iconSize, \fBQWidget\fP * parent = 0)\fC [static]\fP"
.PP
A convenience method to show up the dialog and retrieve all the properties via the given parameters. The parameters are used to initialize the dialog and then return the user-configured values.
.PP
See the \fBKURLBarItem\fP constructor for the parameter description. Definition at line 769 of file kurlbar.cpp.
.PP
References applicationLocal(), description(), KStdAccel::description(), QDialog::exec(), icon(), KURLBarItemDialog(), and url().
.PP
Referenced by KURLBar::editItem(), and KURLBar::slotDropped().
.SS "\fBKURL\fP KURLBarItemDialog::url () const"
.PP
\fBReturns:\fP
.RS 4
the configured url 
.RE
.PP
Definition at line 874 of file kurlbar.cpp.
.PP
References QString::at(), m_urlEdit, KURL::setPath(), and KURLRequester::url().
.PP
Referenced by getInformation().
.SS "\fBQString\fP KURLBarItemDialog::description () const"
.PP
\fBReturns:\fP
.RS 4
the configured description 
.RE
.PP
Definition at line 886 of file kurlbar.cpp.
.PP
References m_edit, and QLineEdit::text().
.PP
Referenced by getInformation().
.SS "\fBQString\fP KURLBarItemDialog::icon () const"
.PP
\fBReturns:\fP
.RS 4
the configured icon 
.RE
.PP
Definition at line 891 of file kurlbar.cpp.
.PP
References KIconButton::icon(), and m_iconButton.
.PP
Referenced by getInformation().
.SS "bool KURLBarItemDialog::applicationLocal () const"
.PP
\fBReturns:\fP
.RS 4
whether the item should be local to the application or global. if allowGlobal was set to false in the constructor, this will always return true. 
.RE
.PP
Definition at line 896 of file kurlbar.cpp.
.PP
References QCheckBox::isChecked(), and m_appLocal.
.PP
Referenced by getInformation().
.SH "Member Data Documentation"
.PP 
.SS "\fBKURLRequester\fP* \fBKURLBarItemDialog::m_urlEdit\fP\fC [protected]\fP"
.PP
The \fBKURLRequester\fP used for editing the url. Definition at line 593 of file kurlbar.h.
.PP
Referenced by KURLBarItemDialog(), and url().
.SS "\fBKLineEdit\fP* \fBKURLBarItemDialog::m_edit\fP\fC [protected]\fP"
.PP
The \fBKLineEdit\fP used for editing the description. Definition at line 597 of file kurlbar.h.
.PP
Referenced by description(), and KURLBarItemDialog().
.SS "\fBKIconButton\fP* \fBKURLBarItemDialog::m_iconButton\fP\fC [protected]\fP"
.PP
The \fBKIconButton\fP to configure the icon. Definition at line 601 of file kurlbar.h.
.PP
Referenced by icon(), and KURLBarItemDialog().
.SS "\fBQCheckBox\fP* \fBKURLBarItemDialog::m_appLocal\fP\fC [protected]\fP"
.PP
The \fBQCheckBox\fP to modify the local/global setting. Definition at line 605 of file kurlbar.h.
.PP
Referenced by applicationLocal(), and KURLBarItemDialog().

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