.TH "KToolBar" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KToolBar \- A KDE-style toolbar. Floatable toolbar with auto resize.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ktoolbar.h>\fP
.PP
Inherits \fBQToolBar\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBIconText\fP { \fBIconOnly\fP =  0, \fBIconTextRight\fP, \fBTextOnly\fP, \fBIconTextBottom\fP }"
.br
.ti -1c
.RI "enum \fBBarStatus\fP { \fBToggle\fP, \fBShow\fP, \fBHide\fP }"
.br
.RI "\fIThe state of the status bar. \fP"
.ti -1c
.RI "enum \fBBarPosition\fP { \fBUnmanaged\fP, \fBFloating\fP, \fBTop\fP, \fBBottom\fP, \fBRight\fP, \fBLeft\fP, \fBFlat\fP }"
.br
.RI "\fIPossible bar positions. \fP"
.in -1c
.SS "Public Slots"

.in +1c
.ti -1c
.RI "virtual void \fBsetIconText\fP (const  \fBQString\fP &txt)"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBclicked\fP (int id)"
.br
.RI "\fIEmitted when button \fCid\fP is clicked. \fP"
.ti -1c
.RI "void \fBdoubleClicked\fP (int id)"
.br
.RI "\fIEmitted when button \fCid\fP is double-clicked. \fP"
.ti -1c
.RI "void \fBpressed\fP (int)"
.br
.RI "\fIEmitted when button \fCid\fP is pressed. \fP"
.ti -1c
.RI "void \fBreleased\fP (int)"
.br
.RI "\fIEmits when button \fCid\fP is released. \fP"
.ti -1c
.RI "void \fBtoggled\fP (int)"
.br
.RI "\fIEmitted when a toggle button changes state. \fP"
.ti -1c
.RI "void \fBhighlighted\fP (int id, bool isHighlighted)"
.br
.RI "\fIThis signal is emitted when item id gets highlighted/unhighlighted (i.e when mouse enters/exits). \fP"
.ti -1c
.RI "void \fBhighlighted\fP (int id)"
.br
.RI "\fIThis signal is emitted when item id gets highlighted/unhighlighted (i.e when mouse enters/exits). \fP"
.ti -1c
.RI "void \fBmoved\fP (\fBBarPosition\fP)"
.br
.RI "\fIEmitted when toolbar changes position, or when an item is removed from toolbar. \fP"
.ti -1c
.RI "void \fBmodechange\fP ()"
.br
.ti -1c
.RI "void \fBtoolbarDestroyed\fP ()"
.br
.RI "\fIThis signal is emitted when the toolbar is getting deleted, and before ~KToolbar finishes (so it's still time to remove widgets from the toolbar). \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKToolBar\fP (\fBQWidget\fP *parent, const  char *name=0, bool honor_style=FALSE, bool readConfig=TRUE)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fBKToolBar\fP (\fBQMainWindow\fP *parentWindow, QMainWindow::ToolBarDock dock, bool newLine=false, const  char *name=0, bool honor_style=FALSE, bool readConfig=TRUE)"
.br
.RI "\fIConstructor for non-XML-GUI applications. \fP"
.ti -1c
.RI "\fBKToolBar\fP (\fBQMainWindow\fP *parentWindow, \fBQWidget\fP *dock, bool newLine=false, const  char *name=0, bool honor_style=FALSE, bool readConfig=TRUE)"
.br
.RI "\fIConstructor for non-XML-GUI applications. \fP"
.ti -1c
.RI "int \fBinsertButton\fP (const  \fBQString\fP &icon, int id, bool enabled=true, const  \fBQString\fP &text=QString::null, int index=-1, \fBKInstance\fP *_instance=\fBKGlobal::instance\fP())"
.br
.RI "\fIInsert a button (a \fBKToolBarButton\fP) with a pixmap. \fP"
.ti -1c
.RI "int \fBinsertButton\fP (const  \fBQString\fP &icon, int id, const  char *signal, const  \fBQObject\fP *receiver, const  char *slot, bool enabled=true, const  \fBQString\fP &text=QString::null, int index=-1, \fBKInstance\fP *_instance=\fBKGlobal::instance\fP())"
.br
.RI "\fIThis is the same as above, but with specified signals and slots to which this button will be connected. \fP"
.ti -1c
.RI "int \fBinsertButton\fP (const  \fBQPixmap\fP &pixmap, int id, bool enabled=true, const  \fBQString\fP &text=QString::null, int index=-1)"
.br
.RI "\fIInserts a button (a \fBKToolBarButton\fP) with the specified pixmap. \fP"
.ti -1c
.RI "int \fBinsertButton\fP (const  \fBQPixmap\fP &pixmap, int id, const  char *signal, const  \fBQObject\fP *receiver, const  char *slot, bool enabled=true, const  \fBQString\fP &text=QString::null, int index=-1)"
.br
.RI "\fIThis is the same as above, but with specified signals and slots to which this button will be connected. \fP"
.ti -1c
.RI "int \fBinsertButton\fP (const  \fBQString\fP &icon, int id, \fBQPopupMenu\fP *popup, bool enabled, const  \fBQString\fP &_text, int index=-1)"
.br
.RI "\fIInserts a button with popupmenu. \fP"
.ti -1c
.RI "int \fBinsertButton\fP (const  \fBQPixmap\fP &pixmap, int id, \fBQPopupMenu\fP *popup, bool enabled, const  \fBQString\fP &_text, int index=-1)"
.br
.RI "\fIInserts a button with popupmenu. \fP"
.ti -1c
.RI "int \fBinsertLined\fP (const  \fBQString\fP &text, int id, const  char *signal, const  \fBQObject\fP *receiver, const  char *slot, bool enabled=true, const  \fBQString\fP &toolTipText=QString::null, int size=70, int index=-1)"
.br
.RI "\fIInserts a \fBKLineEdit\fP. \fP"
.ti -1c
.RI "int \fBinsertCombo\fP (const  \fBQStringList\fP &list, int id, bool writable, const  char *signal, const  \fBQObject\fP *receiver, const  char *slot, bool enabled=true, const  \fBQString\fP &tooltiptext=QString::null, int size=70, int index=-1, QComboBox::Policy policy=QComboBox::AtBottom)"
.br
.RI "\fIInserts a \fBKComboBox\fP with list. \fP"
.ti -1c
.RI "int \fBinsertCombo\fP (const  \fBQString\fP &text, int id, bool writable, const  char *signal, \fBQObject\fP *recevier, const  char *slot, bool enabled=true, const  \fBQString\fP &tooltiptext=QString::null, int size=70, int index=-1, QComboBox::Policy policy=QComboBox::AtBottom)"
.br
.RI "\fIInsert a \fBKComboBox\fP with text. \fP"
.ti -1c
.RI "int \fBinsertSeparator\fP (int index=-1, int id=-1)"
.br
.RI "\fIInserts a separator into the toolbar with the given id. \fP"
.ti -1c
.RI "int \fBinsertLineSeparator\fP (int index=-1, int id=-1)"
.br
.RI "\fIInserts a line separator into the toolbar with the given id. \fP"
.ti -1c
.RI "int \fBinsertWidget\fP (int id, int width, \fBQWidget\fP *_widget, int index=-1)"
.br
.RI "\fIInserts a user-defined widget. \fP"
.ti -1c
.RI "int \fBinsertAnimatedWidget\fP (int id, \fBQObject\fP *receiver, const  char *slot, const  \fBQString\fP &icons, int index=-1)"
.br
.RI "\fIInserts an animated widget. \fP"
.ti -1c
.RI "\fBKAnimWidget\fP * \fBanimatedWidget\fP (int id)"
.br
.RI "\fIThis will return a pointer to the given animated widget, if it exists. \fP"
.ti -1c
.RI "void \fBaddConnection\fP (int id, const  char *signal, const  \fBQObject\fP *receiver, const  char *slot)"
.br
.RI "\fIAdds connections to items. \fP"
.ti -1c
.RI "void \fBsetItemEnabled\fP (int id, bool enabled)"
.br
.RI "\fIEnables/disables item. \fP"
.ti -1c
.RI "void \fBsetButtonIcon\fP (int id, const  \fBQString\fP &_icon)"
.br
.RI "\fISets the icon for a button. \fP"
.ti -1c
.RI "void \fBsetButtonPixmap\fP (int id, const  \fBQPixmap\fP &_pixmap)"
.br
.RI "\fISets button pixmap. \fP"
.ti -1c
.RI "void \fBsetButtonIconSet\fP (int id, const  \fBQIconSet\fP &iconset)"
.br
.RI "\fISets a button icon from a \fBQIconSet\fP. \fP"
.ti -1c
.RI "void \fBsetDelayedPopup\fP (int id, \fBQPopupMenu\fP *_popup, bool toggle=false)"
.br
.RI "\fISets a delayed popup for a button. \fP"
.ti -1c
.RI "void \fBsetAutoRepeat\fP (int id, bool flag=true)"
.br
.RI "\fITurns a button into an autorepeat button. \fP"
.ti -1c
.RI "void \fBsetToggle\fP (int id, bool flag=true)"
.br
.RI "\fITurns button into a toggle button if \fCflag\fP is true. \fP"
.ti -1c
.RI "void \fBtoggleButton\fP (int id)"
.br
.RI "\fIToggles a togglebutton. \fP"
.ti -1c
.RI "void \fBsetButton\fP (int id, bool flag)"
.br
.RI "\fISets a toggle button state. \fP"
.ti -1c
.RI "bool \fBisButtonOn\fP (int id) const "
.br
.ti -1c
.RI "void \fBsetLinedText\fP (int id, const  \fBQString\fP &text)"
.br
.RI "\fISets the text of a line editor. \fP"
.ti -1c
.RI "\fBQString\fP \fBgetLinedText\fP (int id) const "
.br
.RI "\fIReturns a line editor text. \fP"
.ti -1c
.RI "void \fBinsertComboItem\fP (int id, const  \fBQString\fP &text, int index)"
.br
.RI "\fIInserts \fCtext\fP in combobox \fCid\fP at position \fCindex\fP. \fP"
.ti -1c
.RI "void \fBinsertComboList\fP (int id, const  \fBQStringList\fP &list, int index)"
.br
.RI "\fIInserts \fClist\fP in combobox \fCid\fP at position \fCindex\fP. \fP"
.ti -1c
.RI "void \fBremoveComboItem\fP (int id, int index)"
.br
.RI "\fIRemoves item \fCindex\fP from combobox \fCid\fP. \fP"
.ti -1c
.RI "void \fBsetCurrentComboItem\fP (int id, int index)"
.br
.RI "\fISets item \fCindex\fP to be current item in combobox \fCid\fP. \fP"
.ti -1c
.RI "void \fBchangeComboItem\fP (int id, const  \fBQString\fP &text, int index=-1)"
.br
.RI "\fIChanges item \fCindex\fP in combobox \fCid\fP to text. \fP"
.ti -1c
.RI "void \fBclearCombo\fP (int id)"
.br
.RI "\fIClears the combobox \fCid\fP. \fP"
.ti -1c
.RI "\fBQString\fP \fBgetComboItem\fP (int id, int index=-1) const "
.br
.RI "\fIReturns text of item \fCindex\fP from combobox \fCid\fP. \fP"
.ti -1c
.RI "\fBKComboBox\fP * \fBgetCombo\fP (int id)"
.br
.RI "\fIReturns a pointer to the combobox. \fP"
.ti -1c
.RI "\fBKLineEdit\fP * \fBgetLined\fP (int id)"
.br
.RI "\fIReturns a pointer to KToolBarLined. \fP"
.ti -1c
.RI "\fBKToolBarButton\fP * \fBgetButton\fP (int id)"
.br
.RI "\fIReturns a pointer to \fBKToolBarButton\fP. \fP"
.ti -1c
.RI "void \fBalignItemRight\fP (int id, bool right=true)"
.br
.RI "\fIAlign item to the right. \fP"
.ti -1c
.RI "\fBQWidget\fP * \fBgetWidget\fP (int id)"
.br
.RI "\fIReturns a pointer to an inserted widget. \fP"
.ti -1c
.RI "void \fBsetItemAutoSized\fP (int id, bool yes=true)"
.br
.RI "\fISet item autosized. \fP"
.ti -1c
.RI "void \fBclear\fP ()"
.br
.RI "\fIRemove all items. \fP"
.ti -1c
.RI "void \fBremoveItem\fP (int id)"
.br
.RI "\fIRemove item \fCid\fP. \fP"
.ti -1c
.RI "void \fBhideItem\fP (int id)"
.br
.RI "\fIHide item. \fP"
.ti -1c
.RI "void \fBshowItem\fP (int id)"
.br
.RI "\fIShow item. \fP"
.ti -1c
.RI "void \fBsetFullSize\fP (bool flag=true)"
.br
.RI "\fISet toolbar to full parent size (default). \fP"
.ti -1c
.RI "bool \fBfullSize\fP () const "
.br
.ti -1c
.RI "void \fBenableMoving\fP (bool flag=true)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP use setMovingEnabled(bool) instead. \fP"
.ti -1c
.RI "void \fBsetBarPos\fP (\fBBarPosition\fP bpos)"
.br
.RI "\fISet position of toolbar. \fP"
.ti -1c
.RI "\fBBarPosition\fP \fBbarPos\fP () const "
.br
.RI "\fIReturns position of toolbar. \fP"
.ti -1c
.RI "bool \fBenable\fP (\fBBarStatus\fP stat)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Show, hide, or toggle toolbar. \fP"
.ti -1c
.RI "void \fBsetMaxHeight\fP (int h)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use setMaximumHeight() instead. \fP"
.ti -1c
.RI "int \fBmaxHeight\fP ()"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use maximumHeight() instead. \fP"
.ti -1c
.RI "void \fBsetMaxWidth\fP (int dw)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use setMaximumWidth() instead. \fP"
.ti -1c
.RI "int \fBmaxWidth\fP ()"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use maximumWidth() instead. \fP"
.ti -1c
.RI "void \fBsetTitle\fP (const  \fBQString\fP &_title)"
.br
.RI "\fISet title for toolbar when it floats. \fP"
.ti -1c
.RI "void \fBenableFloating\fP (bool arrrrrrgh)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use \fBenableMoving()\fP instead. \fP"
.ti -1c
.RI "void \fBsetIconText\fP (IconText it)"
.br
.RI "\fISet the kind of painting for buttons. \fP"
.ti -1c
.RI "void \fBsetIconText\fP (IconText it, bool update)"
.br
.RI "\fISimilar to \fBsetIconText\fP(IconText it) but allows you to disable or enable updating. \fP"
.ti -1c
.RI "IconText \fBiconText\fP () const "
.br
.ti -1c
.RI "void \fBsetIconSize\fP (int size)"
.br
.RI "\fISet the icon size to load. \fP"
.ti -1c
.RI "void \fBsetIconSize\fP (int size, bool update)"
.br
.RI "\fISame as \fBsetIconText\fP(int size) but allows you to disable the toolbar update. \fP"
.ti -1c
.RI "int \fBiconSize\fP () const "
.br
.ti -1c
.RI "void \fBsetEnableContextMenu\fP (bool enable=true)"
.br
.RI "\fIThis allows you to enable or disable the context menu. \fP"
.ti -1c
.RI "bool \fBcontextMenuEnabled\fP () const "
.br
.RI "\fIReturns whether or not the context menu is disabled. \fP"
.ti -1c
.RI "void \fBsetItemNoStyle\fP (int id, bool no_style=true)"
.br
.RI "\fIThis will inform a toolbar button to ignore certain style changes. \fP"
.ti -1c
.RI "void \fBsetFlat\fP (bool flag)"
.br
.ti -1c
.RI "int \fBcount\fP () const "
.br
.ti -1c
.RI "void \fBsaveState\fP ()"
.br
.RI "\fIInstruct the toolbar to save it's current state to either the app config file or to the XML-GUI resource file (whichever has precedence). \fP"
.ti -1c
.RI "void \fBsaveSettings\fP (\fBKConfig\fP *config, const  \fBQString\fP &configGroup)"
.br
.RI "\fISave the toolbar settings to group \fCconfigGroup\fP in \fCconfig\fP. \fP"
.ti -1c
.RI "void \fBapplySettings\fP (\fBKConfig\fP *config, const  \fBQString\fP &configGroup)"
.br
.RI "\fIRead the toolbar settings from group \fCconfigGroup\fP in \fCconfig\fP and apply them. \fP"
.ti -1c
.RI "void \fBsetXMLGUIClient\fP (\fBKXMLGUIClient\fP *client)"
.br
.RI "\fITell the toolbar what XML-GUI resource file it should use to save it's state. \fP"
.ti -1c
.RI "void \fBsetText\fP (const  \fBQString\fP &txt)"
.br
.RI "\fIAssign a (translated) text to this toolbar. \fP"
.ti -1c
.RI "\fBQString\fP \fBtext\fP () const "
.br
.ti -1c
.RI "void \fBsetStretchableWidget\fP (\fBQWidget\fP *w)"
.br
.ti -1c
.RI "\fBQSizePolicy\fP \fBsizePolicy\fP () const "
.br
.ti -1c
.RI "bool \fBhighlight\fP () const "
.br
.ti -1c
.RI "\fBQSize\fP \fBsizeHint\fP () const "
.br
.ti -1c
.RI "\fBQSize\fP \fBminimumSizeHint\fP () const "
.br
.ti -1c
.RI "\fBQSize\fP \fBminimumSize\fP () const "
.br
.ti -1c
.RI "void \fBhide\fP ()"
.br
.ti -1c
.RI "void \fBshow\fP ()"
.br
.ti -1c
.RI "void \fBupdateRects\fP (bool=FALSE)"
.br
.ti -1c
.RI "void \fBloadState\fP (const  \fBQDomElement\fP &e)"
.br
.ti -1c
.RI "void \fBsaveState\fP (\fBQDomElement\fP &e)"
.br
.ti -1c
.RI "void \fBpositionYourself\fP (bool force=false)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "bool \fBhighlightSetting\fP ()"
.br
.ti -1c
.RI "bool \fBtransparentSetting\fP ()"
.br
.ti -1c
.RI "IconText \fBiconTextSetting\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBmousePressEvent\fP (\fBQMouseEvent\fP *)"
.br
.ti -1c
.RI "void \fBchildEvent\fP (\fBQChildEvent\fP *e)"
.br
.ti -1c
.RI "void \fBshowEvent\fP (\fBQShowEvent\fP *e)"
.br
.ti -1c
.RI "void \fBresizeEvent\fP (\fBQResizeEvent\fP *e)"
.br
.ti -1c
.RI "bool \fBevent\fP (\fBQEvent\fP *e)"
.br
.ti -1c
.RI "void \fBapplyAppearanceSettings\fP (\fBKConfig\fP *config, const  \fBQString\fP &_configGroup, bool forceGlobal=false)"
.br
.ti -1c
.RI "\fBQString\fP \fBsettingsGroup\fP () const "
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A KDE-style toolbar. Floatable toolbar with auto resize. 

