source: vbox/trunk/src/VBox/Frontends/VirtualBox/src/settings/UIAdvancedSettingsDialog.h

/* $Id: UIAdvancedSettingsDialog.h 104363 2024-04-18 17:10:19Z vboxsync $ */
/** @file
 * VBox Qt GUI - UIAdvancedSettingsDialog class declaration.
 */

/*
 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
 *
 * This file is part of VirtualBox base platform packages, as
 * available from https://www.virtualbox.org.
 *
 * 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, in version 3 of the
 * License.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <https://www.gnu.org/licenses>.
 *
 * SPDX-License-Identifier: GPL-3.0-only
 */

#ifndef FEQT_INCLUDED_SRC_settings_UIAdvancedSettingsDialog_h
#define FEQT_INCLUDED_SRC_settings_UIAdvancedSettingsDialog_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif

/* Qt includes: */
#include <QMainWindow>
#include <QVariant>

/* GUI includes: */
#include "UISettingsDefs.h"

/* Forward declarations: */
class QGridLayout;
class QProgressBar;
class QShowEvent;
class QStackedWidget;
class QTimer;
class QIDialogButtonBox;
class UIFilterEditor;
class UIModeCheckBox;
class UISettingsPage;
class UISettingsPageFrame;
class UISettingsPageValidator;
class UISettingsSelector;
class UISettingsSerializer;
class UISettingsWarningPane;
class UIVerticalScrollArea;

/* Using declarations: */
using namespace UISettingsDefs;

/** QMainWindow subclass used as
  * base dialog class for both Global Preferences & Machine Settings
  * dialogs, which encapsulates most of their common functionality. */
class SHARED_LIBRARY_STUFF UIAdvancedSettingsDialog : public QMainWindow
{
    Q_OBJECT;

signals:

    /** Notifies listeners about dialog should be closed. */
    void sigClose();

public:

    /** Dialog types. */
    enum DialogType { Type_Global, Type_Machine };

    /** Constructs settings dialog passing @a pParent to the base-class.
      * @param  strCategory  Brings the name of category to be opened.
      * @param  strControl   Brings the name of control to be focused. */
    UIAdvancedSettingsDialog(QWidget *pParent,
                             const QString &strCategory,
                             const QString &strControl);
    /** Destructs settings dialog. */
    virtual ~UIAdvancedSettingsDialog() RT_OVERRIDE;

    /** Loads the dialog data. */
    virtual bool load() = 0;
    /** Saves the dialog data. */
    virtual void save() = 0;

protected slots:

    /** Hides the modal dialog and sets the result code to Accepted. */
    virtual void accept();
    /** Hides the modal dialog and sets the result code to Rejected. */
    virtual void reject();

    /** Handles category change to @a cId. */
    virtual void sltCategoryChanged(int cId);
    /** Repeats handling for category change to cached @a m_iPageId. */
    virtual void sltCategoryChangedRepeat() { sltCategoryChanged(m_iPageId); }

    /** Handles serializartion start. */
    virtual void sltHandleSerializationStarted();
    /** Handles serializartion progress change to @a iValue. */
    virtual void sltHandleSerializationProgressChange(int iValue);
    /** Handle serializartion finished. */
    virtual void sltHandleSerializationFinished();

protected slots:

    /** Handles translation event. */
    virtual void sltRetranslateUI();

protected:

    /** Preprocesses Qt @a pEvent for passed @a pObject. */
    virtual bool eventFilter(QObject *pObject, QEvent *pEvent) RT_OVERRIDE;

    /** Handles show @a pEvent. */
    virtual void showEvent(QShowEvent *pEvent) RT_OVERRIDE;
    /** Handles first show event. */
    virtual void polishEvent();
    /** Handles close @a pEvent. */
    virtual void closeEvent(QCloseEvent *pEvent) RT_OVERRIDE;

    /** Selects page and tab.
      * @param  fKeepPreviousByDefault  Brings whether we should keep current page/tab by default. */
    void choosePageAndTab(bool fKeepPreviousByDefault = false);

    /** Loads the dialog @a data. */
    void loadData(QVariant &data);
    /** Saves the dialog @a data. */
    void saveData(QVariant &data);

    /** Returns configuration access level. */
    ConfigurationAccessLevel configurationAccessLevel() const { return m_enmConfigurationAccessLevel; }
    /** Defines configuration access level. */
    void setConfigurationAccessLevel(ConfigurationAccessLevel enmConfigurationAccessLevel);

    /** Returns the serialize process instance. */
    UISettingsSerializer *serializeProcess() const { return m_pSerializeProcess; }
    /** Returns whether the serialization is in progress. */
    bool isSerializationInProgress() const { return m_fSerializationIsInProgress; }

    /** Returns dialog optional flags. */
    QMap<QString, QVariant> optionalFlags() const { return m_flags; }
    /** Defines dialog optional @a flags. */
    void setOptionalFlags(const QMap<QString, QVariant> &flags);

    /** Returns the dialog title extension. */
    virtual QString titleExtension() const = 0;
    /** Returns the dialog title. */
    virtual QString title() const = 0;

