kdeui Library API Documentation

KToggleToolBarAction Class Reference

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

#include <kaction.h>

Inheritance diagram for KToggleToolBarAction:

KToggleAction KAction QObject List of all members.

Public Slots

virtual void setChecked (bool)
 Sets the state of the action.


Public Methods

 KToggleToolBarAction (const char *toolBarName, const QString &text, KActionCollection *parent, const char *name)
 Create a KToggleToolbarAction that manages the toolbar named toolBarName.

virtual int plug (QWidget *, int index=-1)
 "Plug" or insert this action into a given widget.


Protected Methods

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 1659 of file kaction.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 2852 of file kaction.cpp.


Member Function Documentation

int KToggleToolBarAction::plug QWidget  ,
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 2871 of file kaction.cpp.

References QObject::connect(), QWidget::isDialog(), QObject::name(), QWidget::parentWidget(), KToggleAction::plug(), setChecked(), KAction::setEnabled(), and KMainWindow::toolBar().

void KToggleToolBarAction::setChecked bool    [virtual, slot]
 

Sets the state of the action.

Reimplemented from KToggleAction.

Definition at line 2901 of file kaction.cpp.

References KToggleAction::setChecked().

Referenced by plug().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:07 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001