KToolBar can be dragged around in and between different docks.
.PP
A KToolBar can contain all sorts of widgets.
.PP
KToolBar can be used as a standalone widget, but \fBKMainWindow\fP 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 \fBremoveItem\fP() 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.
.PP
KToolBar uses a global config group to load toolbar settings on construction. It will reread this config group on a \fBKApplication::appearanceChanged\fP() signal.
.PP
\fBVersion:\fP
.RS 4
\fBId\fP.RS 4
\fBktoolbar.h\fP,v 1.153.2.1 2002/12/09 23:28:37 faure Exp 
.RE
.PP
.RE
.PP
\fBAuthor:\fP
.RS 4
Reginald Stadlbauer <reggie@kde.org>, Stephan Kulow <coolo@kde.org>, Sven Radej <radej@kde.org>. 
.RE
.PP

.PP
Definition at line 101 of file ktoolbar.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKToolBar::BarStatus\fP"
.PP
The state of the status bar. \fBThis class or method is obsolete, it is provided for compatibility only.\fP Definition at line 117 of file ktoolbar.h.
.SS "enum \fBKToolBar::BarPosition\fP"
.PP
Possible bar positions. Definition at line 121 of file ktoolbar.h.
.PP
Referenced by barPos().
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KToolBar::KToolBar (\fBQWidget\fP * parent, const char * name = 0, bool honor_style = FALSE, bool readConfig = TRUE)"
.PP
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.
.PP
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 \fB_honor_mode\fP is set to true. All other toolbars will be IconOnly and use Medium icons.
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP The standard toolbar parent (usually a \fBKMainWindow\fP) 
.br
\fIname\fP The standard internal name 
.br
\fIhonor_style\fP If true, then global settings for IconSize and IconText will be honored 
.br
\fIreadConfig\fP whether to apply the configuration (global and application-specific) 
.RE
.PP
Definition at line 170 of file ktoolbar.cpp.
.PP
References KStdAccel::name().
.SS "KToolBar::KToolBar (\fBQMainWindow\fP * parentWindow, QMainWindow::ToolBarDock dock, bool newLine = false, const char * name = 0, bool honor_style = FALSE, bool readConfig = TRUE)"
.PP
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 \fB_honor_mode\fP is set to true. All other toolbars will be IconOnly and use Medium icons.
.PP
\fBParameters:\fP
.RS 4
\fIparentWindow\fP The window that should be the parent of this toolbar 
.br
\fIdock\fP The position of the toolbar. Usually QMainWindow::Top. 
.br
\fInewLine\fP If true, start a new line in the dock for this toolbar. 
.br
\fIname\fP The standard internal name 
.br
\fIhonor_style\fP If true, then global settings for IconSize and IconText will be honored 
.br
\fIreadConfig\fP whether to apply the configuration (global and application-specific) 
.RE
.PP
Definition at line 179 of file ktoolbar.cpp.
.PP
References KStdAccel::name().
.SS "KToolBar::KToolBar (\fBQMainWindow\fP * parentWindow, \fBQWidget\fP * dock, bool newLine = false, const char * name = 0, bool honor_style = FALSE, bool readConfig = TRUE)"
.PP
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 \fB_honor_mode\fP is set to true. All other toolbars will be IconOnly and use Medium icons.
.PP
\fBParameters:\fP
.RS 4
\fIparentWindow\fP The window that should be the parent of this toolbar 
.br
\fIdock\fP Another widget than the mainwindow to dock toolbar to. 
.br
\fInewLine\fP If true, start a new line in the dock for this toolbar. 
.br
\fIname\fP The standard internal name 
.br
\fIhonor_style\fP If true, then global settings for IconSize and IconText will be honored 
.br
\fIreadConfig\fP whether to apply the configuration (global and application-specific) 
.RE
.PP
Definition at line 187 of file ktoolbar.cpp.
.PP
References KStdAccel::name().
.SH "Member Function Documentation"
.PP 
.SS "int KToolBar::insertButton (const \fBQString\fP & icon, int id, bool enabled = true, const \fBQString\fP & text = QString::null, int index = -1, \fBKInstance\fP * _instance = \fBKGlobal::instance\fP())"
.PP
Insert a button (a \fBKToolBarButton\fP) with a pixmap. The pixmap is loaded by the button itself based on the global icon settings.
.PP
You should connect to one or more signals in KToolBar: \fBclicked\fP() , \fBpressed\fP() , \fBreleased\fP() , or \fBhighlighted\fP() and if the button is a toggle button (\fBsetToggle\fP() ) \fBtoggled\fP() . Those signals have \fCid\fP of a button that caused the signal. If you want to bind a popup to button, see \fBsetButton\fP().
.PP
\fBParameters:\fP
.RS 4
\fIicon\fP The name of the icon to use as the active pixmap 
.br
\fIid\fP The id of this button 
.br
\fIenabled\fP Enable or disable the button at startup 
.br
\fItext\fP The tooltip or toolbar text (depending on state) 
.br
\fIindex\fP The position of the button. (-1 = at end).
.RE
.PP
\fBReturns:\fP
.RS 4
The item index. 
.RE
.PP
Definition at line 229 of file ktoolbar.cpp.
.PP
Referenced by KToolBarPopupAction::plug(), KActionMenu::plug(), and KAction::plug().
.SS "int KToolBar::insertButton (const \fBQString\fP & icon, int id, const char * signal, const \fBQObject\fP * receiver, const char * slot, bool enabled = true, const \fBQString\fP & text = QString::null, int index = -1, \fBKInstance\fP * _instance = \fBKGlobal::instance\fP())"
.PP
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 \fBaddConnection\fP().
.PP
\fBParameters:\fP
.RS 4
\fIicon\fP The name of the icon to use as the active pixmap 
.br
\fIid\fP The id of this button 
.br
\fIsignal\fP The signal to connect to 
.br
\fIreceiver\fP The slot's parent 
.br
\fIenabled\fP Enable or disable the button at startup 
.br
\fItext\fP The tooltip or toolbar text (depending on state) 
.br
\fIindex\fP The position of the button. (-1 = at end).
.RE
.PP
\fBReturns:\fP
.RS 4
The item index. 
.RE
.PP
Definition at line 241 of file ktoolbar.cpp.
.SS "int KToolBar::insertButton (const \fBQPixmap\fP & pixmap, int id, bool enabled = true, const \fBQString\fP & text = QString::null, int index = -1)"
.PP
Inserts a button (a \fBKToolBarButton\fP) with the specified pixmap. This pixmap will be used as the 'active' one and the disabled and default ones will be autogenerated.
.PP
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.
.PP
You should connect to one or more signals in KToolBar: \fBclicked\fP() , \fBpressed\fP() , \fBreleased\fP() , or \fBhighlighted\fP() and if the button is a toggle button (\fBsetToggle\fP() ) \fBtoggled\fP() . Those signals have \fCid\fP of a button that caused the signal. If you want to bind a popup to button, see \fBsetButton\fP().
.PP
\fBParameters:\fP
.RS 4
\fIpixmap\fP The active pixmap 
.br
\fIid\fP The id of this button 
.br
\fIenabled\fP Enable or disable the button at startup 
.br
\fItext\fP The tooltip or toolbar text (depending on state) 
.br
\fIindex\fP The position of the button. (-1 = at end).
.RE
.PP
\fBReturns:\fP
.RS 4
The item index. 
.RE
.PP
Definition at line 254 of file ktoolbar.cpp.
.SS "int KToolBar::insertButton (const \fBQPixmap\fP & pixmap, int id, const char * signal, const \fBQObject\fP * receiver, const char * slot, bool enabled = true, const \fBQString\fP & text = QString::null, int index = -1)"
.PP
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 \fBaddConnection\fP().
.PP
\fBParameters:\fP
.RS 4
\fIicon\fP The name of the icon to use as the active pixmap 
.br
\fIid\fP The id of this button 
.br
\fIsignal\fP The signal to connect to 
.br
\fIreceiver\fP The slot's parent 
.br
\fIenabled\fP Enable or disable the button at startup 
.br
\fItext\fP The tooltip or toolbar text (depending on state) 
.br
\fIindex\fP The position of the button. (-1 = at end).
.RE
.PP
\fBReturns:\fP
.RS 4
The item index. 
.RE
.PP
Definition at line 265 of file ktoolbar.cpp.
.SS "int KToolBar::insertButton (const \fBQString\fP & icon, int id, \fBQPopupMenu\fP * popup, bool enabled, const \fBQString\fP & _text, int index = -1)"
.PP
Inserts a button with popupmenu. Button will have small triangle. You have to connect to popup's signals. The signals \fBKButton::pressed\fP(), \fBKButton::released\fP(), \fBKButton::clicked\fP() or \fBKButton::doubleClicked\fP() are \fCnot\fP emmited by this button (see \fBsetDelayedPopup\fP() for that). You can add custom popups which inherit \fBQPopupMenu\fP to get popups with tables, drawings etc. Just don't fiddle with events there. Definition at line 279 of file ktoolbar.cpp.
.PP
References KToolBarButton::setPopup().
.SS "int KToolBar::insertButton (const \fBQPixmap\fP & pixmap, int id, \fBQPopupMenu\fP * popup, bool enabled, const \fBQString\fP & _text, int index = -1)"
.PP
Inserts a button with popupmenu. Button will have small triangle. You have to connect to popup's signals. The signals \fBKButton::pressed\fP(), \fBKButton::released\fP(), \fBKButton::clicked\fP() or \fBKButton::doubleClicked\fP() are \fCnot\fP emmited by this button (see \fBsetDelayedPopup\fP() for that). You can add custom popups which inherit \fBQPopupMenu\fP to get popups with tables, drawings etc. Just don't fiddle with events there. Definition at line 291 of file ktoolbar.cpp.
.PP
References KToolBarButton::setPopup().
.SS "int KToolBar::insertLined (const \fBQString\fP & text, int id, const char * signal, const \fBQObject\fP * receiver, const char * slot, bool enabled = true, const \fBQString\fP & toolTipText = QString::null, int size = 70, int index = -1)"
.PP
Inserts a \fBKLineEdit\fP. You have to specify signals and slots to which \fBKLineEdit\fP will be connected. \fBKLineEdit\fP has all slots \fBQLineEdit\fP has, plus signals \fBKLineEdit::completion\fP and \fBKLineEdit::textRotation\fP \fBKLineEdit\fP 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). 
.PP
\fBSee also:\fP
.RS 4
setFullWidth() 
.PP
\fBsetItemAutoSized()\fP 
.PP
\fBKLineEdit\fP 
.RE
.PP
\fBReturns:\fP
.RS 4
Item index. 
.RE
.PP
Definition at line 303 of file ktoolbar.cpp.
.PP
References QToolTip::add(), QString::isEmpty(), and QLineEdit::setText().
.SS "int KToolBar::insertCombo (const \fBQStringList\fP & list, int id, bool writable, const char * signal, const \fBQObject\fP * receiver, const char * slot, bool enabled = true, const \fBQString\fP & tooltiptext = QString::null, int size = 70, int index = -1, QComboBox::Policy policy = QComboBox::AtBottom)"
.PP
Inserts a \fBKComboBox\fP 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.
.PP
\fBSee also:\fP
.RS 4
setFullWidth() 
.PP
\fBsetItemAutoSized()\fP 
.PP
\fBKComboBox\fP 
.RE
.PP
\fBReturns:\fP
.RS 4
Item index. 
.RE
.PP
Definition at line 322 of file ktoolbar.cpp.
.PP
References QToolTip::add(), QComboBox::insertStringList(), QString::isEmpty(), QString::isNull(), and QComboBox::setInsertionPolicy().
.PP
Referenced by KSelectAction::plug().
.SS "int KToolBar::insertCombo (const \fBQString\fP & text, int id, bool writable, const char * signal, \fBQObject\fP * recevier, const char * slot, bool enabled = true, const \fBQString\fP & tooltiptext = QString::null, int size = 70, int index = -1, QComboBox::Policy policy = QComboBox::AtBottom)"
.PP
Insert a \fBKComboBox\fP with text. The rest is the same as above. 
.PP
\fBSee also:\fP
.RS 4
\fBsetItemAutoSized()\fP
.PP
\fBKComboBox\fP 
.RE
.PP
\fBReturns:\fP
.RS 4
Item index. 
.RE
.PP
Definition at line 348 of file ktoolbar.cpp.
.PP
References QToolTip::add(), QComboBox::insertItem(), QString::isEmpty(), QString::isNull(), and QComboBox::setInsertionPolicy().
.SS "int KToolBar::insertSeparator (int index = -1, int id = -1)"
.PP
Inserts a separator into the toolbar with the given id. Returns the separator's index Definition at line 370 of file ktoolbar.cpp.
.SS "int KToolBar::insertLineSeparator (int index = -1, int id = -1)"
.PP
Inserts a line separator into the toolbar with the given id. Returns the separator's index Definition at line 377 of file ktoolbar.cpp.
.SS "int KToolBar::insertWidget (int id, int width, \fBQWidget\fP * _widget, int index = -1)"
.PP
Inserts a user-defined widget. The widget \fCmust\fP have this toolbar as its parent.
.PP
Widget must have a \fBQWidget\fP for base class. Widget can be autosized to full width. If you forget about it, you can get a pointer to this widget with \fBgetWidget\fP(). 
.PP
\fBSee also:\fP
.RS 4
\fBsetItemAutoSized()\fP 
.RE
.PP
\fBReturns:\fP
.RS 4
Item index. 
.RE
.PP
Definition at line 385 of file ktoolbar.cpp.
.PP
Referenced by KWidgetAction::plug().
.SS "int KToolBar::insertAnimatedWidget (int id, \fBQObject\fP * receiver, const char * slot, const \fBQString\fP & icons, int index = -1)"
.PP
Inserts an animated widget. A \fBKAnimWidget\fP will be created internally using the icon name you provide. This will emit a signal (\fBclicked()\fP) whenever the animation widget is clicked.
.PP
\fBSee also:\fP
.RS 4
\fBanimatedWidget()\fP
.RE
.PP
\fBParameters:\fP
.RS 4
\fIid\fP The id for this toolbar item 
.br
\fIreceiver\fP The parent of your slot 
.br
\fIslot\fP The slot to receive the \fBclicked()\fP signal 
.br
\fIicons\fP The name of the animation icon group to use 
.br
\fIindex\fP The item index
.RE
.PP
\fBReturns:\fP
.RS 4
The item index 
.RE
.PP
Definition at line 392 of file ktoolbar.cpp.
.PP
References clicked().
.SS "\fBKAnimWidget\fP * KToolBar::animatedWidget (int id)"
.PP
This will return a pointer to the given animated widget, if it exists. \fBSee also:\fP
.RS 4
\fBinsertAnimatedWidget\fP
.RE
.PP
\fBParameters:\fP
.RS 4
\fIid\fP The id for the widget you want to get a pointer to
.RE
.PP
\fBReturns:\fP
.RS 4
A pointer to the current animated widget or 0L 
.RE
.PP
Definition at line 404 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and QObject::inherits().
.SS "void KToolBar::addConnection (int id, const char * signal, const \fBQObject\fP * receiver, const char * slot)"
.PP
Adds connections to items. It is important that you know the \fCid\fP of particular item. Nothing happens if you forget \fCid\fP. Definition at line 430 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.SS "void KToolBar::setItemEnabled (int id, bool enabled)"
.PP
Enables/disables item. Definition at line 440 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.SS "void KToolBar::setButtonIcon (int id, const \fBQString\fP & _icon)"
.PP
Sets the icon for a button. Can be used while button is visible. Definition at line 461 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and KToolBarButton::setIcon().
.SS "void KToolBar::setButtonPixmap (int id, const \fBQPixmap\fP & _pixmap)"
.PP
Sets button pixmap. Can be used while button is visible. Definition at line 450 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and KToolBarButton::setPixmap().
.SS "void KToolBar::setButtonIconSet (int id, const \fBQIconSet\fP & iconset)"
.PP
Sets a button icon from a \fBQIconSet\fP. Can be used while button is visible. Definition at line 471 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and KToolBarButton::setIconSet().
.SS "void KToolBar::setDelayedPopup (int id, \fBQPopupMenu\fP * _popup, bool toggle = false)"
.PP
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.
.PP
You will insert normal a button with connection (or use signals from toolbar): 
.PP
.nf

 bar->insertButton(icon, id, SIGNAL(clicked ()), this,
                   SLOT (slotClick()), true, 'click or wait for popup');
 
