button.hpp

Go to the documentation of this file.

// button.hpp
/*
  neogfx C++ App/Game Engine
  Copyright (c) 2015, 2020 Leigh Johnston.  All Rights Reserved.
  
  This program is free software: you can redistribute it and / or modify
  it 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.
  
  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include <neogfx/neogfx.hpp>
#include <neogfx/core/event.hpp>
#include <neogfx/app/i_mnemonic.hpp>
#include <neogfx/gui/widget/i_button.hpp>
#include <neogfx/gui/widget/widget.hpp>
#include <neogfx/gui/widget/label.hpp>
#include <neogfx/gui/layout/horizontal_layout.hpp>
 
namespace neogfx
{
    extern template class widget<i_button>;
 
    template <typename ButtonInterface = i_button>
    class button : public widget<ButtonInterface>, protected i_mnemonic
    {
        meta_object(widget<ButtonInterface>)
        // events
    public:
        define_declared_event(Pressed, pressed)
        define_declared_event(Clicked, clicked)
        define_declared_event(DoubleClicked, double_clicked)
        define_declared_event(RightClicked, right_clicked)
        define_declared_event(Released, released)
    public:
        define_declared_event(Toggled, toggled)
        define_declared_event(Checked, checked)
        define_declared_event(Unchecked, unchecked)
        define_declared_event(Indeterminate, indeterminate)
        // types
    public:
        typedef ButtonInterface button_interface;
        // button
    public:
        button(alignment aAlignment = alignment::Left | alignment::VCenter);
        button(std::string const& aText, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(const i_texture& aTexture, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(const i_image& aImaget, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(std::string const& aText, const i_texture& aTexture, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(std::string const& aText, const i_image& aImaget, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_widget& aParent, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_widget& aParent, std::string const& aText, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_widget& aParent, const i_texture& aTexture, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_widget& aParent, const i_image& aImage, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_widget& aParent, std::string const& aText, const i_texture& aTexture, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_widget& aParent, std::string const& aText, const i_image& aImage, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_layout& aLayout, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_layout& aLayout, std::string const& aText, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_layout& aLayout, const i_texture& aTexture, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_layout& aLayout, const i_image& aImage, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_layout& aLayout, std::string const& aText, const i_texture& aTexture, alignment aAlignment = alignment::Left | alignment::VCenter);
        button(i_layout& aLayout, std::string const& aText, const i_image& aImage, alignment aAlignment = alignment::Left | alignment::VCenter);
        ~button();
        // widget
    public:
        using base_type::as_widget;
        neogfx::size_policy size_policy() const override;
        size maximum_size(optional_size const&) const override;
        neogfx::padding padding() const override;
        // i_button
    public:
        bool is_pressed() const override;
        button_checkable checkable() const override;
        void set_checkable(button_checkable aCheckable = button_checkable::BiState) override;
        bool is_checked() const override;
        bool is_unchecked() const override;
        bool is_indeterminate() const override;
        void check() override;
        void uncheck() override;
        void set_indeterminate() override;
        void set_checked(bool aChecked) override;
        void toggle() override;
        // button
    public:
        i_string const& text() const;
        void set_text(i_string const& aText);
        const texture& image() const;
        void set_image(i_string const& aImageUri);
        void set_image(const neogfx::image& aImage);
        void set_image(const texture& aImage);
        void set_image_extents(const optional_size& aImageExtents);
        const neogfx::label& label() const;
        neogfx::label& label();
        const neogfx::text_widget& text_widget() const;
        neogfx::text_widget& text_widget();
        const neogfx::image_widget& image_widget() const;
        neogfx::image_widget& image_widget();
        // widget
    protected:
        void mouse_button_pressed(mouse_button aButton, const point& aPosition, key_modifiers_e aKeyModifiers) override;
        void mouse_button_double_clicked(mouse_button aButton, const point& aPosition, key_modifiers_e aKeyModifiers) override;
        void mouse_button_released(mouse_button aButton, const point& aPosition) override;
    protected:
        bool key_pressed(scan_code_e aScanCode, key_code_e aKeyCode, key_modifiers_e aKeyModifiers) override;
        // button
    protected:
        virtual void handle_clicked();
    protected:
        virtual bool can_toggle() const;
        virtual const std::optional<bool>& checked_state() const;
        virtual bool set_checked_state(const std::optional<bool>& aCheckedState);
    protected:
        std::string mnemonic() const override;
        void mnemonic_execute() override;
        i_widget& mnemonic_widget() override;
    private:
        void init();
    private:
        sink iSink;
        bool iPressed;
        button_checkable iCheckable;
        button_checked_state iCheckedState;
        horizontal_layout iLayout;
        size_policy_of_parent<neogfx::label, layout_item_category::Widget> iLabel;
    };
}