KURLBar Class Reference
#include <kurlbar.h>
Inheritance diagram for KURLBar:

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 cause the activated() signal to be 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 230 of file kurlbar.h.
Public Slots | |
virtual void | setCurrentItem (const KURL &url) |
Signals | |
void | activated (const KURL &url) |
Public Member Functions | |
KURLBar (bool useGlobalItems, QWidget *parent=0, const char *name=0, WFlags f=0) | |
~KURLBar () | |
virtual KURLBarItem * | insertItem (const KURL &url, const QString &description, bool applicationLocal=true, const QString &icon=QString::null, KIcon::Group group=KIcon::Panel) |
virtual KURLBarItem * | insertDynamicItem (const KURL &url, const QString &description, const QString &icon=QString::null, KIcon::Group group=KIcon::Panel) |
virtual void | setOrientation (Qt::Orientation orient) |
Orientation | orientation () const |
virtual void | setListBox (KURLBarListBox *) |
KURLBarListBox * | listBox () const |
virtual void | setIconSize (int size) |
int | iconSize () const |
virtual void | clear () |
virtual QSize | sizeHint () const |
virtual QSize | minimumSizeHint () const |
virtual void | readConfig (KConfig *config, const QString &itemGroup) |
virtual void | writeConfig (KConfig *config, const QString &itemGroup) |
virtual void | readItem (int i, KConfig *config, bool applicationLocal) |
virtual void | writeItem (KURLBarItem *item, int i, KConfig *, bool global) |
KURLBarItem * | currentItem () const |
KURL | currentURL () const |
bool | isModified () const |
bool | isImmutable () const |
bool | isVertical () const |
Protected Slots | |
virtual void | slotContextMenuRequested (QListBoxItem *, const QPoint &pos) |
virtual void | slotSelected (QListBoxItem *) |
virtual void | slotDropped (QDropEvent *) |
Protected Member Functions | |
virtual bool | addNewItem () |
virtual bool | editItem (KURLBarItem *item) |
virtual void | resizeEvent (QResizeEvent *) |
virtual void | paletteChange (const QPalette &) |
virtual void | virtual_hook (int id, void *data) |
Protected Attributes | |
KURLBarItem * | m_activeItem |
bool | m_useGlobal:1 |
bool | m_isModified:1 |
bool | m_isImmutable:1 |
Constructor & Destructor Documentation
|
Constructs a KURLBar.
Set Definition at line 330 of file kurlbar.cpp. |
|
Destroys the KURLBar.
Definition at line 353 of file kurlbar.cpp. |
Member Function Documentation
|
This signal is emitted when the user activated an item, e.g. , by clicking on it. |
|
Pops up a KURLBarItemDialog to let the user add a new item. Uses editItem() to do the job.
Definition at line 773 of file kurlbar.cpp. |
|
Clears the view, removes all items.
Definition at line 440 of file kurlbar.cpp. |
|
Definition at line 564 of file kurlbar.cpp. |
|
Definition at line 572 of file kurlbar.cpp. |
|
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 786 of file kurlbar.cpp. |
|
|
|
Inserts a new dynamic item into the KURLBar and returns the created KURLBarItem.
Definition at line 368 of file kurlbar.cpp. |
|
Inserts a new item into the KURLBar and returns the created KURLBarItem.
Definition at line 358 of file kurlbar.cpp. |
|
|
|
|
|
|
|
|
|
Definition at line 509 of file kurlbar.cpp. |
|
Definition at line 387 of file kurlbar.cpp. |
|
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 578 of file kurlbar.cpp. |
|
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 601 of file kurlbar.cpp. |
|
Makes the item with the url Does nothing if no item with that url is available.
Definition at line 536 of file kurlbar.cpp. |
|
Sets the default iconsize to be used for items inserted with insertItem. By default KIcon::SizeMedium.
Definition at line 422 of file kurlbar.cpp. |
|
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 392 of file kurlbar.cpp. |
|
The items can be arranged either vertically in one column or horizontally in one row.
Definition at line 376 of file kurlbar.cpp. |
|
Definition at line 467 of file kurlbar.cpp. |
|
Reimplemented to show a contextmenu, allowing the user to add, edit or remove items, or change the iconsize.
Definition at line 713 of file kurlbar.cpp. |
|
Called when a url was dropped onto the bar to show a KURLBarItemDialog.
Definition at line 695 of file kurlbar.cpp. |
|
Called when an item has been selected. Emits the activated() signal. Definition at line 525 of file kurlbar.cpp. |
|
Call this method to save the current configuration into The writeItem() method is used to save each item. Definition at line 616 of file kurlbar.cpp. |
|
Called from writeConfig() to save the KURLBarItem
Definition at line 675 of file kurlbar.cpp. |
Member Data Documentation
|
The currently active item.
|
|
Whether the urlbar may be modified by the user. If immutable is true, the urlbar can not be modified. |
|
Whether the urlbar was modified by the user (e.g. by editing/adding/removing an item). |
|
Whether we support global entries or just local ones.
|
The documentation for this class was generated from the following files: