KisKEditToolBar Class Reference

A dialog used to customize or configure toolbars. More...

#include <kedittoolbar.h>

Inheritance diagram for KisKEditToolBar:

Signals
void	newToolBarConfig ()
QT_MOC_COMPAT void	newToolbarConfig ()

Public Member Functions
	KisKEditToolBar (KisKXMLGUIFactory *factory, QWidget *parent=0)
void	setDefaultToolBar (const QString &toolBarName)
void	setResourceFile (const QString &file, bool global=true)
	~KisKEditToolBar () override
	destructor

Static Public Member Functions
static void	setGlobalDefaultToolBar (const char *toolBarName)

Protected Member Functions
void	hideEvent (QHideEvent *event) override
void	showEvent (QShowEvent *event) override

Private Attributes
KisKEditToolBarPrivate *const	d

Friends
class	KisKEditToolBarPrivate

Detailed Description

A dialog used to customize or configure toolbars.

This dialog only works if your application uses the XML UI framework for creating menus and toolbars. It depends on the XML files to describe the toolbar layouts and it requires the actions to determine which buttons are active.

Typically you do not need to use it directly as KXmlGuiWindow::setupGUI takes care of it.

If you use plugListAction you need to overload saveNewToolbarConfig() to plug actions again:

void MyClass::saveNewToolbarConfig()
{
  KXmlGuiWindow::saveNewToolbarConfig();
  plugActionList( "list1", list1Actions );
  plugActionList( "list2", list2Actions );
}

When created, KisKEditToolBar takes a KisKXMLGUIFactory object, and uses it to find all of the action collections and XML files (there is one of each for the mainwindow, but there could be more, when adding other XMLGUI clients like KParts or plugins). The editor aims to be semi-intelligent about where it assigns any modifications. In other words, it will not write out part specific changes to your application's main XML file.

KXmlGuiWindow and KParts::MainWindow take care of creating KisKEditToolBar correctly and connecting to its newToolBarConfig slot, but if you really really want to do it yourself, see the KXmlGuiWindow::configureToolbars() and KXmlGuiWindow::saveNewToolbarConfig() code.

KDE Toolbar Editor (KWrite)

Author

Kurt Granroth granr.nosp@m.oth@.nosp@m.kde.o.nosp@m.rg @maintainer David Faure faure.nosp@m.@kde.nosp@m..org

Definition at line 57 of file kedittoolbar.h.

Constructor & Destructor Documentation

KisKEditToolBar()

KisKEditToolBar::KisKEditToolBar ( KisKXMLGUIFactory * factory, QWidget * parent = 0 )

explicit

Main constructor.

The main parameter, factory, is a pointer to the XML GUI factory object for your application. It contains a list of all of the GUI clients (along with the action collections and xml files) and the toolbar editor uses that.

Use this like so:

KisKEditToolBar edit(factory());
if (edit.exec())
...

Parameters

factory	Your application's factory object
parent	The usual parent for the dialog.

Definition at line 596 of file kedittoolbar.cpp.

    : QDialog(parent),
      d(new KisKEditToolBarPrivate(this))
{
    d->m_widget = new KisKEditToolBarWidget(this);
    d->init();
    d->m_factory = factory;
}

~KisKEditToolBar()

KisKEditToolBar::~KisKEditToolBar ( )

override

destructor

Definition at line 647 of file kedittoolbar.cpp.

{
    delete d;
    s_defaultToolBarName()->clear();
}

References d.

Member Function Documentation

hideEvent()

void KisKEditToolBar::hideEvent ( QHideEvent * event )

overrideprotected

Definition at line 1734 of file kedittoolbar.cpp.

{
    // The dialog has been hidden, disable toolbar editing
    KisToolBar::setToolBarsEditable(false);
 
    QDialog::hideEvent(event);
}

References KisToolBar::setToolBarsEditable().

newToolBarConfig

void KisKEditToolBar::newToolBarConfig ( )

signal

Signal emitted when 'apply' or 'ok' is clicked or toolbars were reset. Connect to it, to plug action lists and to call applyMainWindowSettings (see sample code in this class's documentation)

newToolbarConfig

QT_MOC_COMPAT void KisKEditToolBar::newToolbarConfig ( )

signal

setDefaultToolBar()

void KisKEditToolBar::setDefaultToolBar

(

const QString &

toolBarName

)

Sets the default toolbar that will be selected when the dialog is shown. If not set, or QString() is passed in, the global default tool bar name will be used.

Parameters

toolBarName

the name of the tool bar

See also

setGlobalDefaultToolBar

Definition at line 653 of file kedittoolbar.cpp.

{
    if (toolBarName.isEmpty()) {
        d->m_defaultToolBar = *s_defaultToolBarName();
    } else {
        d->m_defaultToolBar = toolBarName;
    }
}

References d, and KisKEditToolBarPrivate::m_defaultToolBar.

setGlobalDefaultToolBar()

void KisKEditToolBar::setGlobalDefaultToolBar ( const char * toolBarName )

static

Sets the default toolbar which will be auto-selected for all KisKEditToolBar instances. Can be overridden on a per-dialog basis by calling setDefaultToolBar( const QString& ) on the dialog.

Parameters

toolBarName

the name of the tool bar

Definition at line 777 of file kedittoolbar.cpp.

{
    *s_defaultToolBarName() = QString::fromLatin1(toolbarName);
}

setResourceFile()

void KisKEditToolBar::setResourceFile	(	const QString &	file,
		bool	global = true )

The name (absolute or relative) of your application's UI resource file is assumed to be share/apps/appname/appnameui.xmlgui though this can be overridden by calling this method.

The global parameter controls whether or not the global resource file is used. If this is true, then you may edit all of the actions in your toolbars – global ones and local one. If it is false, then you may edit only your application's entries. The only time you should set this to false is if your application does not use the global resource file at all (very rare).

Parameters

file	The application's local resource file.
global	If true, then the global resource file will also be parsed.

Definition at line 640 of file kedittoolbar.cpp.

{
    d->m_file = file;
    d->m_global = global;
    d->m_widget->load(d->m_file, d->m_global, d->m_defaultToolBar);
}

References d, KDEPrivate::KisKEditToolBarWidget::load(), KisKEditToolBarPrivate::m_defaultToolBar, KisKEditToolBarPrivate::m_file, KisKEditToolBarPrivate::m_global, and KisKEditToolBarPrivate::m_widget.

showEvent()

void KisKEditToolBar::showEvent ( QShowEvent * event )

overrideprotected

Definition at line 1717 of file kedittoolbar.cpp.

{
    if (!event->spontaneous()) {
        // The dialog has been shown, enable toolbar editing
        if (d->m_factory) {
            // call the xmlgui-factory version
            d->m_widget->load(d->m_factory, d->m_defaultToolBar);
        } else {
            // call the action collection version
            d->m_widget->load(d->m_file, d->m_global, d->m_defaultToolBar);
        }
 
        KisToolBar::setToolBarsEditable(true);
    }
    QDialog::showEvent(event);
}

References KisToolBar::setToolBarsEditable().

Friends And Related Symbol Documentation

KisKEditToolBarPrivate

friend class KisKEditToolBarPrivate

friend

Definition at line 136 of file kedittoolbar.h.

Member Data Documentation

d

KisKEditToolBarPrivate* const KisKEditToolBar::d

private

Definition at line 137 of file kedittoolbar.h.

---

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

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