axmol/core/ui/UITextBMFont.h

/****************************************************************************
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

https://axis-project.github.io/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

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.
****************************************************************************/

#ifndef __UILABELBMFONT_H__
#define __UILABELBMFONT_H__

#include "ui/UIWidget.h"
#include "ui/GUIExport.h"

/**
 * @addtogroup ui
 * @{
 */
NS_AX_BEGIN

class Label;
struct AX_DLL ResourceData;

namespace ui
{

/**
 * A widget for displaying BMFont label.
 */
class AX_GUI_DLL TextBMFont : public Widget
{

    DECLARE_CLASS_GUI_INFO

public:
    /**
     * Default constructor
     * @js ctor
     * @lua new
     */
    TextBMFont();

    /**
     * Default destructor
     * @js NA
     * @lua NA
     */
    virtual ~TextBMFont();

    /**
     * Allocates and initializes.
     */
    static TextBMFont* create();

    static TextBMFont* create(std::string_view text, std::string_view filename);

    /** init a bitmap font atlas with an initial string and the FNT file */
    void setFntFile(std::string_view fileName);

    /** set string value for labelbmfont*/
    void setString(std::string_view value);

    /** get string value for labelbmfont*/
    std::string_view getString() const;

    /**
     * Gets the string length of the label.
     * Note: This length will be larger than the raw string length,
     * if you want to get the raw string length, you should call this->getString().size() instead
     *
     * @return  string length.
     */
    ssize_t getStringLength() const;

    virtual Vec2 getVirtualRendererSize() const override;
    virtual Node* getVirtualRenderer() override;
    /**
     * Returns the "class name" of widget.
     */
    virtual std::string getDescription() const override;

    ResourceData getRenderFile();

    /**
     * reset TextBMFont inner label
     */
    void resetRender();

protected:
    virtual void initRenderer() override;
    virtual void onSizeChanged() override;

    void labelBMFontScaleChangedWithSize();
    virtual Widget* createCloneInstance() override;
    virtual void copySpecialProperties(Widget* model) override;
    virtual void adaptRenderers() override;

protected:
    Label* _labelBMFontRenderer;
    std::string _fntFileName;
    std::string _stringValue;
    bool _labelBMFontRendererAdaptDirty;
};

}  // namespace ui
NS_AX_END
// end of ui group
/// @}

#endif /* defined(__LabelBMFont__) */