#define __DALI_TOOLKIT_TEXT_CONTROLLER_H__
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2016 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.
SHAPE_TEXT = 0x0040,
GET_GLYPH_METRICS = 0x0080,
LAYOUT = 0x0100,
- UPDATE_ACTUAL_SIZE = 0x0200,
+ UPDATE_LAYOUT_SIZE = 0x0200,
REORDER = 0x0400,
ALIGN = 0x0800,
COLOR = 0x1000,
DONT_UPDATE_INPUT_STYLE
};
+ enum UpdateTextType
+ {
+ NONE_UPDATED = 0x0,
+ MODEL_UPDATED = 0x1,
+ DECORATOR_UPDATED = 0x2
+ };
+
/**
* @brief Create a new instance of a Controller.
*
float GetAutoScrollLineAlignment() const;
/**
+ * @brief Enables the horizontal scrolling.
+ *
+ * @param[in] enable Whether to enable the horizontal scrolling.
+ */
+ void SetHorizontalScrollEnabled( bool enable );
+
+ /**
+ * @brief Retrieves whether the horizontal scrolling is enabled.
+ *
+ * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false.
+ */
+ bool IsHorizontalScrollEnabled() const;
+
+ /**
+ * @brief Enables the vertical scrolling.
+ *
+ * @param[in] enable Whether to enable the vertical scrolling.
+ */
+ void SetVerticalScrollEnabled( bool enable );
+
+ /**
+ * @brief Retrieves whether the verticall scrolling is enabled.
+ *
+ * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false.
+ */
+ bool IsVerticalScrollEnabled() const;
+
+ /**
+ * @brief Enables the smooth handle panning.
+ *
+ * @param[in] enable Whether to enable the smooth handle panning.
+ */
+ void SetSmoothHandlePanEnabled( bool enable );
+
+ /**
+ * @brief Retrieves whether the smooth handle panning is enabled.
+ *
+ * @return @e true if the smooth handle panning is enabled.
+ */
+ bool IsSmoothHandlePanEnabled() const;
+
+ /**
* @brief Replaces any text previously set.
*
* @note This will be converted into UTF-32 when stored in the text model.
/**
* @brief Retrieve any text previously set.
*
- * @return A string of UTF-8 characters.
+ * @param[out] text A string of UTF-8 characters.
*/
void GetText( std::string& text ) const;
UpdateInputStyleType type );
/**
- * @brief Retrieve the current cursor position.
- *
- * @return The cursor position.
- */
- unsigned int GetLogicalCursorPosition() const;
-
- /**
* @brief Replaces any placeholder text previously set.
*
* @param[in] type Different placeholder-text can be shown when the control is active/inactive.
const std::string& GetDefaultFontFamily() const;
/**
- * @brief Sets the font's style string.
- *
- * @note The style set may be changed by the underlying font system. The string is stored to be recovered.
- *
- * @param[in] style The font's style string.
- */
- void SetDefaultFontStyle( const std::string& style );
-
- /**
- * @brief Retrieves the font's style.
- *
- * @return The font's style.
- */
- const std::string& GetDefaultFontStyle() const;
-
- /**
* @brief Sets the default font weight.
*
* @param[in] weight The font weight.
void SetDefaultFontWeight( FontWeight weight );
/**
+ * @brief Whether the font's weight has been defined.
+ */
+ bool IsDefaultFontWeightDefined() const;
+
+ /**
* @brief Retrieves the default font weight.
*
* @return The default font weight.
void SetDefaultFontWidth( FontWidth width );
/**
+ * @brief Whether the font's width has been defined.
+ */
+ bool IsDefaultFontWidthDefined() const;
+
+ /**
* @brief Retrieves the default font width.
*
* @return The default font width.
void SetDefaultFontSlant( FontSlant slant );
/**
+ * @brief Whether the font's slant has been defined.
+ */
+ bool IsDefaultFontSlantDefined() const;
+
+ /**
* @brief Retrieves the default font slant.
*
* @return The default font slant.
const std::string& GetInputFontFamily() const;
/**
- * @brief Sets the input text's font style.
- *
- * @param[in] fontStyle The input text's font style.
- */
- void SetInputFontStyle( const std::string& fontStyle );
-
- /**
- * @brief Retrieves the input text's font style.
- *
- * @return The input text's font style.
- */
- const std::string& GetInputFontStyle() const;
-
- /**
* @brief Sets the input font's weight.
*
* @param[in] weight The input font's weight.
void SetInputFontWeight( FontWeight weight );
/**
+ * @return Whether the font's weight has been defined.
+ */
+ bool IsInputFontWeightDefined() const;
+
+ /**
* @brief Retrieves the input font's weight.
*
* @return The input font's weight.
void SetInputFontWidth( FontWidth width );
/**
+ * @return Whether the font's width has been defined.
+ */
+ bool IsInputFontWidthDefined() const;
+
+ /**
* @brief Retrieves the input font's width.
*
* @return The input font's width.
void SetInputFontSlant( FontSlant slant );
/**
+ * @return Whether the font's slant has been defined.
+ */
+ bool IsInputFontSlantDefined() const;
+
+ /**
* @brief Retrieves the input font's slant.
*
* @return The input font's slant.
*
* @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
* @param[in] size A the size of a bounding box to layout text within.
- * @return True if the text model or decorations were updated.
+ *
+ * @return Whether the text model or decorations were updated.
*/
- bool Relayout( const Size& size );
+ UpdateTextType Relayout( const Size& size );
/**
* @brief Process queued events which modify the model.
void ProcessModifyEvents();
/**
+ * @return Whether the queue of input style changed signals is empty.
+ */
+ bool IsInputStyleChangedSignalsQueueEmpty();
+
+ /**
+ * @brief Process all pending input style changed signals.
+ *
+ * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
+ * text controls. Text controls may send signals to state the input style has changed.
+ */
+ void ProcessInputStyleChangedSignals();
+
+ /**
* @brief Used to remove placeholder text.
*/
void ResetText();
bool BackspaceKeyEvent();
/**
- * @brief Helper to notify IMF manager with surrounding text & cursor changes.
- */
- void NotifyImfManager();
-
- /**
* @brief Helper to clear font-specific data.
*/
void ShowPlaceholderText();