KToolBar Class Reference
A KDE-style toolbar. Floatable toolbar with auto resize. More...
#include <ktoolbar.h>
Inheritance diagram for KToolBar:


Public Types | |
| enum | IconText { IconOnly = 0, IconTextRight, TextOnly, IconTextBottom } |
| enum | BarStatus { Toggle, Show, Hide } |
| The state of the status bar. More... | |
| enum | BarPosition { Unmanaged, Floating, Top, Bottom, Right, Left, Flat } |
| Possible bar positions. More... | |
Public Slots | |
| virtual void | setIconText (const QString &txt) |
Signals | |
| void | clicked (int id) |
Emitted when button id is clicked. | |
| void | doubleClicked (int id) |
Emitted when button id is double-clicked. | |
| void | pressed (int) |
Emitted when button id is pressed. | |
| void | released (int) |
Emits when button id is released. | |
| void | toggled (int) |
| Emitted when a toggle button changes state. | |
| void | highlighted (int id, bool isHighlighted) |
| This signal is emitted when item id gets highlighted/unhighlighted (i.e when mouse enters/exits). | |
| void | highlighted (int id) |
| This signal is emitted when item id gets highlighted/unhighlighted (i.e when mouse enters/exits). | |
| void | moved (BarPosition) |
| Emitted when toolbar changes position, or when an item is removed from toolbar. | |
| void | modechange () |
| void | toolbarDestroyed () |
| This signal is emitted when the toolbar is getting deleted, and before ~KToolbar finishes (so it's still time to remove widgets from the toolbar). | |
Public Member Functions | |
| KToolBar (QWidget *parent, const char *name=0, bool honor_style=FALSE, bool readConfig=TRUE) | |
| Constructor. | |
| KToolBar (QMainWindow *parentWindow, QMainWindow::ToolBarDock dock, bool newLine=false, const char *name=0, bool honor_style=FALSE, bool readConfig=TRUE) | |
| Constructor for non-XML-GUI applications. | |
| KToolBar (QMainWindow *parentWindow, QWidget *dock, bool newLine=false, const char *name=0, bool honor_style=FALSE, bool readConfig=TRUE) | |
| Constructor for non-XML-GUI applications. | |
| int | insertButton (const QString &icon, int id, bool enabled=true, const QString &text=QString::null, int index=-1, KInstance *_instance=KGlobal::instance()) |
| Insert a button (a KToolBarButton) with a pixmap. | |
| int | insertButton (const QString &icon, int id, const char *signal, const QObject *receiver, const char *slot, bool enabled=true, const QString &text=QString::null, int index=-1, KInstance *_instance=KGlobal::instance()) |
| This is the same as above, but with specified signals and slots to which this button will be connected. | |
| int | insertButton (const QPixmap &pixmap, int id, bool enabled=true, const QString &text=QString::null, int index=-1) |
| Inserts a button (a KToolBarButton) with the specified pixmap. | |
| int | insertButton (const QPixmap &pixmap, int id, const char *signal, const QObject *receiver, const char *slot, bool enabled=true, const QString &text=QString::null, int index=-1) |
| This is the same as above, but with specified signals and slots to which this button will be connected. | |
| int | insertButton (const QString &icon, int id, QPopupMenu *popup, bool enabled, const QString &_text, int index=-1) |
| Inserts a button with popupmenu. | |
| int | insertButton (const QPixmap &pixmap, int id, QPopupMenu *popup, bool enabled, const QString &_text, int index=-1) |
| Inserts a button with popupmenu. | |
| int | insertLined (const QString &text, int id, const char *signal, const QObject *receiver, const char *slot, bool enabled=true, const QString &toolTipText=QString::null, int size=70, int index=-1) |
| Inserts a KLineEdit. | |
| int | insertCombo (const QStringList &list, int id, bool writable, const char *signal, const QObject *receiver, const char *slot, bool enabled=true, const QString &tooltiptext=QString::null, int size=70, int index=-1, QComboBox::Policy policy=QComboBox::AtBottom) |
| Inserts a KComboBox with list. | |
| int | insertCombo (const QString &text, int id, bool writable, const char *signal, QObject *recevier, const char *slot, bool enabled=true, const QString &tooltiptext=QString::null, int size=70, int index=-1, QComboBox::Policy policy=QComboBox::AtBottom) |
| Insert a KComboBox with text. | |
| int | insertSeparator (int index=-1, int id=-1) |
| Inserts a separator into the toolbar with the given id. | |
| int | insertLineSeparator (int index=-1, int id=-1) |
| Inserts a line separator into the toolbar with the given id. | |
| int | insertWidget (int id, int width, QWidget *_widget, int index=-1) |
| Inserts a user-defined widget. | |
| int | insertAnimatedWidget (int id, QObject *receiver, const char *slot, const QString &icons, int index=-1) |
| Inserts an animated widget. | |
| KAnimWidget * | animatedWidget (int id) |
| This will return a pointer to the given animated widget, if it exists. | |
| void | addConnection (int id, const char *signal, const QObject *receiver, const char *slot) |
| Adds connections to items. | |
| void | setItemEnabled (int id, bool enabled) |
| Enables/disables item. | |
| void | setButtonIcon (int id, const QString &_icon) |
| Sets the icon for a button. | |
| void | setButtonPixmap (int id, const QPixmap &_pixmap) |
| Sets button pixmap. | |
| void | setButtonIconSet (int id, const QIconSet &iconset) |
| Sets a button icon from a QIconSet. | |
| void | setDelayedPopup (int id, QPopupMenu *_popup, bool toggle=false) |
| Sets a delayed popup for a button. | |
| void | setAutoRepeat (int id, bool flag=true) |
| Turns a button into an autorepeat button. | |
| void | setToggle (int id, bool flag=true) |
Turns button into a toggle button if flag is true. | |
| void | toggleButton (int id) |
| Toggles a togglebutton. | |
| void | setButton (int id, bool flag) |
| Sets a toggle button state. | |
| bool | isButtonOn (int id) const |
| void | setLinedText (int id, const QString &text) |
| Sets the text of a line editor. | |
| QString | getLinedText (int id) const |
| Returns a line editor text. | |
| void | insertComboItem (int id, const QString &text, int index) |
Inserts text in combobox id at position index. | |
| void | insertComboList (int id, const QStringList &list, int index) |
Inserts list in combobox id at position index. | |
| void | removeComboItem (int id, int index) |
Removes item index from combobox id. | |
| void | setCurrentComboItem (int id, int index) |
Sets item index to be current item in combobox id. | |
| void | changeComboItem (int id, const QString &text, int index=-1) |
Changes item index in combobox id to text. | |
| void | clearCombo (int id) |
Clears the combobox id. | |
| QString | getComboItem (int id, int index=-1) const |
Returns text of item index from combobox id. | |
| KComboBox * | getCombo (int id) |
| Returns a pointer to the combobox. | |
| KLineEdit * | getLined (int id) |
| Returns a pointer to KToolBarLined. | |
| KToolBarButton * | getButton (int id) |
| Returns a pointer to KToolBarButton. | |
| void | alignItemRight (int id, bool right=true) |
| Align item to the right. | |
| QWidget * | getWidget (int id) |
| Returns a pointer to an inserted widget. | |
| void | setItemAutoSized (int id, bool yes=true) |
| Set item autosized. | |
| void | clear () |
| Remove all items. | |
| void | removeItem (int id) |
Remove item id. | |
| void | hideItem (int id) |
| Hide item. | |
| void | showItem (int id) |
| Show item. | |
| void | setFullSize (bool flag=true) |
| Set toolbar to full parent size (default). | |
| bool | fullSize () const |
| void | enableMoving (bool flag=true) |
| This class or method is obsolete, it is provided for compatibility only. use setMovingEnabled(bool) instead. | |
| void | setBarPos (BarPosition bpos) |
| Set position of toolbar. | |
| BarPosition | barPos () const |
| Returns position of toolbar. | |
| bool | enable (BarStatus stat) |
| This class or method is obsolete, it is provided for compatibility only. Show, hide, or toggle toolbar. | |
| void | setMaxHeight (int h) |
| This class or method is obsolete, it is provided for compatibility only. Use setMaximumHeight() instead. | |
| int | maxHeight () |
| This class or method is obsolete, it is provided for compatibility only. Use maximumHeight() instead. | |
| void | setMaxWidth (int dw) |
| This class or method is obsolete, it is provided for compatibility only. Use setMaximumWidth() instead. | |
| int | maxWidth () |
| This class or method is obsolete, it is provided for compatibility only. Use maximumWidth() instead. | |
| void | setTitle (const QString &_title) |
| Set title for toolbar when it floats. | |
| void | enableFloating (bool arrrrrrgh) |
| This class or method is obsolete, it is provided for compatibility only. Use enableMoving() instead. | |
| void | setIconText (IconText it) |
| Set the kind of painting for buttons. | |
| void | setIconText (IconText it, bool update) |
| Similar to setIconText(IconText it) but allows you to disable or enable updating. | |
| IconText | iconText () const |
| void | setIconSize (int size) |
| Set the icon size to load. | |
| void | setIconSize (int size, bool update) |
| Same as setIconText(int size) but allows you to disable the toolbar update. | |
| int | iconSize () const |
| void | setEnableContextMenu (bool enable=true) |
| This allows you to enable or disable the context menu. | |
| bool | contextMenuEnabled () const |
| Returns whether or not the context menu is disabled. | |
| void | setItemNoStyle (int id, bool no_style=true) |
| This will inform a toolbar button to ignore certain style changes. | |
| void | setFlat (bool flag) |
| int | count () const |
| void | saveState () |
| Instruct the toolbar to save it's current state to either the app config file or to the XML-GUI resource file (whichever has precedence). | |
| void | saveSettings (KConfig *config, const QString &configGroup) |
Save the toolbar settings to group configGroup in config. | |
| void | applySettings (KConfig *config, const QString &configGroup) |
Read the toolbar settings from group configGroup in config and apply them. | |
| void | setXMLGUIClient (KXMLGUIClient *client) |
| Tell the toolbar what XML-GUI resource file it should use to save it's state. | |
| void | setText (const QString &txt) |
| Assign a (translated) text to this toolbar. | |
| QString | text () const |
| void | setStretchableWidget (QWidget *w) |
| QSizePolicy | sizePolicy () const |
| bool | highlight () const |
| QSize | sizeHint () const |
| QSize | minimumSizeHint () const |
| QSize | minimumSize () const |
| void | hide () |
| void | show () |
| void | updateRects (bool=FALSE) |
| void | loadState (const QDomElement &e) |
| void | saveState (QDomElement &e) |
| void | positionYourself (bool force=false) |
Static Public Member Functions | |
| bool | highlightSetting () |
| bool | transparentSetting () |
| IconText | iconTextSetting () |
Protected Member Functions | |
| void | mousePressEvent (QMouseEvent *) |
| void | childEvent (QChildEvent *e) |
| void | showEvent (QShowEvent *e) |
| void | resizeEvent (QResizeEvent *e) |
| bool | event (QEvent *e) |
| void | applyAppearanceSettings (KConfig *config, const QString &_configGroup, bool forceGlobal=false) |
| QString | settingsGroup () const |
| virtual void | virtual_hook (int id, void *data) |
Detailed Description
A KDE-style toolbar. Floatable toolbar with auto resize.KToolBar can be dragged around in and between different docks.
A KToolBar can contain all sorts of widgets.
KToolBar can be used as a standalone widget, but KMainWindow provides easy factories and management of one or more toolbars. Once you have a KToolBar object, you can insert items into it with the insert... methods, or remove them with the removeItem() method. This can be done at any time; the toolbar will be automatically updated. There are also many methods to set per-child properties like alignment and toggle behaviour.
KToolBar uses a global config group to load toolbar settings on construction. It will reread this config group on a KApplication::appearanceChanged() signal.
- Version:
- Id
- ktoolbar.h,v 1.153.2.1 2002/12/09 23:28:37 faure Exp
- Author:
- Reginald Stadlbauer <reggie@kde.org>, Stephan Kulow <coolo@kde.org>, Sven Radej <radej@kde.org>.
Definition at line 101 of file ktoolbar.h.
Member Enumeration Documentation
|
|
The state of the status bar. This class or method is obsolete, it is provided for compatibility only. Definition at line 117 of file ktoolbar.h. |
|
|
Possible bar positions.
Definition at line 121 of file ktoolbar.h. Referenced by barPos(). |
Constructor & Destructor Documentation
|
||||||||||||||||||||
|
Constructor. This constructor is used by the XML-GUI. If you use it, you need to call QMainWindow::addToolBar to specify the position of the toolbar. So it's simpler to use the other constructor. The toolbar will read in various global config settings for things like icon size and text position, etc. However, some of the settings will be honored only if _honor_mode is set to true. All other toolbars will be IconOnly and use Medium icons.
Definition at line 170 of file ktoolbar.cpp. References KStdAccel::name(). |
|
||||||||||||||||||||||||||||
|
Constructor for non-XML-GUI applications. The toolbar will read in various global config settings for things like icon size and text position, etc. However, some of the settings will be honored only if _honor_mode is set to true. All other toolbars will be IconOnly and use Medium icons.
Definition at line 179 of file ktoolbar.cpp. References KStdAccel::name(). |
|
||||||||||||||||||||||||||||
|
Constructor for non-XML-GUI applications. The toolbar will read in various global config settings for things like icon size and text position, etc. However, some of the settings will be honored only if _honor_mode is set to true. All other toolbars will be IconOnly and use Medium icons.
Definition at line 187 of file ktoolbar.cpp. References KStdAccel::name(). |
Member Function Documentation
|
||||||||||||||||||||||||||||
|
Insert a button (a KToolBarButton) with a pixmap. The pixmap is loaded by the button itself based on the global icon settings.
You should connect to one or more signals in KToolBar: clicked() , pressed() , released() , or highlighted() and if the button is a toggle button (setToggle() ) toggled() . Those signals have
Definition at line 229 of file ktoolbar.cpp. Referenced by KToolBarPopupAction::plug(), KActionMenu::plug(), and KAction::plug(). |
|
||||||||||||||||||||||||||||||||||||||||
|
This is the same as above, but with specified signals and slots to which this button will be connected. You can add more signals with addConnection().
Definition at line 241 of file ktoolbar.cpp. |
|
||||||||||||||||||||||||
|
Inserts a button (a KToolBarButton) with the specified pixmap. This pixmap will be used as the "active" one and the disabled and default ones will be autogenerated. It is recommended that you use the insertButton function that allows you to specify the icon name rather then the pixmap itself. Specifying the icon name is much more flexible.
You should connect to one or more signals in KToolBar: clicked() , pressed() , released() , or highlighted() and if the button is a toggle button (setToggle() ) toggled() . Those signals have
Definition at line 254 of file ktoolbar.cpp. |
|
||||||||||||||||||||||||||||||||||||
|
This is the same as above, but with specified signals and slots to which this button will be connected. You can add more signals with addConnection().
Definition at line 265 of file ktoolbar.cpp. |
|
||||||||||||||||||||||||||||
|
Inserts a button with popupmenu.
Button will have small triangle. You have to connect to popup's signals. The signals KButton::pressed(), KButton::released(), KButton::clicked() or KButton::doubleClicked() are Definition at line 279 of file ktoolbar.cpp. References KToolBarButton::setPopup(). |
|
||||||||||||||||||||||||||||
|
Inserts a button with popupmenu.
Button will have small triangle. You have to connect to popup's signals. The signals KButton::pressed(), KButton::released(), KButton::clicked() or KButton::doubleClicked() are Definition at line 291 of file ktoolbar.cpp. References KToolBarButton::setPopup(). |
|
||||||||||||||||||||||||||||||||||||||||
|
Inserts a KLineEdit. You have to specify signals and slots to which KLineEdit will be connected. KLineEdit has all slots QLineEdit has, plus signals KLineEdit::completion and KLineEdit::textRotation KLineEdit can be set to autoresize itself to full free width in toolbar, that is to last right aligned item. For that, toolbar must be set to full width (which it is by default).
Definition at line 303 of file ktoolbar.cpp. References QToolTip::add(), QString::isEmpty(), and QLineEdit::setText(). |
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
Inserts a KComboBox with list. Can be writable, but cannot contain pixmaps. By default inserting policy is AtBottom, i.e. typed items are placed at the bottom of the list. Can be autosized. If the size argument is specified as -1, the width of the combobox is automatically computed.
Definition at line 322 of file ktoolbar.cpp. References QToolTip::add(), QComboBox::insertStringList(), QString::isEmpty(), QString::isNull(), and QComboBox::setInsertionPolicy(). Referenced by KSelectAction::plug(). |
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
Insert a KComboBox with text. The rest is the same as above.
Definition at line 348 of file ktoolbar.cpp. References QToolTip::add(), QComboBox::insertItem(), QString::isEmpty(), QString::isNull(), and QComboBox::setInsertionPolicy(). |
|
||||||||||||
|
Inserts a separator into the toolbar with the given id. Returns the separator's index Definition at line 370 of file ktoolbar.cpp. |
|
||||||||||||
|
Inserts a line separator into the toolbar with the given id. Returns the separator's index Definition at line 377 of file ktoolbar.cpp. |
|
||||||||||||||||||||
|
Inserts a user-defined widget.
The widget Widget must have a QWidget for base class. Widget can be autosized to full width. If you forget about it, you can get a pointer to this widget with getWidget().
Definition at line 385 of file ktoolbar.cpp. Referenced by KWidgetAction::plug(). |
|
||||||||||||||||||||||||
|
Inserts an animated widget. A KAnimWidget will be created internally using the icon name you provide. This will emit a signal (clicked()) whenever the animation widget is clicked.
Definition at line 392 of file ktoolbar.cpp. References clicked(). |
|
|
This will return a pointer to the given animated widget, if it exists.
Definition at line 404 of file ktoolbar.cpp. References QMap::end(), QMap::find(), and QObject::inherits(). |
|
||||||||||||||||||||
|
Adds connections to items.
It is important that you know the Definition at line 430 of file ktoolbar.cpp. References QMap::end(), and QMap::find(). |
|
||||||||||||
|
Enables/disables item.
Definition at line 440 of file ktoolbar.cpp. References QMap::end(), and QMap::find(). |
|
||||||||||||
|
Sets the icon for a button. Can be used while button is visible. Definition at line 461 of file ktoolbar.cpp. References QMap::end(), QMap::find(), and KToolBarButton::setIcon(). |
|
||||||||||||
|
Sets button pixmap. Can be used while button is visible. Definition at line 450 of file ktoolbar.cpp. References QMap::end(), QMap::find(), and KToolBarButton::setPixmap(). |
|
||||||||||||
|
Sets a button icon from a QIconSet. Can be used while button is visible. Definition at line 471 of file ktoolbar.cpp. References QMap::end(), QMap::find(), and KToolBarButton::setIconSet(). |
|
||||||||||||||||
|
Sets a delayed popup for a button. Delayed popup is what you see in Netscape Navigator's Previous and Next buttons: If you click them you go back or forth. If you press them long enough, you get a history-menu. This is exactly what we do here. You will insert normal a button with connection (or use signals from toolbar):
|
|
||||||||||||
|
Turns a button into an autorepeat button. Toggle buttons, buttons with menus, or buttons with delayed menus cannot be made into autorepeat buttons. Moreover, you can and will receive only the signal clicked(), but not pressed() or released(). When the user presses this button, you will receive the signal clicked(), and if the button is still pressed after some time, you will receive more clicked() signals separated by regular intervals. Since this uses QButton::setAutoRepeat() , I can't quantify 'some'. Definition at line 493 of file ktoolbar.cpp. References QMap::end(), and QMap::find(). |
|
||||||||||||
|
Turns button into a toggle button if
Definition at line 504 of file ktoolbar.cpp. References QMap::end(), QMap::find(), and KToolBarButton::setToggle(). Referenced by KToggleAction::plug(). |
|
|
Toggles a togglebutton.
If the button is a toggle button (see setToggle()) the button state will be toggled. This will also cause the toolbar to emit the signal KButton::toggled() with parameter Definition at line 515 of file ktoolbar.cpp. References QMap::end(), QMap::find(), and KToolBarButton::toggle(). |
|
||||||||||||
|
Sets a toggle button state. If the button is a toggle button (see setToggle()) this will set its state flag. This will also emit the signal KButton::toggled().
Definition at line 526 of file ktoolbar.cpp. References QMap::end(), QMap::find(), and KToolBarButton::on(). Referenced by KToggleAction::plug(). |
|
|
Definition at line 537 of file ktoolbar.cpp. References QMap::end(), and QMap::find(). |
|