.PP
 And then add a delayed popup: 
.PP
.nf

 bar->setDelayedPopup (id, historyPopup); 
.PP
.PP
Don't add delayed popups to buttons which have normal popups.
.PP
You may add popups which are derived from \fBQPopupMenu\fP. You may add popups that are already in the menu bar or are submenus of other popups. Definition at line 482 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and KToolBarButton::setDelayedPopup().
.PP
Referenced by KToolBarPopupAction::plug(), and KActionMenu::plug().
.SS "void KToolBar::setAutoRepeat (int id, bool flag = true)"
.PP
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 \fBclicked()\fP, but not \fBpressed()\fP or \fBreleased()\fP. When the user presses this button, you will receive the signal \fBclicked()\fP, and if the button is still pressed after some time, you will receive more \fBclicked()\fP signals separated by regular intervals. Since this uses \fBQButton::setAutoRepeat\fP() , I can't quantify 'some'. Definition at line 493 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.SS "void KToolBar::setToggle (int id, bool flag = true)"
.PP
Turns button into a toggle button if \fCflag\fP is true. Definition at line 504 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and KToolBarButton::setToggle().
.PP
Referenced by KToggleAction::plug().
.SS "void KToolBar::toggleButton (int id)"
.PP
Toggles a togglebutton. If the button is a toggle button (see \fBsetToggle\fP()) the button state will be toggled. This will also cause the toolbar to emit the signal \fBKButton::toggled\fP() with parameter \fCid\fP. You must connect to this signal, or use \fBaddConnection\fP() to connect directly to the button signal \fBKButton::toggled\fP(). Definition at line 515 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and KToolBarButton::toggle().
.SS "void KToolBar::setButton (int id, bool flag)"
.PP
Sets a toggle button state. If the button is a toggle button (see \fBsetToggle\fP()) this will set its state flag. This will also emit the signal \fBKButton::toggled\fP().
.PP
\fBSee also:\fP
.RS 4
\fBsetToggle()\fP 
.RE
.PP
Definition at line 526 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and KToolBarButton::on().
.PP
Referenced by KToggleAction::plug().
.SS "bool KToolBar::isButtonOn (int id) const"
.PP
\fBReturns:\fP
.RS 4
\fCtrue\fP if button is on, \fCfalse\fP if button is off or if the button is not a toggle button. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetToggle()\fP 
.RE
.PP
Definition at line 537 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.SS "void KToolBar::setLinedText (int id, const \fBQString\fP & text)"
.PP
Sets the text of a line editor. Cursor is set at end of text. Definition at line 547 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and QLineEdit::setText().
.SS "\fBQString\fP KToolBar::getLinedText (int id) const"
.PP
Returns a line editor text. Definition at line 558 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and QLineEdit::text().
.SS "void KToolBar::insertComboItem (int id, const \fBQString\fP & text, int index)"
.PP
Inserts \fCtext\fP in combobox \fCid\fP at position \fCindex\fP. Definition at line 568 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and QComboBox::insertItem().
.SS "void KToolBar::insertComboList (int id, const \fBQStringList\fP & list, int index)"
.PP
Inserts \fClist\fP in combobox \fCid\fP at position \fCindex\fP. Definition at line 578 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and QComboBox::insertStringList().
.SS "void KToolBar::removeComboItem (int id, int index)"
.PP
Removes item \fCindex\fP from combobox \fCid\fP. Definition at line 589 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and QComboBox::removeItem().
.SS "void KToolBar::setCurrentComboItem (int id, int index)"
.PP
Sets item \fCindex\fP to be current item in combobox \fCid\fP. Definition at line 600 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and QComboBox::setCurrentItem().
.SS "void KToolBar::changeComboItem (int id, const \fBQString\fP & text, int index = -1)"
.PP
Changes item \fCindex\fP in combobox \fCid\fP to text. \fCindex\fP = -1 refers current item (one displayed in the button). Definition at line 611 of file ktoolbar.cpp.
.PP
References QComboBox::changeItem(), QMap::end(), and QMap::find().
.SS "void KToolBar::clearCombo (int id)"
.PP
Clears the combobox \fCid\fP. Does not delete it or hide it. Definition at line 622 of file ktoolbar.cpp.
.PP
References QComboBox::clear(), QMap::end(), and QMap::find().
.SS "\fBQString\fP KToolBar::getComboItem (int id, int index = -1) const"
.PP
Returns text of item \fCindex\fP from combobox \fCid\fP. \fCindex\fP = -1 refers to current item. Definition at line 633 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and QComboBox::text().
.SS "\fBKComboBox\fP * KToolBar::getCombo (int id)"
.PP
Returns a pointer to the combobox. Example: 
.PP
.nf

 \fBKComboBox\fP *combo = toolbar->getCombo(combo_id);
 
