File indexing completed on 2024-05-26 04:31:52

 /* This file is part of the KDE libraries
     SPDX-FileCopyrightText: 2000 Reginald Stadlbauer (reggie@kde.org)
     SPDX-FileCopyrightText: 1997, 1998 Stephan Kulow (coolo@kde.org)
     SPDX-FileCopyrightText: 1997, 1998 Sven Radej (radej@kde.org)
     SPDX-FileCopyrightText: 1997, 1998 Mark Donohoe (donohoe@kde.org)
     SPDX-FileCopyrightText: 1997, 1998 Matthias Ettrich (ettrich@kde.org)
     SPDX-FileCopyrightText: 1999, 2000 Kurt Granroth (granroth@kde.org)
     SPDX-FileCopyrightText: 2005-2006 Hamish Rodda (rodda@kde.org)
 
     SPDX-License-Identifier: LGPL-2.0-only
     */
 
 #ifndef KTOOLBAR_H
 #define KTOOLBAR_H
 
 #include <kritawidgetutils_export.h>
 
 #include <QToolBar>
 
 class QDomElement;
 
 class KConfigGroup;
 class KConfig;
 class KisKMainWindow;
 class KisKXMLGUIClient;
 class KisToolBarStateModel;
 
 /**
  * @short Floatable toolbar with auto resize.
  *
  * A KDE-style toolbar.
  *
  * KisToolBar can be used as a standalone widget, but KisKMainWindow
  * provides easy factories and management of one or more toolbars.
  *
  * KisToolBar uses a global config group to load toolbar settings on
  * construction. It will reread this config group on a
  * KApplication::appearanceChanged() signal.
  *
  * @note If you can't depend on KXmlGui but you want to integrate with KDE, you can use QToolBar with:
  *    Set ToolButtonStyle to Qt::ToolButtonFollowStyle, this will make QToolBar use the settings for "Main Toolbar"
  *    Additionally set QToolBar::setProperty("otherToolbar", true) to use settings for "Other toolbars"
  *    Settings from "Other toolbars" will only work on widget styles derived from KStyle
  * @author Reginald Stadlbauer <reggie@kde.org>, Stephan Kulow <coolo@kde.org>, Sven Radej <radej@kde.org>, Hamish Rodda <rodda@kde.org>.
  */
 class KRITAWIDGETUTILS_EXPORT KisToolBar : public QToolBar
 {
     Q_OBJECT
 
 public:
     /**
      * Constructor.
      *
      * This constructor takes care of adding the toolbar to the mainwindow,
      * if @p parent is a QMainWindow.
      *
      * Normally KDE applications do not call this directly, they either
      * call KisKMainWindow::toolBar(name), or they use XML-GUI and specify
      * toolbars using XML.
      *
      * @param objectName  The QObject name of this toolbar, required so that QMainWindow can save and load the toolbar position,
      *                    and so that KisToolBar can find out if it's the main toolbar.
      * @param parent      The standard toolbar parent (usually a KisKMainWindow)
      * @param readConfig  whether to apply the configuration (global and application-specific)
      */
     explicit KisToolBar(const QString &objectName, QWidget *parent, bool readConfig = true);
 
     /**
      * Destroys the toolbar.
      */
     ~KisToolBar() override;
 
     /**
      * Returns the main window that this toolbar is docked with.
      */
     KisKMainWindow *mainWindow() const;
 
     /**
      * Convenience function to set icon size
      */
     void setIconDimensions(int size);
 
     /**
      * Returns the default size for this type of toolbar.
      *
      * @return the default size for this type of toolbar.
      */
     int iconSizeDefault() const; // KDE5: hide from public API. Doesn't make sense to export this, and it isn't used.
 
     /**
      * Save the toolbar settings to group @p configGroup in @p config.
      */
     void saveSettings(KConfigGroup &cg);
 
     /**
      * Read the toolbar settings from group @p configGroup in @p config
      * and apply them.
      */
     void applySettings(const KConfigGroup &cg);
 
     /**
      * Adds an XML gui client that uses this toolbar
      * @since 4.8.1
      */
     void addXMLGUIClient(KisKXMLGUIClient *client);
 
     /**
      * Removes an XML gui client that uses this toolbar
      * @since 4.8.5
      */
     void removeXMLGUIClient(KisKXMLGUIClient *client);
 
     /**
      * Load state from an XML @p element, called by KisKXMLGUIBuilder.
      */
     void loadState(const QDomElement &element);
 
     /**
      * Save state into an XML @p element, called by KisKXMLGUIBuilder.
      */
     void saveState(QDomElement &element) const;
 
     /**
      * Reimplemented to support context menu activation on disabled tool buttons.
      */
     bool eventFilter(QObject *watched, QEvent *event) override;
 
     /**
      * Returns whether the toolbars are currently editable (drag & drop of actions).
      */
     static bool toolBarsEditable();
 
     /**
      * Enable or disable toolbar editing via drag & drop of actions.  This is
      * called by KisKEditToolbar and should generally be set to disabled whenever
      * KisKEditToolbar is not active.
      */
     static void setToolBarsEditable(bool editable);
 
     /**
      * Returns whether the toolbars are locked (i.e., moving of the toolbars disallowed).
      */
     static bool toolBarsLocked();
 
     /**
      * Allows you to lock and unlock all toolbars (i.e., disallow/allow moving of the toolbars).
      */
     static void setToolBarsLocked(bool locked);
 
     /**
      * Emits a dbus signal to tell all toolbars in all applications, that the user settings have
      * changed.
      * @since 5.0
      */
     static void emitToolbarStyleChanged();
 
     static KisToolBarStateModel* toolBarStateModel();
 
 protected Q_SLOTS:
     virtual void slotMovableChanged(bool movable);
 
 protected:
     void contextMenuEvent(QContextMenuEvent *) override;
     void actionEvent(QActionEvent *) override;
 
     // Draggable toolbar configuration
     void dragEnterEvent(QDragEnterEvent *) override;
     void dragMoveEvent(QDragMoveEvent *) override;
     void dragLeaveEvent(QDragLeaveEvent *) override;
     void dropEvent(QDropEvent *) override;
     void mousePressEvent(QMouseEvent *) override;
     void mouseMoveEvent(QMouseEvent *) override;
     void mouseReleaseEvent(QMouseEvent *) override;
 
 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 slotContextShowText())
     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))
     Q_PRIVATE_SLOT(d, void slotToolButtonToggled(bool))
 };
 
 #endif