ktoolbar.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 2000 Reginald Stadlbauer (reggie@kde.org)
    (C) 1997, 1998 Stephan Kulow (coolo@kde.org)
    (C) 1997, 1998 Sven Radej (radej@kde.org)
    (C) 1997, 1998 Mark Donohoe (donohoe@kde.org)
    (C) 1997, 1998 Matthias Ettrich (ettrich@kde.org)
    (C) 1999, 2000 Kurt Granroth (granroth@kde.org)
    (C) 2005-2006 Hamish Rodda (rodda@kde.org)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
    */

#ifndef KTOOLBAR_H
#define KTOOLBAR_H

#include <kdeui_export.h>

#include <QtGui/QToolBar>

class QDomElement;

class KConfigGroup;
class KConfig;
class KMainWindow;
class KXMLGUIClient;

class KDEUI_EXPORT KToolBar : public QToolBar
{
    Q_OBJECT

public:
    explicit KToolBar(QWidget *parent, bool isMainToolBar = false, bool readConfig = true);
    // KDE5: remove. The one below is preferred so that all debug output from init() shows the right objectName already,
    // and so that isMainToolBar() and iconSizeDefault() return correct values during loading too.

    explicit KToolBar(const QString& objectName, QWidget* parent, bool readConfig = true);

    KToolBar(const QString& objectName, QMainWindow* parentWindow, Qt::ToolBarArea area, bool newLine = false,
             bool isMainToolBar = false, bool readConfig = true); // KDE5: remove, I don't think anyone is using this.

    virtual ~KToolBar();

    KMainWindow* mainWindow() const;

    void setIconDimensions( int size );

    int iconSizeDefault() const; // KDE5: hide from public API. Doesn't make sense to export this, and it isn't used.

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setContextMenuEnabled( bool enable = true );
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED bool contextMenuEnabled() const;
#endif

    void saveSettings( KConfigGroup &cg );

    void applySettings( const KConfigGroup &cg, bool forceGlobal = false );

    void setXMLGUIClient( KXMLGUIClient *client );

    void loadState( const QDomElement &element );

    void saveState( QDomElement &element ) const;

    bool eventFilter( QObject* watched, QEvent* event );

    static Qt::ToolButtonStyle toolButtonStyleSetting(); // KDE5: make private and file-static, nobody is calling this

    static bool toolBarsEditable();

    static void setToolBarsEditable( bool editable );

    static bool toolBarsLocked();

    static void setToolBarsLocked( bool locked );

  protected Q_SLOTS:
    virtual void slotMovableChanged(bool movable);

  protected:
    virtual void contextMenuEvent( QContextMenuEvent* );
    virtual void actionEvent( QActionEvent* );

    // Draggable toolbar configuration
    virtual void dragEnterEvent( QDragEnterEvent* );
    virtual void dragMoveEvent( QDragMoveEvent* );
    virtual void dragLeaveEvent( QDragLeaveEvent* );
    virtual void dropEvent( QDropEvent* );
    virtual void mousePressEvent( QMouseEvent* );
    virtual void mouseMoveEvent( QMouseEvent* );
    virtual void mouseReleaseEvent( QMouseEvent* );

  private:
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT( d, void slotAppearanceChanged() )
    Q_PRIVATE_SLOT( d, void slotContextAboutToShow() )
    Q_PRIVATE_SLOT( d, void slotContextAboutToHide() )
    Q_PRIVATE_SLOT( d, void slotContextLeft() )
    Q_PRIVATE_SLOT( d, void slotContextRight() )
    Q_PRIVATE_SLOT( d, void slotContextTop() )
    Q_PRIVATE_SLOT( d, void slotContextBottom() )
    Q_PRIVATE_SLOT( d, void slotContextIcons() )
    Q_PRIVATE_SLOT( d, void slotContextText() )
    Q_PRIVATE_SLOT( d, void slotContextTextRight() )
    Q_PRIVATE_SLOT( d, void slotContextTextUnder() )
    Q_PRIVATE_SLOT( d, void slotContextIconSize() )
    Q_PRIVATE_SLOT( d, void slotLockToolBars( bool ) )
};

#endif