-#ifndef __DALI_TOOLKIT_TEXT_DECORATOR_H__
-#define __DALI_TOOLKIT_TEXT_DECORATOR_H__
+#ifndef DALI_TOOLKIT_TEXT_DECORATOR_H
+#define DALI_TOOLKIT_TEXT_DECORATOR_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*/
const Vector2& GetPosition( Cursor cursor ) const;
+
+ /**
+ * @brief Sets the glyph offset of a cursor.
+ *
+ * @param[in] cursor The cursor to set.
+ * @param[in] glyphoffset The difference of line ascender and glyph ascender.
+ */
+ void SetGlyphOffset( Cursor cursor, float glyphOffset );
+
+ /**
+ * @brief Retrieves the glyph offset of a cursor.
+ *
+ * @param[in] cursor The cursor to get.
+ *
+ * @return The glyph offset. glyph offset means difference of line ascender and glyph ascender.
+ */
+ const float GetGlyphOffset( Cursor cursor ) const;
+
/**
* @brief Sets the color for a cursor.
*
*
* @param[in] position The position of the highlighted text in decorator's coords.
* @param[in] size The size of the highlighted text.
+ * @param[in] outlineOffset The outline's offset.
*/
void SetHighLightBox( const Vector2& position,
- const Size& size );
+ const Size& size,
+ float outlineOffset );
/**
* @brief Removes all of the previously added highlights.
bool IsHighlightActive() const;
/**
+ * @brief Retreives whether the highlight is shown or not.
+ *
+ * @return true if the highlight is visible, false otherwise.
+ */
+ bool IsHighlightVisible() const;
+
+ /**
* @brief Sets into the decorator the depth used to render the text.
*
* @param[in] depth The text's depth.
} // namespace Dali
-#endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__
+#endif // DALI_TOOLKIT_TEXT_DECORATOR_H