KURLBar Class Reference
KURLBar is a widget that displays icons together with a description. A URL-bar widget, as used in the KFileDialog. More...
#include <kurlbar.h>
Inheritance diagram for KURLBar:

Public Slots | |
virtual void | setCurrentItem (const KURL &url) |
Makes the item with the url url the current item. | |
Signals | |
void | activated (const KURL &url) |
This signal is emitted when the user activated an item, e.g by clicking on it. | |
Public Member Functions | |
KURLBar (bool useGlobalItems, QWidget *parent=0, const char *name=0, WFlags f=0) | |
Constructs a KURLBar. | |
~KURLBar () | |
Destroys the KURLBar. | |
virtual KURLBarItem * | insertItem (const KURL &url, const QString &description, bool applicationLocal=true, const QString &icon=QString::null, KIcon::Group group=KIcon::Panel) |
Inserts a new item into the KURLBar and returns the created KURLBarItem. | |
virtual void | setOrientation (Qt::Orientation orient) |
The items can be arranged either vertically in one column or horizontally in one row. | |
Orientation | orientation () const |
virtual void | setListBox (KURLBarListBox *) |
Allows to set a custom KURLBarListBox. | |
KURLBarListBox * | listBox () const |
virtual void | setIconSize (int size) |
Sets the default iconsize to be used for items inserted with insertItem. | |
int | iconSize () const |
virtual void | clear () |
Clears the view, removes all items. | |
virtual QSize | sizeHint () const |
virtual QSize | minimumSizeHint () const |
| |
virtual void | readConfig (KConfig *config, const QString &itemGroup) |
Call this method to read a saved configuration from config , inside the group itemGroup . | |
virtual void | writeConfig (KConfig *config, const QString &itemGroup) |
Call this method to save the current configuration into config , inside the group iconGroup . | |
virtual void | readItem (int i, KConfig *config, bool applicationLocal) |
Called from readConfig() to read the i'th from config . | |
virtual void | writeItem (KURLBarItem *item, int i, KConfig *, bool global) |
Called from writeConfig() to save the KURLBarItem item as the i'th entry in the config-object. | |
KURLBarItem * | currentItem () const |
KURL | currentURL () const |
bool | isModified () const |
bool | isImmutable () const |
bool | isVertical () const |
Protected Slots | |
virtual void | slotContextMenuRequested (QListBoxItem *, const QPoint &pos) |
Reimplemented to show a contextmenu, allowing the user to add, edit or remove items, or change the iconsize. | |
virtual void | slotSelected (QListBoxItem *) |
Called when an item has been selected. | |
virtual void | slotDropped (QDropEvent *) |
Called when a url was dropped onto the bar to show a KURLBarItemDialog. | |
Protected Member Functions | |
virtual bool | addNewItem () |
Pops up a KURLBarItemDialog to let the user add a new item. | |
virtual bool | editItem (KURLBarItem *item) |
Pops up a KURLBarItemDialog to let the user edit the properties of item . | |
virtual void | resizeEvent (QResizeEvent *) |
| |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
KURLBarItem * | m_activeItem |
The currently active item. | |
bool | m_useGlobal:1 |
Whether we support global entries or just local ones. | |
bool | m_isModified:1 |
Whether the urlbar was modified by the user (e.g. | |
bool | m_isImmutable:1 |
Whether the urlbar may be modified by the user. |
Detailed Description
KURLBar is a widget that displays icons together with a description. A URL-bar widget, as used in the KFileDialog.They can be arranged either horizontally or vertically. Clicking on an item will make the activated() signal being emitted. The user can edit existing items by choosing "Edit entry" in the contextmenu. He can also remove or add new entries (via drag&drop or the context menu).
KURLBar offers the methods readConfig() and writeConfig() to read and write the configuration of all the entries. It can differentiate between global and local entries -- global entries will be saved in the global configuration (kdeglobals), while local entries will be saved in your application's KConfig object.
Due to the configurability, you usually only insert some default entries once and then solely use the read and writeConfig methods to preserve the user's configuration.
The widget has a "current" item, that is visualized to differentiate it from others.
- Author:
- Carsten Pfeiffer <pfeiffer@kde.org>
Definition at line 198 of file kurlbar.h.
Constructor & Destructor Documentation
|
Constructs a KURLBar.
Set Definition at line 239 of file kurlbar.cpp. References QWhatsThis::add(), isVertical(), m_activeItem, m_isImmutable, m_isModified, m_useGlobal, KStdAccel::name(), and setListBox(). |
|
Destroys the KURLBar.
Definition at line 262 of file kurlbar.cpp. |
Member Function Documentation
|
Inserts a new item into the KURLBar and returns the created KURLBarItem.
Definition at line 267 of file kurlbar.cpp. References KStdAccel::description(), QListBox::insertItem(), and KURLBarItem::setApplicationLocal(). Referenced by readItem(), and slotDropped(). |
|
The items can be arranged either vertically in one column or horizontally in one row.
Definition at line 277 of file kurlbar.cpp. References isVertical(), and KURLBarListBox::setOrientation(). Referenced by setListBox(). |
|
Definition at line 288 of file kurlbar.cpp. References KURLBarListBox::orientation(). Referenced by isVertical(). |
|
Allows to set a custom KURLBarListBox. Note: The previous listbox will be deleted. Items of the previous listbox will not be moved to the new box.
Definition at line 293 of file kurlbar.cpp. References QPalette::color(), QPalette::setColor(), setOrientation(), QListBox::setSelectionMode(), slotContextMenuRequested(), slotDropped(), and slotSelected(). Referenced by KURLBar(). |
|
|
|
Sets the default iconsize to be used for items inserted with insertItem. By default KIcon::SizeMedium.
Definition at line 329 of file kurlbar.cpp. References QListBox::firstItem(), KURLBarItem::icon(), KURLBarItem::iconGroup(), KURLBarItem::setIcon(), and sizeHint(). Referenced by slotContextMenuRequested(). |
|
Definition at line 265 of file kurlbar.h. Referenced by KURLBarItem::sizeHint(). |
|
Clears the view, removes all items.
Definition at line 347 of file kurlbar.cpp. References QListBox::clear(). |
|
Definition at line 358 of file kurlbar.cpp. References QListBox::firstItem(), QSize::height(), isVertical(), KURLBarItem::sizeHint(), and QSize::width(). Referenced by minimumSizeHint(), and setIconSize(). |
|
Definition at line 400 of file kurlbar.cpp. References QSize::height(), sizeHint(), and QSize::width(). |
|
Call this method to read a saved configuration from All items in there will be restored. The reading of every item is delegated to the readItem() method. Definition at line 469 of file kurlbar.cpp. References KGlobal::config(), KConfigBase::groupIsImmutable(), m_isImmutable, m_useGlobal, readItem(), and KConfigBase::readNumEntry(). |
|
Call this method to save the current configuration into The writeItem() method is used to save each item. Definition at line 527 of file kurlbar.cpp. References KURLBarItem::applicationLocal(), QListBox::firstItem(), m_isModified, m_useGlobal, KConfigBase::setGroup(), KConfigBase::writeEntry(), and writeItem(). |
|
Called from readConfig() to read the i'th from
After reading a KURLBarItem is created and initialized with the read values (as well as the given Definition at line 512 of file kurlbar.cpp. References insertItem(), KProtocolInfo::isKnownProtocol(), KURL::isMalformed(), QString::number(), KIO::number(), KConfigBase::readEntry(), and KConfigBase::readNumEntry(). Referenced by readConfig(). |
|
Called from writeConfig() to save the KURLBarItem
Definition at line 573 of file kurlbar.cpp. References KURLBarItem::description(), KURLBarItem::icon(), KURLBarItem::iconGroup(), KURL::isLocalFile(), QString::number(), KIO::number(), KURL::path(), KURL::prettyURL(), KURLBarItem::url(), KConfigBase::writeEntry(), and KConfigBase::writePathEntry(). Referenced by writeConfig(). |
|
Definition at line 455 of file kurlbar.cpp. References QListBox::currentItem(), and QListBox::item(). Referenced by currentURL(). |
|
Definition at line 463 of file kurlbar.cpp. References currentItem(), and KURLBarItem::url(). |
|
Definition at line 328 of file kurlbar.h. References m_isModified. |
|
Definition at line 333 of file kurlbar.h. References m_isImmutable. |
|
Definition at line 338 of file kurlbar.h. References orientation(). Referenced by KURLBar(), setOrientation(), and sizeHint(). |
|
Makes the item with the url Does nothing if no item with that url is available.
Definition at line 427 of file kurlbar.cpp. References QListBox::clearSelection(), QListBox::firstItem(), m_activeItem, QListBoxItem::next(), QListBox::setCurrentItem(), QListBox::setSelected(), KURLBarItem::url(), and KURL::url(). Referenced by slotContextMenuRequested(). |
|
This signal is emitted when the user activated an item, e.g by clicking on it.
Referenced by slotSelected(). |
|
Pops up a KURLBarItemDialog to let the user add a new item. Uses editItem() to do the job.
Definition at line 668 of file kurlbar.cpp. References editItem(), and QListBox::insertItem(). Referenced by slotContextMenuRequested(). |
|
Pops up a KURLBarItemDialog to let the user edit the properties of Invoked e.g. by addNewItem(), when the user drops a url onto the bar or from the contextmenu.
Definition at line 681 of file kurlbar.cpp. References KURLBarItem::applicationLocal(), KURLBarItem::description(), KStdAccel::description(), KURLBarItemDialog::getInformation(), KURLBarItem::icon(), m_isModified, m_useGlobal, KURLBarItem::setApplicationLocal(), KURLBarItem::setDescription(), KURLBarItem::setIcon(), KURLBarItem::setURL(), QListBox::triggerUpdate(), and KURLBarItem::url(). Referenced by addNewItem(), and slotContextMenuRequested(). |
|
Reimplemented from QFrame. Definition at line 352 of file kurlbar.cpp. References QFrame::resizeEvent(). |
|
Reimplemented to show a contextmenu, allowing the user to add, edit or remove items, or change the iconsize.
Definition at line 617 of file kurlbar.cpp. References addNewItem(), editItem(), QPopupMenu::exec(), QPopupMenu::insertItem(), QPopupMenu::insertSeparator(), m_activeItem, m_isImmutable, m_isModified, setCurrentItem(), setIconSize(), QPopupMenu::setItemEnabled(), KIcon::SizeMedium, KIcon::SizeSmall, QListBox::triggerUpdate(), and KURLBarItem::url(). Referenced by setListBox(). |
|
Called when an item has been selected. Emits the activated() signal. Definition at line 416 of file kurlbar.cpp. References activated(), m_activeItem, QListBox::setCurrentItem(), and KURLBarItem::url(). Referenced by setListBox(). |
|
Called when a url was dropped onto the bar to show a KURLBarItemDialog.
Definition at line 593 of file kurlbar.cpp. References QValueList< KURL >::begin(), KURLDrag::decode(), KStdAccel::description(), QValueList< KURL >::end(), KURLBarItemDialog::getInformation(), insertItem(), QValueList< KURL >::Iterator(), m_isModified, and m_useGlobal. Referenced by setListBox(). |
Member Data Documentation
|
The currently active item.
Definition at line 379 of file kurlbar.h. Referenced by KURLBar(), setCurrentItem(), slotContextMenuRequested(), and slotSelected(). |
|
Whether we support global entries or just local ones.
Definition at line 383 of file kurlbar.h. Referenced by editItem(), KURLBar(), readConfig(), slotDropped(), and writeConfig(). |
|
Whether the urlbar was modified by the user (e.g. by editing/adding/removing an item). Definition at line 389 of file kurlbar.h. Referenced by editItem(), isModified(), KURLBar(), slotContextMenuRequested(), slotDropped(), and writeConfig(). |
|
Whether the urlbar may be modified by the user. If immutable is true, the urlbar can not be modified. Definition at line 395 of file kurlbar.h. Referenced by isImmutable(), KURLBar(), readConfig(), and slotContextMenuRequested(). |
The documentation for this class was generated from the following files: