QCustomMessageBox.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: QCustomMessageBox
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/KeyController.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/String.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/UUID.h>
#include <NDEVR/GenericOption.h>
#include <QWidget>
#include <QMessageBox>
#include <QLabel>
#include <QPointer>
#include <functional>
class QHBoxLayout;
class QSize;
namespace NDEVR
{
    class Button;
    class ImageView;
    class String;
    struct PopupInfo;
    /**--------------------------------------------------------------------------------------------------
    \brief A message box displays a primary text to alert the user to a situation, an informative text to 
        further explain the situation, and an optional detailed text to provide even more data if the 
        user requests it.
    The interface for this object allows from either a set of predifined user options (OK, Load, Cancel, etc)
        or a set of program defined responses that the user can choose from.
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_WIDGETS_API QCustomMessageBox : public QWidget, public BasicKeyController
    {
        Q_OBJECT
    protected:
        QCustomMessageBox(const TranslatedString& title, const TranslatedString& text, QMessageBox::StandardButtons buttons, std::function<void(QMessageBox::StandardButton, PopupInfo)> on_select = nullptr);
        QCustomMessageBox(const TranslatedString& title, const TranslatedString& text, const Buffer<TranslatedString>& button_labels, std::function<void(TranslatedString, PopupInfo)> on_select = nullptr);
        QCustomMessageBox(const GenericOption& entry_type, std::function<void(GenericOption, PopupInfo)> on_select);
        virtual ~QCustomMessageBox();
    public:
        void clearButtons();
        void setIcon(const String& image, fltp08 icon_size_mult = 1.0);
        void setText(const TranslatedString& text);
        void setButtons(QMessageBox::StandardButtons buttons);
        void setButtons(const Buffer<TranslatedString>& button_labels);
        void setCallback(std::function<void(QMessageBox::StandardButton, PopupInfo)> callback) { m_callback = callback; };
        void setLabelCallback(std::function<void(TranslatedString, PopupInfo)> callback) { m_label_callback = callback; };
        void setGenericOptionCallback(std::function<void(GenericOption, PopupInfo)> callback) { m_user_entry_callback = callback; };
        static QCustomMessageBox* CreateMessageBox(const TranslatedString& title, const TranslatedString& text, QMessageBox::StandardButtons buttons, std::function<void(QMessageBox::StandardButton, PopupInfo)> on_select = nullptr);
        static QCustomMessageBox* CreateMessageBox(const TranslatedString& title, const TranslatedString& text, const Buffer<TranslatedString>& button_labels, std::function<void(TranslatedString, PopupInfo)> on_select = nullptr);
        static QCustomMessageBox* CreateMessageBox(const GenericOption& entry_type, std::function<void(GenericOption, PopupInfo)> on_select = nullptr);
        QSize sizeHint() const override;
        virtual bool processKeyEvent(const String& id, const KeyEvent& key_event, DesignObjectLookup* lookup, Camera* camera) override;
        virtual void resetKeyControllerToDefaults() override;
    protected:
        void buttonPressed(QMessageBox::StandardButton button, PopupInfo);
        void buttonPressed(const TranslatedString& button_label, PopupInfo);
        void addButtonsToLayout();
    protected:
        QLabel* m_text;
        Buffer<Button*> m_buttons;
        String m_pixmap;
        QHBoxLayout* m_top_layout;
        ImageView* m_image_view;
        static Dictionary<UUID, QPointer<QCustomMessageBox>> s_message_boxes;
        std::function<void(QMessageBox::StandardButton, PopupInfo)> m_callback;
        std::function<void(TranslatedString, PopupInfo)> m_label_callback;
        std::function<void(GenericOption, PopupInfo)> m_user_entry_callback;
        GenericOption m_generic_option;
    };
}