summaryrefslogtreecommitdiff
path: root/src/VBox/Frontends/VirtualBox/src/widgets/UIPopupStackViewport.h
blob: f01d0cbf700744a5b028214ea8156e8f50ffbc95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/* $Id$ */
/** @file
 * VBox Qt GUI - UIPopupStackViewport class declaration.
 */

/*
 * Copyright (C) 2013-2019 Oracle Corporation
 *
 * This file is part of VirtualBox Open Source Edition (OSE), as
 * available from http://www.virtualbox.org. This file is free software;
 * you can redistribute it and/or modify it under the terms of the GNU
 * General Public License (GPL) as published by the Free Software
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 */

#ifndef FEQT_INCLUDED_SRC_widgets_UIPopupStackViewport_h
#define FEQT_INCLUDED_SRC_widgets_UIPopupStackViewport_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif

/* Qt includes: */
#include <QWidget>
#include <QMap>

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

/* Forward declaration: */
class QSize;
class QString;
class UIPopupPane;

/** QWidget extension providing GUI with popup-stack viewport prototype class. */
class SHARED_LIBRARY_STUFF UIPopupStackViewport : public QWidget
{
    Q_OBJECT;

signals:

    /** Notifies about popup-pane size change. */
    void sigProposePopupPaneSize(QSize newSize);

    /** Notifies about size-hint change. */
    void sigSizeHintChanged();

    /** Asks to close popup-pane with @a strID and @a iResultCode. */
    void sigPopupPaneDone(QString strID, int iResultCode);
    /** Notifies about popup-pane with @a strID was removed. */
    void sigPopupPaneRemoved(QString strID);
    /** Notifies about popup-panes were removed. */
    void sigPopupPanesRemoved();

public:

    /** Constructs popup-stack viewport. */
    UIPopupStackViewport();

    /** Returns whether pane with passed @a strID exists. */
    bool exists(const QString &strID) const;
    /** Creates pane with passed @a strID, @a strMessage, @a strDetails and @a buttonDescriptions. */
    void createPopupPane(const QString &strID,
                         const QString &strMessage, const QString &strDetails,
                         const QMap<int, QString> &buttonDescriptions);
    /** Updates pane with passed @a strID, @a strMessage and @a strDetails. */
    void updatePopupPane(const QString &strID,
                         const QString &strMessage, const QString &strDetails);
    /** Recalls pane with passed @a strID. */
    void recallPopupPane(const QString &strID);

    /** Returns minimum size-hint. */
    QSize minimumSizeHint() const { return m_minimumSizeHint; }

public slots:

    /** Handle proposal for @a newSize. */
    void sltHandleProposalForSize(QSize newSize);

private slots:

    /** Adjusts geometry. */
    void sltAdjustGeometry();

    /** Handles reuqest to dismiss popup-pane with @a iButtonCode. */
    void sltPopupPaneDone(int iButtonCode);

private:

    /** Updates size-hint. */
    void updateSizeHint();
    /** Lays the content out. */
    void layoutContent();

    /** Holds the layout margin. */
    const int m_iLayoutMargin;
    /** Holds the layout spacing. */
    const int m_iLayoutSpacing;

    /** Holds the minimum size-hint. */
    QSize m_minimumSizeHint;

    /** Holds the popup-pane instances. */
    QMap<QString, UIPopupPane*> m_panes;
};

#endif /* !FEQT_INCLUDED_SRC_widgets_UIPopupStackViewport_h */