KToggleToolBarAction Class Reference

#include <ktoggletoolbaraction.h>

Inheritance diagram for KToggleToolBarAction:

Classes
class	Private

Public Member Functions
bool	eventFilter (QObject *watched, QEvent *event) override
	KToggleToolBarAction (const char *toolBarName, const QString &text, QObject *parent)
	KToggleToolBarAction (KisToolBar *toolBar, const QString &text, QObject *parent)
KisToolBar *	toolBar ()
	~KToggleToolBarAction () override

Private Slots
void	slotToggled (bool checked) override

Private Attributes
Private *const	d

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 perform 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.

Definition at line 35 of file ktoggletoolbaraction.h.

Constructor & Destructor Documentation

KToggleToolBarAction() [1/2]

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

Create a KisKToggleToolbarAction 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.

Parameters

toolBarName	The toolbar name.
text	The toolbar hint text.
parent	The action's parent object.

Definition at line 40 of file ktoggletoolbaraction.cpp.

    : KToggleAction(text, parent),
      d(new Private)
{
    d->toolBarName = toolBarName;
}

References d, and KToggleToolBarAction::Private::toolBarName.

KToggleToolBarAction() [2/2]

KToggleToolBarAction::KToggleToolBarAction	(	KisToolBar *	toolBar,
		const QString &	text,
		QObject *	parent )

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

Parameters

toolBar	the toolbar to be managed
text	The action's text
parent	The action's parent object.

Definition at line 47 of file ktoggletoolbaraction.cpp.

    : KToggleAction(text, parent),
      d(new Private)
{
    d->toolBar = toolBar;
    d->toolBar->installEventFilter(this);
 
    d->beingToggled = true;
    setChecked(d->toolBar->isVisible());
    d->beingToggled = false;
}

References KToggleToolBarAction::Private::beingToggled, d, KToggleToolBarAction::Private::toolBar, and toolBar().

~KToggleToolBarAction()

KToggleToolBarAction::~KToggleToolBarAction ( )

override

Destroys toggle toolbar action.

Definition at line 59 of file ktoggletoolbaraction.cpp.

{
    delete d;
}

References d.

Member Function Documentation

eventFilter()

bool KToggleToolBarAction::eventFilter ( QObject * watched, QEvent * event )

override

Reimplemented from

See also

QObject.

Definition at line 64 of file ktoggletoolbaraction.cpp.

{
    if (d->beingToggled) {
        return false;
    }
 
    d->beingToggled = true;
 
    if (watched == d->toolBar) {
        switch (event->type()) {
        case QEvent::Hide:
            if (isChecked()) {
                setChecked(false);
            }
            break;
 
        case QEvent::Show:
            if (!isChecked()) {
                setChecked(true);
            }
            break;
 
        default:
            break;
        }
    }
 
    d->beingToggled = false;
 
    return false;
}

References KToggleToolBarAction::Private::beingToggled, d, and KToggleToolBarAction::Private::toolBar.

slotToggled

void KToggleToolBarAction::slotToggled ( bool checked )

overrideprivateslot

Definition at line 101 of file ktoggletoolbaraction.cpp.

{
    if (!d->beingToggled && d->toolBar && checked != d->toolBar->isVisible()) {
        d->beingToggled = true;
        d->toolBar->setVisible(checked);
        d->beingToggled = false;
 
        QMainWindow *mw = d->toolBar->mainWindow();
        if (mw && qobject_cast<KisKMainWindow *>(mw)) {
            static_cast<KisKMainWindow *>(mw)->setSettingsDirty();
        }
    }
 
    KToggleAction::slotToggled(checked);
}

References KToggleToolBarAction::Private::beingToggled, d, and KToggleToolBarAction::Private::toolBar.

toolBar()

KisToolBar * KToggleToolBarAction::toolBar

(

)

Returns a pointer to the tool bar it manages.

Definition at line 96 of file ktoggletoolbaraction.cpp.

{
    return d->toolBar;
}

References d, and KToggleToolBarAction::Private::toolBar.

Member Data Documentation

d

Private* const KToggleToolBarAction::d

private

Definition at line 83 of file ktoggletoolbaraction.h.

---

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

• libs/widgetutils/xmlgui/ktoggletoolbaraction.h
• libs/widgetutils/xmlgui/ktoggletoolbaraction.cpp