KToggleToolBarAction Class Reference

An action that takes care of everything associated with showing or hiding a toolbar by a menu action. More...

#include <kactionclasses.h>

Inheritance diagram for KToggleToolBarAction:

[legend]

List of all members.

Public Slots
virtual void	setChecked (bool)
Public Member Functions
	KToggleToolBarAction (KToolBar *toolBar, const QString &text, KActionCollection *parent, const char *name)
	KToggleToolBarAction (const char *toolBarName, const QString &text, KActionCollection *parent, const char *name)
virtual int	plug (QWidget *widget, int index=-1)
KToolBar *	toolBar ()
virtual	~KToggleToolBarAction ()
Protected Member Functions
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

An action that takes care of everything associated with showing or hiding a toolbar by a menu action.

It will show or hide the toolbar with the given name when activated, and check or uncheck itself if the toolbar is manually shown or hidden.

If you need to perfom some additional action when the toolbar is shown or hidden, connect to the toggled(bool) signal. It will be emitted after the toolbar's visibility has changed, whenever it changes.

Since:

3.1

Definition at line 1208 of file kactionclasses.h.

---

Constructor & Destructor Documentation

KToggleToolBarAction::KToggleToolBarAction	(	const char *	toolBarName,
		const QString &	text,
		KActionCollection *	parent,
		const char *	name
	)

Create a KToggleToolbarAction that manages the toolbar named toolBarName.

This can be either the name of a toolbar in an xml ui file, or a toolbar programmatically created with that name.

Definition at line 1979 of file kactionclasses.cpp.

KToggleToolBarAction::KToggleToolBarAction	(	KToolBar *	toolBar,
		const QString &	text,
		KActionCollection *	parent,
		const char *	name
	)

Definition at line 1987 of file kactionclasses.cpp.

KToggleToolBarAction::~KToggleToolBarAction

(

)

[virtual]

Definition at line 1994 of file kactionclasses.cpp.

---

Member Function Documentation

int KToggleToolBarAction::plug	(	QWidget *	widget,
		int	index = -1
	)			[virtual]

"Plug" or insert this action into a given widget.

This will typically be a menu or a toolbar. From this point on, you will never need to directly manipulate the item in the menu or toolbar. You do all enabling/disabling/manipulation directly with your KToggleAction object.

Parameters:

	widget	The GUI element to display this action.
	index	The index of the item.

Reimplemented from KToggleAction.

Definition at line 1998 of file kactionclasses.cpp.

void KToggleToolBarAction::setChecked

(

bool

c

)

[virtual, slot]

Sets the state of the action.

Reimplemented from KToggleAction.

Definition at line 2028 of file kactionclasses.cpp.

KToolBar* KToggleToolBarAction::toolBar

(

)

[inline]

Definition at line 1226 of file kactionclasses.h.

void KToggleToolBarAction::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KToggleAction.

Definition at line 2383 of file kactionclasses.cpp.

---

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

• kactionclasses.h
• kactionclasses.cpp