# toolbutton class

Provides a toolbutton for toolbar widget.

Inherits
object widget
Description
The toolbutton class provides a quick-access button to commands or options, usually used inside a ToolBar.
Functions

`$setImage(<icon_id:string>)`
Sets the image for this button.
`$setUsesBigPixmap(<bEnabled:boolean>)`
Sets whether this toolbutton uses big pixmaps to enable.
`$usesBigPixmap(<bEnabled:boolean>)`
This property holds whether this toolbutton uses big pixmaps.
`setUsesTextLabel(<bEnabled:boolean>)`
Sets whether the toolbutton show a texlabel below the pixmap of the button.
`$usesTextLabel()`
Return 1 if the setUsesTextLabel is enabled, otherwise return 0.
`$setTextLabel(<text:String>,[tooltip:string])`
Sets the label of this button to <text> and automatically sets it as a tool tip if <tip> is TRUE.
`<string> $textLabel()`
Returns the label of tthe button.
`$setAutoRaise(<bAutoraise:boolean>)`
Sets whether auto-raising is enabled.
`<boolean> $autoRaise()`
Returns 1 if autoRaise is enabled, otherwise returns 0.
`$setToggleButton(<bToggle:boolean>)`
Sets whether the tool button is a toggle button 1 enable, 0 disable.
`<boolean> $toggle()`
Toggles the state of the tool button.
`$setOn(<bEnabled:boolean>)`
Sets whether the tool button is on to the bool value: 1 enable, 0 disable.
`$setPopup (<popupmenu:object>)`
Associates the given <popupmenu> with this tool button.
`$openPopup()`
Opens the associated popup menu. If there is no such menu, this function does nothing.
`setTextPosition(<text_position:string>)`
Sets the position of the tool button's textLabel in relation to the tool button's icon. Valid texpos values are: - BesideIcon : The text appears beside the icon. - BelowIcon : The text appears below the icon.
`<string> $textPosition()`
Returns the position of the text label of this button.
`$clickEvent()`
This function is called when the toolbutton is clicked. You can reimplement it to handle the user click events. The default implementation emits the $clicked() signal.

Signals

`$clicked()`
This signal is emitted by the default implementation of $clickEvent().

Index, Object Classes

KVIrc 4.2.0.6190 Documentation
Generated by root at Mon Sep 23 13:56:02 2013