    /** Adds an item (page).
      * @param  strBigIcon     Brings the big icon.
      * @param  strMediumIcon  Brings the medium icon.
      * @param  strSmallIcon   Brings the small icon.
      * @param  cId            Brings the page ID.
      * @param  strLink        Brings the page link.
      * @param  pSettingsPage  Brings the page reference.
      * @param  iParentId      Brings the page parent ID. */
    void addItem(const QString &strBigIcon, const QString &strMediumIcon, const QString &strSmallIcon,
                 int cId, const QString &strLink,
                 UISettingsPage* pSettingsPage = 0, int iParentId = -1);

    /** Verifies data integrity between certain @a pSettingsPage and other pages. */
    virtual void recorrelate(UISettingsPage *pSettingsPage) { Q_UNUSED(pSettingsPage); }

    /** Inserts an item to the map m_pageHelpKeywords. */
    void addPageHelpKeyword(int iPageType, const QString &strHelpKeyword);

    /** Validates data correctness. */
    void revalidate();

    /** Returns whether settings were changed. */
    bool isSettingsChanged();

    /** Holds the name of category to be opened. */
    QString  m_strCategory;
    /** Holds the name of control to be focused. */
    QString  m_strControl;

    /** Holds the page selector instance. */
    UISettingsSelector *m_pSelector;

private slots:

    /** Handles request to close dialog as QWidget, not QWindow.
      * No need for QWindow destruction functionality.
      * Parent will handle destruction itself. */
    void sltClose();

    /** Handles validity change for certain @a pValidator. */
    void sltHandleValidityChange(UISettingsPageValidator *pValidator);

    /** Handles hover enter for warning pane specified by @a pValidator. */
    void sltHandleWarningPaneHovered(UISettingsPageValidator *pValidator);
    /** Handles hover leave for warning pane specified by @a pValidator. */
    void sltHandleWarningPaneUnhovered(UISettingsPageValidator *pValidator);

    /** Handles experience mode checkbox change. */
    void sltHandleExperienceModeCheckBoxChanged();
    /** Handles experience mode change. */
    void sltHandleExperienceModeChanged();

    /** Applies filtering rules, which can be changed as
      * a result of changes in experience mode and filter editor. */
    void sltApplyFilteringRules();
    /** Handles frame visivility changes. */
    void sltHandleFrameVisibilityChange(bool fVisible);

    /** Handles signal about vertical scroll-area wheel-event. */
    void sltHandleVerticalScrollAreaWheelEvent();

private:

    /** @name Prepare/cleanup cascade.
     * @{ */
        /** Prepares all. */
        void prepare();
        /** Prepares selector. */
        void prepareSelector();
        /** Prepare scroll-area. */
        void prepareScrollArea();
        /** Prepare button-box. */
        void prepareButtonBox();

        /** Cleanups all. */
        void cleanup();
    /** @} */

    /** Holds configuration access level. */
    ConfigurationAccessLevel  m_enmConfigurationAccessLevel;

    /** Holds the serialize process instance. */
    UISettingsSerializer *m_pSerializeProcess;

    /** Holds whether dialog is polished. */
    bool  m_fPolished;
    /** Holds whether the serialization is in progress. */
    bool  m_fSerializationIsInProgress;
    /** Holds whether there were no serialization errors. */
    bool  m_fSerializationClean;
    /** Holds whether the dialod had emitted signal to be closed. */
    bool  m_fClosed;

    /** Holds the current page ID. */
    int  m_iPageId;

    /** Holds the dialog optional flags. */
    QMap<QString, QVariant>  m_flags;

    /** Holds the status-bar widget instance. */
    QStackedWidget         *m_pStatusBar;
    /** Holds the process-bar widget instance. */
    QProgressBar           *m_pProcessBar;
    /** Holds the warning-pane instance. */
    UISettingsWarningPane  *m_pWarningPane;

    /** Holds whether settings dialog is valid (no errors, can be warnings). */
    bool  m_fValid;
    /** Holds whether settings dialog is silent (no errors and no warnings). */
    bool  m_fSilent;

    /** Holds the warning hint. */
    QString  m_strWarningHint;

    /** Holds the map of settings page frames. */
    QMap<int, UISettingsPageFrame*>  m_frames;

    /** Stores the help tag per page. */
    QMap<int, QString>  m_pageHelpKeywords;

    /** Holds the 'sticky scrolling timer' instance. */
    QTimer *m_pScrollingTimer;

    /** @name Widgets
     * @{ */
        /** Holds the main layout instance. */
        QGridLayout *m_pLayoutMain;

        /** Holds the mode checkbox instance. */
        UIModeCheckBox *m_pCheckBoxMode;

        /** Holds the filter editor instance. */
        UIFilterEditor *m_pEditorFilter;

        /** Holds the scroll-area instance. */
        UIVerticalScrollArea *m_pScrollArea;
        /** Holds the scroll-viewport instance. */
        QWidget              *m_pScrollViewport;

        /** Holds the button-box instance. */
        QIDialogButtonBox *m_pButtonBox;
    /** @} */
};

#endif /* !FEQT_INCLUDED_SRC_settings_UIAdvancedSettingsDialog_h */