label.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/animation.hpp>
#include <aurore/core/observable.hpp>
#include <aurore/core/timer.hpp>
#include <aurore/core/view.hpp>
#ifdef OPENCC
#define Opencc_BUILT_AS_STATIC
#include <opencc.h>
#endif
 
namespace aurore
{
 
enum class HorizontalAlign
{
    LEFT,
    CENTER,
    RIGHT,
};
 
enum class VerticalAlign
{
    BASELINE,
    TOP,
    CENTER,
    BOTTOM,
};
 
enum class CursorPosition
{
    UNSET = -2,
    END   = -1,
    START = 0,
};
 
class Label : public View
{
  public:
    Label();
    ~Label() override;
 
    void draw(NVGcontext* vg, float x, float y, float width, float height, Style style, FrameContext* ctx) override;
    void onLayout() override;
    void onFocusGained() override;
    void onFocusLost() override;
    void onParentFocusGained(View* focusedView) override;
    void onParentFocusLost(View* focusedView) override;
 
    virtual void setText(const std::string& text);
 
    void setHorizontalAlign(HorizontalAlign align);
 
    void setVerticalAlign(VerticalAlign align);
 
    void setFontSize(float value);
    static void setFontScale(float scale);
    static float getFontScale();
    void setFontScaled(bool scaled);
    void setFontScaleMax(float max);
    void setShrinkToFit(bool shrink);
    bool isShrinkingToFit();
    void setShrinkToFitMin(float size);
    float getDrawnFontSize();
    float getFullFontSize();
    void setFontQuality(float value);
    void setLineHeight(float value);
    void setTextColor(NVGcolor color);
 
    void setFont(int font);
    bool setFontFamily(const std::string& name);
 
    int getFont();
    float getFontSize();
    float getFontQuality();
    float getLineHeight();
    NVGcolor getTextColor();
 
    std::string getFullText();
 
    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;
    void onTextScaleChanged() override;
 
    void bindText(Observable<std::string>& text);
    bool isTruncated();
 
    static View* create();
 
    void setRequiredWidth(float requiredWidth);
    void setEllipsisWidth(float ellipsisWidth);
 
    void setAnimated(bool animated);
 
    void setAutoAnimate(bool autoAnimate);
 
    void setSingleLine(bool singleLine);
 
    bool isSingleLine();
 
    void setIsWrapping(bool isWrapping);
 
    static std::string STConverter(const std::string& text);
 
    static inline bool OPENCC_ON   = true; 
    static inline float FONT_SCALE = 1.0f; 
    void setCursor(int cursor);
 
  protected:
    AccessibilityRole getDefaultAccessibilityRole() override { return AccessibilityRole::LABEL; }
    std::string getDefaultAccessibilityLabel() override { return this->getFullText(); }
 
    std::string truncatedText;
    std::string fullText;
 
    int font;
    float fontSize;
    bool fontScaled    = true;
    float fontScaleMax = 1e6f;
    bool shrinkToFit   = false;
    float shrinkMin    = 0; 
    float fitScale     = 1.0f; 
    float fittedWidth  = 0; 
    float textWidth(); 
    float lineHeight;
    float fontQuality;
 
    NVGcolor textColor;
 
    float requiredWidth    = 0;
    unsigned ellipsisWidth = 0;
    size_t stringLength    = 0;
 
    bool singleLine = false;
    bool isWrapping = false;
 
    bool autoAnimate  = true;
    bool animated     = false; 
    bool animating    = false; 
    int cursor        = -2;
    Time cursor_blink = 0;
 
    Timer scrollingTimer;
    Animatable scrollingAnimation;
 
    void stopScrollingAnimation();
    void resetScrollingAnimation();
 
    void startScrollTimer();
    void onScrollTimerFinished();
 
    HorizontalAlign horizontalAlign = HorizontalAlign::LEFT;
    VerticalAlign verticalAlign     = VerticalAlign::CENTER;
 
    enum NVGalign getNVGHorizontalAlign();
    enum NVGalign getNVGVerticalAlign();
};
 
} // namespace aurore