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

KURLBarItemDialog Class Reference

#include <kurlbar.h>

Inheritance diagram for KURLBarItemDialog:

KDialogBase KDialog List of all members.

Public Methods

 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 Methods

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
QCheckBox * m_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 523 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 available globalle 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()).

KURLBarItemDialog::~KURLBarItemDialog  
 

Destroys the dialog.


Member Function Documentation

bool KURLBarItemDialog::applicationLocal  
 

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.

QString KURLBarItemDialog::description  
 

Returns:
the configured description

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

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.

See the KURLBarItem constructor for the parameter description.

QString KURLBarItemDialog::icon  
 

Returns:
the configured icon

KURL KURLBarItemDialog::url  
 

Returns:
the configured url


Member Data Documentation

QCheckBox* KURLBarItemDialog::m_appLocal [protected]
 

The QCheckBox to modify the local/global setting

Definition at line 605 of file kurlbar.h.

KLineEdit* KURLBarItemDialog::m_edit [protected]
 

The KLineEdit used for editing the description

Definition at line 597 of file kurlbar.h.

KIconButton* KURLBarItemDialog::m_iconButton [protected]
 

The KIconButton to configure the icon

Definition at line 601 of file kurlbar.h.

KURLRequester* KURLBarItemDialog::m_urlEdit [protected]
 

The KURLRequester used for editing the url

Definition at line 593 of file kurlbar.h.


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