button.hpp

Go to the documentation of this file.

/*
    Copyright 2019-2021 natinusala
    Copyright 2019 p-sam
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
        http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
 
#pragma once
 
#include <aurore/core/bind.hpp>
#include <aurore/core/box.hpp>
#include <aurore/views/label.hpp>
 
namespace aurore
{
 
// Style and colors of different buttons styles
// Border color entries can be empty if thickness is 0
// Highlight padding can be empty
// Background color entries can be empty
// Border thickness can be empty
// The rest is mandatory
typedef struct ButtonStyle
{
    // Regular values
    ShadowType shadowType;
    bool hideHighlightBackground;
 
    // Style entries
    std::string highlightPadding;
    std::string borderThickness;
 
    // Theme entries
    std::string enabledBackgroundColor;
    std::string enabledLabelColor;
    std::string enabledBorderColor;
 
    std::string disabledBackgroundColor;
    std::string disabledLabelColor;
    std::string disabledBorderColor;
} ButtonStyle;
 
// primary action button (different background color than default, to catch the eye)
inline const ButtonStyle BUTTONSTYLE_PRIMARY = {
    .shadowType              = ShadowType::GENERIC,
    .hideHighlightBackground = true,
 
    .highlightPadding = "aurore/button/primary_highlight_padding",
    .borderThickness  = "",
 
    .enabledBackgroundColor = "aurore/button/primary_enabled_background",
    .enabledLabelColor      = "aurore/button/primary_enabled_text",
    .enabledBorderColor     = "",
 
    .disabledBackgroundColor = "aurore/button/primary_disabled_background",
    .disabledLabelColor      = "aurore/button/primary_disabled_text",
    .disabledBorderColor     = "",
};
 
// between primary and default - text color is different, background color is the same
inline const ButtonStyle BUTTONSTYLE_HIGHLIGHT = {
    .shadowType              = ShadowType::GENERIC,
    .hideHighlightBackground = true,
 
    .highlightPadding = "",
    .borderThickness  = "",
 
    .enabledBackgroundColor = "aurore/button/default_enabled_background",
    .enabledLabelColor      = "aurore/button/highlight_enabled_text",
    .enabledBorderColor     = "",
 
    .disabledBackgroundColor = "aurore/button/default_disabled_background",
    .disabledLabelColor      = "aurore/button/highlight_disabled_text",
    .disabledBorderColor     = "",
};
 
// default, plain button
inline const ButtonStyle BUTTONSTYLE_DEFAULT = {
    .shadowType              = ShadowType::GENERIC,
    .hideHighlightBackground = true,
 
    .highlightPadding = "",
    .borderThickness  = "",
 
    .enabledBackgroundColor = "aurore/button/default_enabled_background",
    .enabledLabelColor      = "aurore/button/default_enabled_text",
    .enabledBorderColor     = "",
 
    .disabledBackgroundColor = "aurore/button/default_disabled_background",
    .disabledLabelColor      = "aurore/button/default_disabled_text",
    .disabledBorderColor     = "",
};
 
// text and a border
inline const ButtonStyle BUTTONSTYLE_BORDERED = {
    .shadowType              = ShadowType::NONE,
    .hideHighlightBackground = false,
 
    .highlightPadding = "",
    .borderThickness  = "aurore/button/border_thickness",
 
    .enabledBackgroundColor = "",
    .enabledLabelColor      = "aurore/button/default_enabled_text",
    .enabledBorderColor     = "aurore/button/enabled_border_color",
 
    .disabledBackgroundColor = "",
    .disabledLabelColor      = "aurore/button/default_disabled_text",
    .disabledBorderColor     = "aurore/button/disabled_border_color",
};
 
// only text
inline const ButtonStyle BUTTONSTYLE_BORDERLESS = {
    .shadowType              = ShadowType::NONE,
    .hideHighlightBackground = false,
 
    .highlightPadding = "",
    .borderThickness  = "",
 
    .enabledBackgroundColor = "",
    .enabledLabelColor      = "aurore/button/default_enabled_text",
    .enabledBorderColor     = "",
 
    .disabledBackgroundColor = "",
    .disabledLabelColor      = "aurore/button/default_disabled_text",
    .disabledBorderColor     = "",
};
 
enum class ButtonState
{
    ENABLED = 0, // the user can select and click on the button
    DISABLED, // the user can select but not click on the button (greyed out)
};
 
// A button
class Button : public Box
{
  public:
    Button();
 
    void onFocusGained() override;
    void onFocusLost() override;
 
    static View* create();
 
    void setStyle(const ButtonStyle* style);
 
    void setState(ButtonState state);
 
    ButtonState getState();
 
    void setText(std::string text);
 
    void setFontSize(float value);
 
    void setTextColor(NVGcolor color);
 
    std::string getText();
 
    // textColor: its label's.
    bool getStyleProperty(const std::string& name, StyleValue* value) override;
    bool setStyleProperty(const std::string& name, const StyleValue& value) override;
    bool setBoundText(const std::string& text) override;
 
  protected:
    AccessibilityRole getDefaultAccessibilityRole() override { return AccessibilityRole::BUTTON; }
    std::string getDefaultAccessibilityLabel() override { return this->getText(); }
 
  private:
    const ButtonStyle* style = &BUTTONSTYLE_DEFAULT;
    ButtonState state        = ButtonState::ENABLED;
 
    NVGcolor textColor;
    bool textColorOverritten = false;
 
    void applyStyle();
 
    AURORE_BIND(Label, label, "aurore/button/label");
};
 
} // namespace aurore