kio Library API Documentation

KURLBarItemDialog Class Reference

A dialog that allows editing entries of a KURLBar ( KURLBarItem). More...

#include <kurlbar.h>

Inheritance diagram for KURLBarItemDialog:

Inheritance graph
[legend]
Collaboration diagram for KURLBarItemDialog:

Collaboration graph
[legend]
List of all members.

Public Slots

void urlChanged (const QString &)

Public Member Functions

 KURLBarItemDialog (bool allowGlobal, const KURL &url, const QString &description, QString icon, bool appLocal=true, int iconSize=KIcon::SizeMedium, QWidget *parent=0, const char *name=0)
 ~KURLBarItemDialog ()
KURL url () const
QString description () const
QString icon () const
bool applicationLocal () const

Static Public Member Functions

bool getInformation (bool allowGlobal, KURL &url, QString &description, QString &icon, bool &appLocal, int iconSize, QWidget *parent=0)

Protected Attributes

KURLRequesterm_urlEdit
KLineEditm_edit
KIconButtonm_iconButton
QCheckBoxm_appLocal

Detailed Description

A dialog that allows editing entries of a KURLBar ( KURLBarItem).

The dialog offers to configure a given url, description and icon. See the class-method getInformation() for easy usage.

Author:
Carsten Pfeiffer <pfeiffer@kde.org>

Definition at line 567 of file kurlbar.h.


Constructor & Destructor Documentation

KURLBarItemDialog::KURLBarItemDialog bool  allowGlobal,
const KURL url,
const QString description,
QString  icon,
bool  appLocal = true,
int  iconSize = KIcon::SizeMedium,
QWidget parent = 0,
const char *  name = 0
 

Constructs a KURLBarItemDialog.

allowGlobal 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. url the url of the item description a short, translated description of the item icon an icon for the item appLocal tells whether the item should be local for this application or be available globally iconSize determines the size of the icon that is shown/selectable parent the parent-widget for the dialog

If you leave the icon empty, the default icon for the given url will be used (KMimeType::pixmapForURL()).

Definition at line 922 of file kurlbar.cpp.

References KInstance::aboutData(), KURL::fileName(), KMimeType::iconForURL(), KGlobal::instance(), KURLRequester::lineEdit(), m_appLocal, m_edit, m_iconButton, m_urlEdit, KURL::prettyURL(), KAboutData::programName(), KIconButton::setIcon(), KIconButton::setIconSize(), KDialogBase::setMainWidget(), KURLRequester::setMode(), KLineEdit::setText(), and KDialog::spacingHint().

Referenced by getInformation().

KURLBarItemDialog::~KURLBarItemDialog  ) 
 

Destroys the dialog.

Definition at line 993 of file kurlbar.cpp.


Member Function Documentation

bool KURLBarItemDialog::getInformation bool  allowGlobal,
KURL url,
QString description,
QString icon,
bool &  appLocal,
int  iconSize,
QWidget parent = 0
[static]
 

A convenience method to show 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.

See the KURLBarItem constructor for the parameter description.

Definition at line 898 of file kurlbar.cpp.

References applicationLocal(), description(), icon(), KURLBarItemDialog(), and url().

Referenced by KURLBar::editItem(), and KURLBar::slotDropped().

KURL KURLBarItemDialog::url  )  const
 

Returns:
the configured url

Definition at line 1002 of file kurlbar.cpp.

References m_urlEdit, KURL::setPath(), and KURLRequester::url.

Referenced by getInformation().

QString KURLBarItemDialog::description  )  const
 

Returns:
the configured description

Definition at line 1014 of file kurlbar.cpp.

References m_edit.

Referenced by getInformation().

QString KURLBarItemDialog::icon  )  const
 

Returns:
the configured icon

Definition at line 1019 of file kurlbar.cpp.

References KIconButton::icon, and m_iconButton.

Referenced by getInformation().

bool KURLBarItemDialog::applicationLocal  )  const
 

Returns:
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.

Definition at line 1024 of file kurlbar.cpp.

References m_appLocal.

Referenced by getInformation().


Member Data Documentation

KURLRequester* KURLBarItemDialog::m_urlEdit [protected]
 

The KURLRequester used for editing the url.

Definition at line 637 of file kurlbar.h.

Referenced by KURLBarItemDialog(), and url().

KLineEdit* KURLBarItemDialog::m_edit [protected]
 

The KLineEdit used for editing the description.

Definition at line 641 of file kurlbar.h.

Referenced by description(), and KURLBarItemDialog().

KIconButton* KURLBarItemDialog::m_iconButton [protected]
 

The KIconButton to configure the icon.

Definition at line 645 of file kurlbar.h.

Referenced by icon(), and KURLBarItemDialog().

QCheckBox* KURLBarItemDialog::m_appLocal [protected]
 

The QCheckBox to modify the local/global setting.

Definition at line 649 of file kurlbar.h.

Referenced by applicationLocal(), and KURLBarItemDialog().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kio Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 7 22:09:08 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003