---

KToolBarButton Class Reference

#include <ktoolbarbutton.h>

List of all members.

Public Slots
void	modeChange ()
Public Methods
	KToolBarButton (const QString &icon, int id, QWidget *parent, const char *name=0L, const QString &txt=QString::null, KInstance *_instance=KGlobal::instance())
	KToolBarButton (const QPixmap &pixmap, int id, QWidget *parent, const char *name=0L, const QString &txt=QString::null)
	KToolBarButton (QWidget *parent=0L, const char *name=0L)
	~KToolBarButton ()
virtual void	setPixmap (const QPixmap &pixmap)
void	setDefaultPixmap (const QPixmap &pixmap)
void	setDisabledPixmap (const QPixmap &pixmap)
virtual void	setText (const QString &text)
virtual void	setIcon (const QString &icon)
virtual void	setIcon (const QPixmap &pixmap)
	Since: 3.1
virtual void	setIconSet (const QIconSet &iconset)
void	setIcon (const QString &icon, bool)
void	setDefaultIcon (const QString &icon)
void	setDisabledIcon (const QString &icon)
void	on (bool flag=true)
void	toggle ()
void	setToggle (bool toggle=true)
QPopupMenu *	popup ()
void	setPopup (QPopupMenu *p, bool toggle=false)
void	setDelayedPopup (QPopupMenu *p, bool toggle=false)
void	setRadio (bool f=true)
void	setNoStyle (bool no_style=true)
Protected Methods
bool	isRaised () const
	Since: 3.1
bool	isActive () const
	Since: 3.1
int	iconTextMode () const
	Since: 3.1

---

Detailed Description

A toolbar button. This is used internally by KToolBar, use the KToolBar methods instead.

Definition at line 45 of file ktoolbarbutton.h.

---

Constructor & Destructor Documentation

KToolBarButton::KToolBarButton (  const QString &    icon, int    id, QWidget *    parent, const char *    name = 0L, const QString &    txt = QString::null, KInstance *    _instance = KGlobal::instance() )

Construct a button with an icon loaded by the button itself. This will trust the button to load the correct icon with the correct size. Parameters: icon  Name of icon to load (may be absolute or relative) id  Id of this button parent  This button's parent name  This button's internal name txt  This button's text (in a tooltip or otherwise)

KToolBarButton::KToolBarButton (  const QPixmap &    pixmap, int    id, QWidget *    parent, const char *    name = 0L, const QString &    txt = QString::null )

Construct a button with an existing pixmap. It is not recommended that you use this as the internal icon loading code will almost always get it "right". Parameters: icon  Name of icon to load (may be absolute or relative) id  Id of this button parent  This button's parent name  This button's internal name txt  This button's text (in a tooltip or otherwise)

KToolBarButton::KToolBarButton (  QWidget *    parent = 0L, const char *    name = 0L )

Construct a separator button Parameters: parent  This button's parent name  This button's internal name

KToolBarButton::~KToolBarButton (    )

Standard destructor

---

Member Function Documentation

void KToolBarButton::modeChange (    )  [slot]

This slot should be called whenever the toolbar mode has potentially changed. This includes such events as text changing, orientation changing, etc.

void KToolBarButton::on (  bool    flag = true )

Turn this button on or off Parameters: flag  true or false

QPopupMenu* KToolBarButton::popup (    )

Return a pointer to this button's popup menu (if it exists)

void KToolBarButton::setDefaultIcon (  const QString &    icon )

Deprecated: Force the button to use this icon as the default one rather then generating it using effects. Parameters: icon  The icon to use as the default (normal) one

void KToolBarButton::setDefaultPixmap (  const QPixmap &    pixmap )

Deprecated: Force the button to use this pixmap as the default one rather then generating it using effects. Parameters: pixmap  The pixmap to use as the default (normal) one

void KToolBarButton::setDelayedPopup (  QPopupMenu *    p, bool    toggle = false )

Gives this button a delayed popup menu. This function allows you to add a delayed popup menu to the button. The popup menu is then only displayed when the button is pressed and held down for about half a second. You can also make the popup-menu "sticky", i.e. visible until a selection is made or the mouse is clikced elsewhere, by simply setting the second argument to true. This "sticky" button feature allows you to make a selection without having to press and hold down the mouse while making a selection. Parameters: p  the new popup menu toggle  if true, makes the button "sticky" (toggled)

void KToolBarButton::setDisabledIcon (  const QString &    icon )

Deprecated: Force the button to use this icon when disabled one rather then generating it using effects. Parameters: icon  The icon to use when disabled

void KToolBarButton::setDisabledPixmap (  const QPixmap &    pixmap )

Deprecated: Force the button to use this pixmap when disabled one rather then generating it using effects. Parameters: pixmap  The pixmap to use when disabled

void KToolBarButton::setIcon (  const QString &    icon, bool    )  [inline]

Deprecated: Set the active icon for this button. The pixmap itself is loaded internally based on the icon size... .. the disabled and default pixmaps, however will only be constructed if generate is true. This function is preferred over setPixmap Parameters: icon  The name of the active icon generate  If true, then the other icons are automagically generated from this one Definition at line 164 of file ktoolbarbutton.h. References setIcon().

virtual void KToolBarButton::setIcon (  const QString &    icon )  [virtual]

Set the icon for this button. The icon will be loaded internally with the correct size. This function is preferred over setIconSet Parameters: icon  The name of the icon Referenced by setIcon().

virtual void KToolBarButton::setIconSet (  const QIconSet &    iconset )  [virtual]

Set the pixmaps for this toolbar button from a QIconSet. If you call this you don't need to call any of the other methods that set icons or pixmaps. Parameters: iconset  The iconset to use

void KToolBarButton::setNoStyle (  bool    no_style = true )

Toolbar buttons naturally will assume the global styles concerning icons, icons sizes, etc. You can use this function to explicitely turn this off, if you like. Parameters: no_style  Will disable styles if true

virtual void KToolBarButton::setPixmap (  const QPixmap &    pixmap )  [virtual]

Deprecated: Set the pixmap directly for this button. This pixmap should be the active one... the dimmed and disabled pixmaps are constructed based on this one. However, don't use this function unless you are positive that you don't want to use setIcon. Parameters: pixmap  The active pixmap

void KToolBarButton::setPopup (  QPopupMenu *    p, bool    toggle = false )

Give this button a popup menu. There will not be a delay when you press the button. Use setDelayedPopup if you want that behavior. You can also make the popup-menu "sticky", i.e. visible until a selection is made or the mouse is clikced elsewhere, by simply setting the second argument to true. This "sticky" button feature allows you to make a selection without having to press and hold down the mouse while making a selection. Parameters: p  The new popup menu toggle  if true, makes the button "sticky" (toggled)

void KToolBarButton::setRadio (  bool    f = true )

Turn this button into a radio button Parameters: f  true or false

virtual void KToolBarButton::setText (  const QString &    text )  [virtual]

Set the text for this button. The text will be either used as a tooltip (IconOnly) or will be along side the icon Parameters: text  The button (or tooltip) text

void KToolBarButton::setToggle (  bool    toggle = true )

Turn this button into a toggle button or disable the toggle aspects of it. This does not toggle the button itself. Use toggle() for that. Parameters: toggle  true or false

void KToolBarButton::toggle (    )

Toggle this button

---

The documentation for this class was generated from the following file:

• ktoolbarbutton.h

---