Button.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: Button
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/TranslatedString.h>
#include <NDEVR/RGBColor.h>
#include <NDEVR/TimeSpan.h>
#include <QToolButton>
#include <functional>
#include <QEvent>
#include <QPointer>
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
typedef QEvent ButtonEnterEvent;
#else
typedef QEnterEvent ButtonEnterEvent;
#endif
class QStylePainter;
class QStyleOptionToolButton;
class QPushButton;
namespace NDEVR
{
    class ButtonDialog;
    class QTResourceListener;
    enum class TooltipType;
    template<class t_type>
    class Resource;
    template<class t_type>
    class ApplicationOption;
    struct GenericOption;
    /**--------------------------------------------------------------------------------------------------
    \brief A core widget that allows the user to click one of many button types.
 
    Perhaps the most commonly used widget in any graphical user interface. Push (click) a button to 
        command the computer to perform some action, or to answer a question.
    **/
    class NDEVR_WIDGETS_API Button : public QToolButton
    {
        friend class HoverButtonIconWatch;
        Q_OBJECT
    public:
        enum ButtonState
        {
              e_large
            , e_medium
            , e_medium_centered
            , e_small
            , e_circular
            , e_circular_small
            , e_push_button
            , e_none
        };
    public:
        Button(QWidget* parent = nullptr);
        Button(ButtonState state, QWidget* parent = nullptr);
        Button(const TranslatedString& name, const String& icon = "", QWidget* parent = nullptr);
        Button(const std::function<void(Button*)>& on_click, QWidget* parent = nullptr);
        Button(const TranslatedString& name, const std::function<void(Button*)>& on_click, QWidget* parent = nullptr);
        Button(const TranslatedString& name, const String& icon, const std::function<void(Button*)>& on_click, QWidget* parent = nullptr);
        Button(const TranslatedString& name, const String& icon, TooltipType tooltip, const std::function<void(Button*)>& on_click, QWidget* parent = nullptr);
        ~Button();
        void paintEvent(QPaintEvent *event) override;
        void setAlignment(Qt::Alignment m_alignment);
        void setup(const TranslatedString& name, const String& icon, const std::function<void(Button*)>& on_click);
        void setup(const TranslatedString& name, const String& icon, TooltipType tooltip, const std::function<void(Button*)>& on_click);
        void setup(const TranslatedString& name, const String& icon, Resource<bool>& checked_var);
        void setup(GenericOption& checked_var);
        void setup(ApplicationOption<bool>& checked_var);
        void setup(const TranslatedString& name, const String& icon, ApplicationOption<bool>& checked_var);
        int styleDefaultIconSize() const;
        int scaledIconSize() const;
        void setToolTip(TooltipType type);
        void setToolTip(const QString& tip);
        void setButtonState(ButtonState state);
        void showPopupMenu(QWidget* widget, bool is_popup = true);
        bool requestButtonState(ButtonState state);
        void requestFixedState(bool fixed_state);
        ButtonState buttonState() const { return m_state; }
        void setFunction(const std::function<void(Button*)>& on_click) { m_on_click = on_click; }
        void setHoverFunction(const std::function<void(Button*, bool hovering)>& on_hover) { m_on_hover = on_hover; }
        void setPressFunction(const std::function<void(Button*, bool hovering)>& on_press) { m_on_press = on_press; }
        void enterEvent(ButtonEnterEvent* e) override;
        void leaveEvent(QEvent* e) override;
        void setMargin(uint04 margin);
        void setIconSize(int size);
        void setProgressPercent(fltp04 progress);
        bool event(QEvent* e) override;
        void setIconSizeMultiplier(fltp04 icon_size_multiplier);
        void setHoverIconSizeMultiplier(fltp04 icon_size_multiplier);
        void setTitle(const TranslatedString& title);
        void setText(const QString &text);
        const TranslatedString& title() const;
        const String& iconName() const;
        void setIconName(const String& icon);
        void setIcon(const QIcon& icon);
        void setHoverIconName(const String& icon);
        void setCheckedIconName(const String& icon);
        bool eventFilter(QObject* watched, QEvent* event) override;
        void setToolTip(const TranslatedString& tooltip);
        void setDisabledToolTip(const TranslatedString& tooltip);
        void setToolTip(const TranslatedString& enabled_tooltip, const TranslatedString& disabled_tooltip);
        void setFlat(bool is_flat);
        void setButtonDialog(ButtonDialog* dialog);
        void setSound(const String& sound);
        void setIgnoreClicks(bool ignore_clicks) { m_ignore_clicks = ignore_clicks; }
        void copyButtonFrom(Button* button);
        void setBackgroundOpacity(fltp04 background_opacity);
        void setMenuDialog(QWidget* widget);
        void setIconColor(const RGBColor& color);
        void setBackgroundColor(const RGBColor& color, bool update_foreground = true);
        void clearBackgroundColor();
        void setFocusOnPress(bool focus_on_press);
        void setAutoDefault(bool is_auto_default);
        void setDefault(bool is_default);
        void setCheckable(bool checkable);
        void setChecked(bool checked);
        QSize sizeHint() const override;
        QSize minimumSizeHint() const override;
        void virtualMouseEvent(QEvent::Type event);
        void setFontMultiplier(fltp04 font_multiplier);
        void setBold(bool is_bold);
        void setMenu(QMenu* menu);
        void setClickCooldown(const TimeSpan& span);
        QMenu* menu() const;
    protected:
        void mouseReleaseEvent(QMouseEvent*) override;
        void mousePressEvent(QMouseEvent*) override;
    protected slots:
        void onButtonClickSlot();
        void onButtonPressSlot();
        void onButtonReleaseSlot();
    private:
        QString autoWrapText(const QFontMetrics& metrics);
        void updateTooltip();
        void updateText();
        bool ignorePress() const;
        void setup();
        void _setIcon(const String & icon, bool force = false);
        void updateFont();
        void _defaultRender(QStylePainter* p, QStyleOptionToolButton* tool_button, QIcon::State state, QIcon::Mode mode, bool draw_backgound, bool is_default);
    protected:
        std::function<void(Button*)> m_on_click = nullptr;
        std::function<void(Button*, bool hovering)> m_on_hover = nullptr;
        std::function<void(Button*, bool pressing)> m_on_press = nullptr;
        QTResourceListener* m_icon_theme_listener = nullptr;
        ButtonDialog* m_dialog = nullptr;
        QPointer<QWidget> m_menu_dialog = nullptr;
        TranslatedString m_title;
        TranslatedString m_disabled_tooltip;
        TranslatedString m_enabled_tooltip;
        String m_icon;
        String m_current_icon;
        String m_hover_icon;
        String m_checked_icon;
        String m_sound;
        Time m_last_click_time = Time(0);
        TimeSpan m_click_cooldown = TimeSpan(0.1);
        fltp04 m_icon_size_multiplier = 1.0f;
        uint04 m_margin = Constant<uint04>::Invalid;
        fltp04 m_hover_icon_size_multiplier = Constant<fltp04>::Invalid;
        fltp04 m_progress = Constant<fltp04>::Invalid;
        fltp04 m_background_opacity = 1.0f;
        ButtonState m_state = ButtonState::e_large;
        bool m_ignore_clicks = false;
        bool m_fixed_state_requested = false;
        bool m_has_custom_background_color = false;
        bool m_focus_on_press = true;
        Qt::Alignment m_alignment;
        RGBColor m_icon_color;
        
        QPushButton* m_push_button = nullptr;
        bool m_is_default_button = false;
        bool m_is_auto_default_button = false;
        fltp04 m_font_multiplier = 1.0f;
        bool m_is_bold = false;
    public:
        static String s_default_sound;
    };
}