.PP
 That way you can get access to other public methods that \fBKComboBox\fP provides. Definition at line 643 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.PP
Referenced by KSelectAction::plug().
.SS "\fBKLineEdit\fP * KToolBar::getLined (int id)"
.PP
Returns a pointer to KToolBarLined. Example: 
.PP
.nf

 \fBKLineEdit\fP * lined = toolbar->getKTollBarLined(lined_id);
 
.PP
 That way you can get access to other public methods that \fBKLineEdit\fP provides. \fBKLineEdit\fP is the same thing as \fBQLineEdit\fP plus completion signals. Definition at line 652 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.SS "\fBKToolBarButton\fP * KToolBar::getButton (int id)"
.PP
Returns a pointer to \fBKToolBarButton\fP. Example: 
.PP
.nf

 \fBKToolBarButton\fP * button = toolbar->getButton(button_id);
 
.PP
 That way you can get access to other public methods that \fBKToolBarButton\fP provides.
.PP
Using this method is not recommended. Definition at line 661 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.PP
Referenced by KToolBarRadioGroup::addButton(), KToolBarPopupAction::plug(), KActionMenu::plug(), and KAction::plug().
.SS "void KToolBar::alignItemRight (int id, bool right = true)"
.PP
Align item to the right. This works only if toolbar is set to full width. 
.PP
\fBSee also:\fP
.RS 4
setFullWidth() 
.RE
.PP
Definition at line 670 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.SS "\fBQWidget\fP * KToolBar::getWidget (int id)"
.PP
Returns a pointer to an inserted widget. Wrong ids are not tested. You can do with this whatever you want, except change its height (hardcoded). If you change its width you will probably have to call QToolBar::updateRects(true) 
.PP
\fBSee also:\fP
.RS 4
\fBQWidget\fP 
.PP
updateRects() 
.RE
.PP
Definition at line 682 of file ktoolbar.cpp.
.PP
References QMap::end(), and QMap::find().
.PP
Referenced by hideItem(), setItemAutoSized(), and showItem().
.SS "void KToolBar::setItemAutoSized (int id, bool yes = true)"
.PP
Set item autosized. This works only if the toolbar is set to full width. Only \fCone\fP item can be autosized, and it has to be the last left-aligned item. Items that come after this must be right aligned. Items that can be right aligned are Lineds, Frames, Widgets and Combos. An autosized item will resize itself whenever the toolbar geometry changes to the last right-aligned item (or to end of toolbar if there are no right-aligned items.) 
.PP
\fBSee also:\fP
.RS 4
setFullWidth() 
.PP
\fBalignItemRight()\fP 
.RE
.PP
Definition at line 689 of file ktoolbar.cpp.
.PP
References getWidget(), and QToolBar::setStretchableWidget().
.PP
Referenced by KWidgetAction::plug().
.SS "void KToolBar::clear ()"
.PP
Remove all items. The toolbar is redrawn after it. Reimplemented from \fBQToolBar\fP.
.PP
Definition at line 697 of file ktoolbar.cpp.
.PP
References QMap::clear(), QMap< QWidget *, int >::clear(), and QToolBar::clear().
.SS "void KToolBar::removeItem (int id)"
.PP
Remove item \fCid\fP. Item is deleted. Toolbar is redrawn after it. Definition at line 705 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), QMap< QWidget *, int >::remove(), QMap::remove(), and QPtrList< QWidget >::removeRef().
.PP
Referenced by KAction::unplug().
.SS "void KToolBar::hideItem (int id)"
.PP
Hide item. Definition at line 721 of file ktoolbar.cpp.
.PP
References getWidget(), and QWidget::hide().
.SS "void KToolBar::showItem (int id)"
.PP
Show item. Definition at line 729 of file ktoolbar.cpp.
.PP
References getWidget(), and QWidget::show().
.SS "void KToolBar::setFullSize (bool flag = true)"
.PP
Set toolbar to full parent size (default). In full size mode the bar extends over the parent's full width or height. If the mode is disabled the toolbar tries to take as much space as it needs without wrapping, but it does not exceed the parent box. You can force a certain width or height with \fBsetMaxWidth\fP() or \fBsetMaxHeight\fP().
.PP
If you want to use right-aligned items or auto-sized items you must use full size mode. Definition at line 737 of file ktoolbar.cpp.
.SS "bool KToolBar::fullSize () const"
.PP
\fBReturns:\fP
.RS 4
\fCtrue\fP if the full-size mode is enabled. Otherwise it returns . 
.RE
.PP
Definition at line 744 of file ktoolbar.cpp.
.SS "void KToolBar::enableMoving (bool flag = true)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP use setMovingEnabled(bool) instead. Enable or disable moving of toolbar. Definition at line 750 of file ktoolbar.cpp.
.SS "void KToolBar::setBarPos (\fBBarPosition\fP bpos)"
.PP
Set position of toolbar. \fBSee also:\fP
.RS 4
\fBBarPosition()\fP 
.RE
.PP
Definition at line 756 of file ktoolbar.cpp.
.PP
References QToolBar::mainWindow().
.SS "\fBKToolBar::BarPosition\fP KToolBar::barPos () const"
.PP
Returns position of toolbar. Definition at line 764 of file ktoolbar.cpp.
.PP
References BarPosition, and QToolBar::mainWindow().
.PP
Referenced by KMainWindow::sizeForCentralWidgetSize().
.SS "bool KToolBar::enable (\fBBarStatus\fP stat)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Show, hide, or toggle toolbar. This method is provided for compatibility only, please use show() and/or hide() instead. 
.PP
\fBSee also:\fP
.RS 4
\fBBarStatus\fP 
.RE
.PP
Definition at line 779 of file ktoolbar.cpp.
.PP
References KIO::stat().
.SS "void KToolBar::setMaxHeight (int h)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use setMaximumHeight() instead. Definition at line 792 of file ktoolbar.cpp.
.SS "int KToolBar::maxHeight ()"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use maximumHeight() instead. Returns the value that was set with \fBsetMaxHeight\fP(). Definition at line 797 of file ktoolbar.cpp.
.SS "void KToolBar::setMaxWidth (int dw)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use setMaximumWidth() instead. Set maximal width of horizontal (top or bottom) toolbar. Definition at line 803 of file ktoolbar.cpp.
.SS "int KToolBar::maxWidth ()"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use maximumWidth() instead. Returns the value that was set with \fBsetMaxWidth\fP(). Definition at line 809 of file ktoolbar.cpp.
.SS "void KToolBar::setTitle (const \fBQString\fP & _title)"
.PP
Set title for toolbar when it floats. Titles are however not (yet) visible. You can't change toolbar's title while it's floating. Definition at line 815 of file ktoolbar.cpp.
.PP
References QToolBar::setLabel().
.SS "void KToolBar::enableFloating (bool arrrrrrgh)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Use \fBenableMoving()\fP instead. Definition at line 821 of file ktoolbar.cpp.
.SS "void KToolBar::setIconText (IconText it)"
.PP
Set the kind of painting for buttons. Choose from: 
.IP "\(bu" 2
IconOnly (only icons), 
.IP "\(bu" 2
IconTextRight (icon and text, text is left from icons), 
.IP "\(bu" 2
TextOnly (only text), 
.IP "\(bu" 2
IconTextBottom (icons and text, text is under icons). 
.PP
\fBSee also:\fP
.RS 4
IconText 
.RE
.PP

