YiTextLayout.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_TEXT_LAYOUT_H_
#define _YI_TEXT_LAYOUT_H_

#include "framework/YiPredef.h"
#include "graphics/YiTextEngine.h"

class CYITextLayoutLine;
class CYITextRenderer;
class CYIString;


typedef enum{
    YI_TEXT_DIRECTION_LTR           = 0, /* Text flows from left to right */
    YI_TEXT_DIRECTION_RTL           = 1, /* Text flows from rigth to left */
    YI_TEXT_DIRECTION_MIXED         = 2, /* Text contains both left to right and right to left flowing text */
    YI_TEXT_DIRECTION_UNDEFINED     = 3  /* Text has not been specified or contains no left to right or right to left characters */
} YI_TEXT_DIRECTION;


class CYITextLayout
{
public:
    CYITextLayout(){};

    virtual ~CYITextLayout(){};

    virtual bool LayoutText(const YI_TEXT_RENDER_INFO &TextRenderInfo, const CYITextRenderer *pTextRenderer) = 0;

    virtual uint32_t GetLineCount() const = 0;

    virtual const CYITextLayoutLine *GetTextLine(uint32_t nIndex) const = 0;

    virtual YI_TEXT_DIRECTION GetTextDirection() const = 0;

    virtual bool IsComplex() const = 0;

    virtual int32_t GetAscent() const = 0;

    virtual int32_t GetDescent() const = 0;

    virtual int32_t GetLeading() const = 0;

    virtual float GetGlyphBoxVerticalOffset() const = 0;

    virtual float GetFirstBaselineVerticalOffset() const = 0;

    virtual void Clear() = 0;

    virtual int32_t GetIndexOfPosition(float fX, float fY, float fHorizontalPixelRatio, float fVerticalPixelRatio) const = 0;

    virtual YI_FLOAT_RECT GetRectForTextRange(int32_t nStartIndex, int32_t nEndIndex, float fHorizontalPixelRatio, float fVerticalPixelRatio) const = 0;
};

#endif // _YI_TEXT_LAYOUT_H_