qtcanpool/qxappshell_8h_source.html

#ifndef QXAPPSHELL_H

#define QXAPPSHELL_H


#include "qxapp_global.h"

#include "qxplugin/qxplugincontext.h"

#include "qxtoast.h"

#include "ribbonappwindow.h"


#include "qxcore/qxsettings.h"

#include "qxdock/qxdock_global.h"


#include <QtCore/QString>

#include <QtGui/QIcon>


QT_BEGIN_NAMESPACE

class QCloseEvent;

class QLabel;

class QProgressBar;

class QStackedWidget;

QT_END_NAMESPACE


QX_DOCK_BEGIN_NAMESPACE

class DockWidget;

class DockWindow;

QX_DOCK_END_NAMESPACE


QX_APP_BEGIN_NAMESPACE


class QxAppShellPrivate;

class QxNavigationBar;

class QxToastManager;

class QxWorkspaceManager;


class QX_APP_EXPORT QxAppShell : public RibbonAppWindow

{

    Q_OBJECT

public:

    explicit QxAppShell(QWidget *parent = Q_NULLPTR);

    ~QxAppShell() override;


    QxNavigationBar *navigationBar() const;

    QX_DOCK_PREPEND_NAMESPACE(DockWindow) * dockWindow() const;


    // Pages -----------------------------------------------------------------

    void addPage(const QString &id, const QIcon &icon, const QString &title, QWidget *page);

    void insertPage(int index, const QString &id, const QIcon &icon, const QString &title, QWidget *page);

    void removePage(const QString &id);


    int pageCount() const;

    int indexOfPage(const QString &id) const;

    QString pageId(int index) const;

    QWidget *page(const QString &id) const;


    int currentPageIndex() const;

    QString currentPageId() const;

    QWidget *currentPage() const;


    // Docks -----------------------------------------------------------------

    QX_DOCK_PREPEND_NAMESPACE(DockWidget) *

        addDock(Qx::DockWidgetArea area, const QString &id, const QString &title, QWidget *widget);

    QX_DOCK_PREPEND_NAMESPACE(DockWidget) * dock(const QString &id) const;


    // Plugin context --------------------------------------------------------

    QxPlugin::QxPluginContext *pluginContext() const;


    // Status bar ------------------------------------------------------------

    void setStatusMessage(const QString &message);

    QString statusMessage() const;

    void setBusy(bool busy);

    bool isBusy() const;


    void setProgressRange(int minimum, int maximum);

    int progressMinimum() const;

    int progressMaximum() const;

    void setProgress(int value);

    int progress() const;

    void clearProgress();

    bool isProgressVisible() const;


    // Notifications ---------------------------------------------------------

    QxToastManager *toastManager() const;

    QxToast *showToast(const QString &text, QxToast::Level level = QxToast::Information,

                       int timeoutMs = QxToast::DefaultTimeout);


    // Workspaces ------------------------------------------------------------

    QxWorkspaceManager *workspaceManager() const;

    QStringList workspaceNames() const;

    bool saveWorkspace(const QString &name);

    bool applyWorkspace(const QString &name);


    // Persistence -----------------------------------------------------------

    QX_CORE_PREPEND_NAMESPACE(QxSettings) * settings() const;

    void setSettings(QX_CORE_PREPEND_NAMESPACE(QxSettings) * settings);


    void saveLayout();

    void restoreLayout();


    bool autoSaveLayout() const;

    void setAutoSaveLayout(bool on);


public Q_SLOTS:

    void setCurrentPage(int index);

    void setCurrentPage(const QString &id);


Q_SIGNALS:

    void currentPageChanged(int index, const QString &id);

protected:

    void closeEvent(QCloseEvent *event) override;

private:

    Q_DISABLE_COPY(QxAppShell)

    QX_DECLARE_PRIVATE(QxAppShell)

};


QX_APP_END_NAMESPACE


#endif   // QXAPPSHELL_H

QxApp::QxAppShell
The window skeleton of a ribbon application.
Definition qxappshell.h:70

QxApp::QxAppShell::currentPageChanged
void currentPageChanged(int index, const QString &id)
Emitted when the page on screen changes, which also covers the case where another page was inserted o...

QxApp::QxNavigationBar
A vertical rail of exclusive, checkable entries.
Definition qxnavigationbar.h:37

QxApp::QxToastManager
The stack of toasts of one window.
Definition qxtoastmanager.h:49

QxApp::QxToast
One short message, shown over the window it belongs to and gone a few seconds later.
Definition qxtoast.h:54

QxApp::QxToast::Level
Level
What the message is about; it selects the icon and the accent colour.
Definition qxtoast.h:58

QxApp::QxWorkspaceManager
The named layouts of one shell.
Definition qxworkspacemanager.h:52

QxApp::RibbonAppWindow
Definition ribbonappwindow.h:15

QxCore::QxSettings
Thin wrapper around QSettings that keeps call sites free of the usual boilerplate: typed accessors wi...
Definition qxsettings.h:32

QxDock::DockWidget
The DockWidget class provides a widget that can be docked inside a DockWindow or floated as a top-lev...
Definition dockwidget.h:31

QxDock::DockWindow
The central dock window that maintains the complete docking system.
Definition dockwindow.h:36

QxPlugin::QxPluginContext
The thin surface a plugin programs against.
Definition qxplugincontext.h:34

Qx::DockWidgetArea
DockWidgetArea
Definition qxdock_global.h:124

qxapp_global.h

QX_APP_END_NAMESPACE
#define QX_APP_END_NAMESPACE
Definition qxapp_global.h:63

QX_APP_EXPORT
#define QX_APP_EXPORT
Definition qxapp_global.h:72

QX_DECLARE_PRIVATE
#define QX_DECLARE_PRIVATE(Class)
Definition qxapp_global.h:24

Q_NULLPTR
#define Q_NULLPTR
Copyleft (C) 2025 maminjie canpool@163.com SPDX-License-Identifier: MulanPSL-2.0
Definition qxapp_global.h:10

QX_APP_BEGIN_NAMESPACE
#define QX_APP_BEGIN_NAMESPACE
Definition qxapp_global.h:60

QX_CORE_PREPEND_NAMESPACE
#define QX_CORE_PREPEND_NAMESPACE(name)
Definition qxcore_global.h:65

qxdock_global.h

QX_DOCK_END_NAMESPACE
#define QX_DOCK_END_NAMESPACE
Definition qxdock_global.h:73

QX_DOCK_BEGIN_NAMESPACE
#define QX_DOCK_BEGIN_NAMESPACE
Definition qxdock_global.h:70

QX_DOCK_PREPEND_NAMESPACE
#define QX_DOCK_PREPEND_NAMESPACE(name)
Definition qxdock_global.h:75

qxplugincontext.h

qxsettings.h

name
const char * name
Definition qxtheme.cpp:25

text
QColor text
Definition qxthemepalette.cpp:20

qxtoast.h

ribbonappwindow.h