dxmlguiwindow.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2013-04-29
 * Description : digiKam XML GUI window
 *
 * Copyright (C) 2013-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_DXML_GUI_WINDOW_H
#define DIGIKAM_DXML_GUI_WINDOW_H
 
// Qt includes
 
#include <QWidget>
#include <QObject>
#include <QAction>
#include <QWindow>
 
// KDE includes
 
#include <kxmlguiwindow.h>
 
// Local includes
 
#include "digikam_export.h"
#include "digikam_config.h"
#include "dlogoaction.h"
#include "dinfointerface.h"
#include "dpluginaction.h"
#include "dpluginloader.h"
 
class QEvent;
 
class KToolBar;
class KConfigGroup;
 
namespace Digikam
{
 
enum FullScreenOptions
{
    FS_TOOLBARS   = 0x00000001,                                                
    FS_THUMBBAR   = 0x00000002,                                                
    FS_SIDEBARS   = 0x00000004,                                                
    FS_STATUSBAR  = 0x00000008,                                                
    FS_NONE       = 0x00000010,                                                
 
    FS_ALBUMGUI   = FS_TOOLBARS | FS_THUMBBAR | FS_SIDEBARS | FS_STATUSBAR,    
    FS_EDITOR     = FS_TOOLBARS | FS_THUMBBAR | FS_SIDEBARS | FS_STATUSBAR,    
    FS_LIGHTTABLE = FS_TOOLBARS | FS_SIDEBARS | FS_STATUSBAR,                  
    FS_IMPORTUI   = FS_TOOLBARS | FS_THUMBBAR | FS_SIDEBARS | FS_STATUSBAR     
};
 
enum StdActionType
{
    StdCopyAction = 0,
    StdPasteAction,
    StdCutAction,
    StdQuitAction,
    StdCloseAction,
    StdZoomInAction,
    StdZoomOutAction,
    StdOpenAction,
    StdSaveAction,
    StdSaveAsAction,
    StdRevertAction,
    StdBackAction,
    StdForwardAction
};
 
static const QString s_configFullScreenHideToolBarsEntry(QLatin1String("FullScreen Hide ToolBars"));
static const QString s_configFullScreenHideThumbBarEntry(QLatin1String("FullScreen Hide ThumbBar"));
static const QString s_configFullScreenHideSideBarsEntry(QLatin1String("FullScreen Hide SideBars"));
static const QString s_configFullScreenHideStatusBarEntry(QLatin1String("FullScreen Hide StatusBar"));
 
class DIGIKAM_EXPORT DXmlGuiWindow : public KXmlGuiWindow
{
    Q_OBJECT
 
public:
 
    explicit DXmlGuiWindow(QWidget* const parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
    ~DXmlGuiWindow() override;
 
    void setConfigGroupName(const QString& name);
    QString configGroupName() const;
 
    void createSettingsActions();
 
    void createHelpActions(bool coreOptions = true);
 
    void cleanupActions();
 
    void createSidebarActions();
 
    void setFullScreenOptions(int options);
 
    void createFullScreenAction(const QString& name);
 
    void readFullScreenSettings(const KConfigGroup& group);
 
    bool fullScreenIsActive() const;
 
    QList<QAction*> allActions() const;
 
public:
 
    void registerPluginsActions();
    virtual void registerExtraPluginsActions(QString& /*dom*/) {};
 
    virtual DInfoInterface* infoIface(DPluginAction* const ac) = 0;
 
public:
 
    static void openHandbook();
    static void restoreWindowSize(QWindow* const win, const KConfigGroup& group);
    static void saveWindowSize(QWindow* const win, KConfigGroup& group);
 
    static QAction* buildStdAction(StdActionType type,
                                   const QObject* const recvr,
                                   const char* const slot,
                                   QObject* const parent);
 
    static void setupIconTheme();
 
protected:
 
    DLogoAction* m_animLogo;
 
protected:
 
    QAction* showMenuBarAction()   const;
    QAction* showStatusBarAction() const;
 
    void editKeyboardShortcuts(KActionCollection* const extraac = nullptr, const QString& actitle = QString());
 
    void closeEvent(QCloseEvent* e)            override;
    void keyPressEvent(QKeyEvent* e)           override;
    bool eventFilter(QObject* obj, QEvent* ev) override;
 
    virtual void showSideBars(bool visible);
 
    virtual void showThumbBar(bool visible);
 
    virtual void customizedFullScreenMode(bool set);
 
    virtual bool thumbbarVisibility() const;
 
protected Q_SLOTS:
 
    bool slotClose();
 
private Q_SLOTS:
 
    void slotToggleFullScreen(bool);
    void slotShowMenuBar();
    void slotShowStatusBar();
    void slotConfNotifications();
    void slotConfToolbars();
    void slotNewToolbarConfig();
 
    void slotRawCameraList();
    void slotSolidHardwareList();
    void slotDonateMoney();
    void slotRecipesBook();
    void slotContribute();
    void slotHelpContents();
 
    virtual void slotOnlineVersionCheck()      {};
    virtual void slotComponentsInfo()          {};
    virtual void slotDBStat()                  {};
 
    virtual void slotToggleLeftSideBar()       {};
    virtual void slotToggleRightSideBar()      {};
    virtual void slotPreviousLeftSideBarTab()  {};
    virtual void slotNextLeftSideBarTab()      {};
    virtual void slotPreviousRightSideBarTab() {};
    virtual void slotNextRightSideBarTab()     {};
 
    virtual void slotEditKeys()                { editKeyboardShortcuts(); };
    virtual void slotSetup() = 0;
 
private:
 
    void showToolBars(bool visible);
 
    KToolBar* mainToolBar() const;
 
    void checkFullScreenBeforeClosing();
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_DXML_GUI_WINDOW_H