ScrollableMessageBox.h

Go to the documentation of this file.

/*
  ScrollableMessageBox
  https://github.com/mpaperno/maxLibQt

  COPYRIGHT: (c)2017 Maxim Paperno; All Right Reserved.
  Contact: http://www.WorldDesign.com/contact

  LICENSE:

  Commercial License Usage
  Licensees holding valid commercial licenses may use this file in
  accordance with the terms contained in a written agreement between
  you and the copyright holder.

  GNU General Public License Usage
  Alternatively, this file may be used under the terms of the GNU
  General Public License as published by the Free Software Foundation,
  either version 3 of the License, 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.

  A copy of the GNU General Public License is available at <http://www.gnu.org/licenses/>.
*/

#ifndef SCROLLABLEESSAGEBOX_H
#define SCROLLABLEESSAGEBOX_H

#include <QDialog>
#include <QDialogButtonBox>
#include <QIcon>
#include <QLabel>
#include <QMessageBox>
#include <QPointer>
#include <QPushButton>
#include <QTextEdit>

class ScrollableMessageBox : public QDialog
{
    Q_OBJECT

  public:
    enum CustomButton {
      // First QDialogButtonBox::StandardButton enum value starts at 0x400
      ShowDetails = 0x01  
    };

    explicit ScrollableMessageBox(QWidget *parent = nullptr, Qt::WindowFlags f = Qt::Dialog);
    explicit ScrollableMessageBox(const QString &title, const QString &text = QString(), const QString &details = QString(), QWidget *parent = nullptr, Qt::WindowFlags f = Qt::Dialog);
    explicit ScrollableMessageBox(const QString &title, QMessageBox::Icon icon, const QString &text, const QString &details = QString(), QWidget *parent = nullptr, Qt::WindowFlags f = Qt::Dialog);
    explicit ScrollableMessageBox(QWidget *parent, const QString &title, const QString &text, const QString &details,
                                  int buttons, int defaultButtton = QDialogButtonBox::NoButton, Qt::WindowFlags f = Qt::Dialog);
    explicit ScrollableMessageBox(QWidget *parent, const QString &title, QMessageBox::Icon icon, const QString &text, const QString &details,
                                  int buttons, int defaultButtton = QDialogButtonBox::NoButton, Qt::WindowFlags f = Qt::Dialog);

    inline QTextEdit *textEdit()         const { return m_textEdit.data(); }
    inline QLabel *textLabel()           const { return m_textLabel.data(); }
    inline QLabel *iconLabel()           const { return m_iconLabel.data(); }
    inline QDialogButtonBox *buttonBox() const { return m_btnBox.data(); }
    QLabel *promptLabel();

    bool detailsExpanded() const;
    bool detailsButtonVisible() const;

  public slots:
    void setText(const QString &text = QString());
    void setDetailedText(const QString &details = QString(), Qt::TextFormat format = Qt::AutoText);
    void setPromptText(const QString &text = QString());

    void setIcon(const QPixmap &pixmap = QPixmap());
    void setIcon(QMessageBox::Icon icon, const QSize &size = QSize());
    void setIcon(const QIcon &icon, const QSize &size = QSize());
    void setIconAlignment(Qt::AlignmentFlag valign);

    void setFontFixedWidth(bool fixed = true);
    void setWordWrap(bool wrap = true);
    void setTextWordWrap(bool wrap = true);

    bool showDetailsExpanded(bool on = true);
    bool toggleDetailsExpanded();

    void setDetailsButtonVisible(bool visible = true, bool toggleDetails = true, bool toggleDetailPosition = true);

    void setShowDetailsBelowButtons(bool on = true);

    void updateSize();

  protected:
    void showEvent(QShowEvent *e) override;

  private:
    void init(const QString &title = QString(), const QString &text = QString(), const QString &details = QString(),
              QMessageBox::Icon icon = QMessageBox::NoIcon, int buttons = QDialogButtonBox::Ok, int defaultBtn = QDialogButtonBox::NoButton);

    QPointer<QLabel> m_textLabel = nullptr;
    QPointer<QLabel> m_iconLabel = nullptr;
    QPointer<QLabel> m_promptLabel = nullptr;
    QPointer<QTextEdit> m_textEdit = nullptr;
    QPointer<QDialogButtonBox> m_btnBox = nullptr;
    QPointer<QPushButton> m_detailsBtn = nullptr;
    bool m_updatesSuspended = true;

};

#endif // SCROLLABLEESSAGEBOX_H