.PP
Definition at line 826 of file ktoolbar.cpp.
.SS "void KToolBar::setIconText (IconText it, bool update)"
.PP
Similar to \fBsetIconText\fP(IconText it) but allows you to disable or enable updating. If \fCupdate\fP is false, then the buttons will not be updated. This is useful only if you know that you will be forcing an update later. Definition at line 832 of file ktoolbar.cpp.
.PP
References QToolBar::mainWindow().
.SS "KToolBar::IconText KToolBar::iconText () const"
.PP
\fBReturns:\fP
.RS 4
The current text style for buttons. 
.RE
.PP
Definition at line 858 of file ktoolbar.cpp.
.SS "void KToolBar::setIconSize (int size)"
.PP
Set the icon size to load. Usually you should not call this, the icon size is taken care of by \fBKIconLoader\fP and globally configured. By default, the toolbar will load icons of size 32 for main toolbars and 22 for other toolbars 
.PP
\fBSee also:\fP
.RS 4
\fBKIconLoader\fP.
.RE
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP The size to use 
.RE
.PP
Definition at line 864 of file ktoolbar.cpp.
.SS "void KToolBar::setIconSize (int size, bool update)"
.PP
Same as \fBsetIconText\fP(int size) but allows you to disable the toolbar update. \fBParameters:\fP
.RS 4
\fIsize\fP The size to use 
.br
\fIupdate\fP If true, then the toolbar will be updated after this 
.RE
.PP
Definition at line 869 of file ktoolbar.cpp.
.PP
References QToolBar::mainWindow().
.SS "int KToolBar::iconSize () const"
.PP
\fBReturns:\fP
.RS 4
The current icon size for buttons. 
.RE
.PP
Definition at line 895 of file ktoolbar.cpp.
.PP
References KIconLoader::currentSize(), KGlobal::iconLoader(), and QObject::name().
.PP
Referenced by saveSettings().
.SS "void KToolBar::setEnableContextMenu (bool enable = true)"
.PP
This allows you to enable or disable the context menu. \fBParameters:\fP
.RS 4
\fIenable\fP If false, then the context menu will be disabled 
.RE
.PP
Definition at line 908 of file ktoolbar.cpp.
.SS "bool KToolBar::contextMenuEnabled () const"
.PP
Returns whether or not the context menu is disabled. \fBReturns:\fP
.RS 4
The context menu state 
.RE
.PP
Definition at line 914 of file ktoolbar.cpp.
.SS "void KToolBar::setItemNoStyle (int id, bool no_style = true)"
.PP
This will inform a toolbar button to ignore certain style changes. Specifically, it will ignore IconText (always IconOnly) and will not allow image effects to apply.
.PP
\fBParameters:\fP
.RS 4
\fIid\fP The button to exclude from styles 
.br
\fIno_style\fP If true, then it is excluded (default: true). 
.RE
.PP
Definition at line 920 of file ktoolbar.cpp.
.PP
References QMap::end(), QMap::find(), and KToolBarButton::setNoStyle().
.SS "int KToolBar::count () const"
.PP
\fBReturns:\fP
.RS 4
the number of items in the toolbar 
.RE
.PP
Definition at line 945 of file ktoolbar.cpp.
.PP
References QMap::count().
.SS "void KToolBar::saveState ()"
.PP
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). Definition at line 951 of file ktoolbar.cpp.
.PP
References QDomElement::attribute(), KGlobal::config(), QDomDocument::documentElement(), KStdAccel::name(), KXMLGUIFactory::removeDOMComments(), saveSettings(), QDomDocument::setContent(), KConfigBase::sync(), and QDomElement::tagName().
.PP
Referenced by KXMLGUIBuilder::removeContainer().
.SS "void KToolBar::saveSettings (\fBKConfig\fP * config, const \fBQString\fP & configGroup)"
.PP
Save the toolbar settings to group \fCconfigGroup\fP in \fCconfig\fP. Definition at line 1034 of file ktoolbar.cpp.
.PP
References iconSize(), QString::isEmpty(), and KConfigBase::writeEntry().
.PP
Referenced by KMainWindow::saveMainWindowSettings(), and saveState().
.SS "void KToolBar::applySettings (\fBKConfig\fP * config, const \fBQString\fP & configGroup)"
.PP
Read the toolbar settings from group \fCconfigGroup\fP in \fCconfig\fP and apply them. Definition at line 1515 of file ktoolbar.cpp.
.PP
References KConfigBase::hasGroup(), QString::isEmpty(), QString::lower(), QToolBar::mainWindow(), QMainWindow::moveDockWindow(), KConfigBase::readBoolEntry(), KConfigBase::readEntry(), KConfigBase::readNumEntry(), and KGlobal::staticQString().
.PP
Referenced by KMainWindow::applyMainWindowSettings().
.SS "void KToolBar::setXMLGUIClient (\fBKXMLGUIClient\fP * client)"
.PP
Tell the toolbar what XML-GUI resource file it should use to save it's state. The state of the toolbar (position, size, etc) is saved in \fBKConfig\fP files if the application does not use XML-GUI.. but if the app does, then it's saved the XML file. This function allows this to happen.
.PP
\fBParameters:\fP
.RS 4
\fIxmlfile\fP The XML-GUI resource file to write to 
.br
\fIxml\fP The DOM document for the XML-GUI building 
.RE
.PP
Definition at line 1062 of file ktoolbar.cpp.
.PP
Referenced by KXMLGUIBuilder::createContainer().
.SS "void KToolBar::setText (const \fBQString\fP & txt)"
.PP
Assign a (translated) text to this toolbar. This is used for the tooltip on the handle, and when listing the toolbars. Definition at line 1067 of file ktoolbar.cpp.
.PP
References QToolBar::setLabel().
.SS "\fBQString\fP KToolBar::text () const"
.PP
\fBReturns:\fP
.RS 4
the toolbar's text. 
.RE
.PP
Definition at line 1073 of file ktoolbar.cpp.
.PP
References QToolBar::label().
.SS "void KToolBar::clicked (int id)\fC [signal]\fP"
.PP
Emitted when button \fCid\fP is clicked. Referenced by insertAnimatedWidget().
.SS "void KToolBar::doubleClicked (int id)\fC [signal]\fP"
.PP
Emitted when button \fCid\fP is double-clicked. Note: you will always recive two \fBclicked\fP() , \fBpressed\fP() and \fBreleased\fP() signals. There is no way to avoid it - at least no easy way. If you need to resolve this all you can do is set up timers which wait for \fBQApplication::doubleClickInterval\fP() to expire. If in that time you don't get this signal, you may belive that button was only clicked and not double-clicked. And please note that butons with popup menus do not emit this signal, but those with delayed popup do. 
.SS "void KToolBar::pressed (int)\fC [signal]\fP"
.PP
Emitted when button \fCid\fP is pressed. 
.SS "void KToolBar::released (int)\fC [signal]\fP"
.PP
Emits when button \fCid\fP is released. 
.SS "void KToolBar::toggled (int)\fC [signal]\fP"
.PP
Emitted when a toggle button changes state. Emitted also if you change state with \fBsetButton\fP() or \fBtoggleButton\fP() If you make a button normal again, with setToggle(false), this signal won't be emitted. 
.SS "void KToolBar::highlighted (int id, bool isHighlighted)\fC [signal]\fP"
.PP
This signal is emitted when item id gets highlighted/unhighlighted (i.e when mouse enters/exits). Note that this signal is emitted from all buttons (normal, disabled and toggle) even when there is no visible change in buttons (i.e., buttons do not raise when mouse enters). The parameter \fCisHighlighted\fP is \fCtrue\fP when mouse enters and \fCfalse\fP when mouse exits. 
.SS "void KToolBar::highlighted (int id)\fC [signal]\fP"
.PP
This signal is emitted when item id gets highlighted/unhighlighted (i.e when mouse enters/exits). Note that this signal is emitted from all buttons (normal, disabled and toggle) even when there is no visible change in buttons (i.e., buttons do not raise when mouse enters). 
.SS "void KToolBar::moved (\fBBarPosition\fP)\fC [signal]\fP"
.PP
Emitted when toolbar changes position, or when an item is removed from toolbar. If you subclass \fBKMainWindow\fP and reimplement \fBKMainWindow::resizeEvent\fP() be sure to connect to this signal. Note: You can connect this signal to a slot that doesn't take parameter. 
.SS "void KToolBar::toolbarDestroyed ()\fC [signal]\fP"
.PP
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). Used by \fBKWidgetAction\fP. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.SS "bool KToolBar::highlightSetting ()\fC [static]\fP"
.PP
\fBReturns:\fP
.RS 4
global setting for 'Highlight buttons under mouse' 
.RE
.PP
Definition at line 1378 of file ktoolbar.cpp.
.PP
References KGlobal::config(), QString::fromLatin1(), and KConfigBase::readBoolEntry().
.SS "bool KToolBar::transparentSetting ()\fC [static]\fP"
.PP
\fBReturns:\fP
.RS 4
global setting for 'Toolbars transparent when moving' 
.RE
.PP
Definition at line 1386 of file ktoolbar.cpp.
.PP
References KGlobal::config(), QString::fromLatin1(), and KConfigBase::readBoolEntry().
.SS "KToolBar::IconText KToolBar::iconTextSetting ()\fC [static]\fP"
.PP
\fBReturns:\fP
.RS 4
global setting for 'Icon Text' 
.RE
.PP
Definition at line 1394 of file ktoolbar.cpp.
.PP
References KGlobal::config(), QString::fromLatin1(), and KConfigBase::readEntry().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
