UIControl.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "UIView.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/Event.hpp"
 
namespace CeresEngine {
 
    using UIControlPtr = UIPtr<class UIControl>;
 
    class UIControl : public UIView {
    public:
        struct State {
        public:
            UInt32 raw = 0;
 
            constexpr State() = default;
 
            explicit constexpr State(const UInt32 raw) : raw(raw){};
 
        public:
            constexpr State operator+(const State& other) const noexcept { return State(raw | other.raw); }
            constexpr State& operator+=(const State& other) noexcept {
                raw |= other.raw;
                return *this;
            }
 
            constexpr State operator-(const State& other) const noexcept { return State(raw & ~other.raw); }
            constexpr State& operator-=(const State& other) noexcept {
                raw &= ~other.raw;
                return *this;
            }
 
            [[nodiscard]] constexpr bool contains(const State& member) const noexcept { return (raw & member.raw) == member.raw; }
 
            [[nodiscard]] constexpr bool operator[](const State& other) const noexcept { return contains(other); }
 
            [[nodiscard]] constexpr bool operator==(const State& other) const noexcept { return raw == other.raw; }
 
            [[nodiscard]] constexpr bool operator!=(const State& other) const noexcept { return raw != other.raw; }
 
        public: // Color transformations
            [[nodiscard]] UIColor operator()(const UIColor& baseColor) const noexcept;
 
        public: // Constants
            static const State Normal; // NOLINT(readability-identifier-naming)
 
            static const State Highlighted; // NOLINT(readability-identifier-naming)
 
            static const State Disabled; // NOLINT(readability-identifier-naming)
 
            static const State Selected; // NOLINT(readability-identifier-naming)
 
            static const State Focused; // NOLINT(readability-identifier-naming)
        };
 
        enum class ContentVerticalAlignment {
            Center,
 
            Top,
 
            Bottom,
 
            Fill
        };
 
        enum class ContentHorizontalAlignment {
            Center,
 
            Left,
 
            Right,
 
            Fill,
 
            Leading,
 
            Trailing
        };
 
    private:
        State mState = State::Normal;
 
        ContentVerticalAlignment mContentVerticalAlignment = ContentVerticalAlignment::Top;
 
        ContentHorizontalAlignment mContentHorizontalAlignment = ContentHorizontalAlignment::Center;
 
    public:
        Event<void()> didGainFocus;
 
        Event<void()> didLostFocus;
 
    public:
        explicit UIControl() : UIControl(kDefaultFrame) {}
        explicit UIControl(const UIRect& frame);
        ~UIControl() override;
 
    public:
        [[nodiscard]] const State& getState() const noexcept { return mState; }
 
        void setState(const State& state);
 
        [[nodiscard]] bool isEnabled() const noexcept { return !mState.contains(State::Disabled); }
 
        [[nodiscard]] bool isDisabled() const noexcept { return mState.contains(State::Disabled); }
 
        void setEnabled(bool enabled);
 
        [[nodiscard]] bool isHighlighted() const noexcept;
 
        void setHighlighted(bool highlighted);
 
        [[nodiscard]] bool isSelected() const noexcept;
 
        void setSelected(bool selected);
 
        [[nodiscard]] ContentVerticalAlignment getContentVerticalAlignment() const { return mContentVerticalAlignment; }
 
        void setContentVerticalAlignment(ContentVerticalAlignment contentVerticalAlignment);
 
        [[nodiscard]] ContentHorizontalAlignment getContentHorizontalAlignment() const { return mContentHorizontalAlignment; }
 
        void setContentHorizontalAlignment(ContentHorizontalAlignment contentHorizontalAlignment);
 
    protected:
        virtual void didChangeState(const State& oldState, const State& newState) {}
 
        virtual void confirmAction();
 
        virtual void cancelAction();
 
    public: // UIResponder
        [[nodiscard]] bool acceptsFirstResponder() const override;
 
        [[nodiscard]] bool becomeFirstResponder() override;
 
        [[nodiscard]] bool resignFirstResponder() override;
 
        void mouseDown(const UIMouseEvent& event) override;
 
        void mouseUp(const UIMouseEvent& event) override;
 
        void rightMouseDown(const UIMouseEvent& event) override;
 
        void rightMouseUp(const UIMouseEvent& event) override;
 
        void mouseMoved(const UIMouseEvent& event) override;
 
        void mouseEntered(const UIMouseEvent& event) override;
 
        void mouseExited(const UIMouseEvent& event) override;
 
        void keyDown(const UIKeyEvent& event) override;
 
    public: // Appearance Properties
        static const UIFloatAppearanceProperty controlSizeProperty;
 
        static const UIFloatAppearanceProperty borderRadiusProperty;
 
        static const UIFloatAppearanceProperty topLeftBorderRadiusProperty;
 
        static const UIFloatAppearanceProperty topRightBorderRadiusProperty;
 
        static const UIFloatAppearanceProperty bottomLeftBorderRadiusProperty;
 
        static const UIFloatAppearanceProperty bottomRightBorderRadiusProperty;
    };
 
    std::ostream& operator<<(std::ostream& os, const UIControl::State& state);
 
} // namespace CeresEngine