-#ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_H__
-#define __DALI_TOOLKIT_TEXT_CONTROLLER_H__
+#ifndef DALI_TOOLKIT_TEXT_CONTROLLER_H
+#define DALI_TOOLKIT_TEXT_CONTROLLER_H
/*
* Copyright (c) 2016 Samsung Electronics Co., Ltd.
#include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
#include <dali-toolkit/internal/text/decorator/text-decorator.h>
#include <dali-toolkit/internal/text/layouts/layout-engine.h>
-#include <dali-toolkit/internal/text/text-control-interface.h>
namespace Dali
{
{
class Controller;
+class ControlInterface;
+class EditableControlInterface;
class View;
typedef IntrusivePtr<Controller> ControllerPtr;
-typedef Dali::Toolkit::Text::ControlInterface ControlInterface;
-
-/**
- * @brief Different placeholder-text can be shown when the control is active/inactive.
- */
-enum PlaceholderType
-{
- PLACEHOLDER_TYPE_ACTIVE,
- PLACEHOLDER_TYPE_INACTIVE,
-};
/**
* @brief A Text Controller is used by UI Controls which display text.
*/
class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface
{
-public:
+public: // Enumerated types.
/**
* @brief Text related operations to be done in the relayout process.
DONT_UPDATE_INPUT_STYLE
};
+ /**
+ * @brief Used to specify what has been updated after the Relayout() method has been called.
+ */
enum UpdateTextType
{
- NONE_UPDATED = 0x0,
- MODEL_UPDATED = 0x1,
- DECORATOR_UPDATED = 0x2
+ NONE_UPDATED = 0x0, ///< Nothing has been updated.
+ MODEL_UPDATED = 0x1, ///< The text's model has been updated.
+ DECORATOR_UPDATED = 0x2 ///< The decoration has been updated.
};
/**
+ * @brief Different placeholder-text can be shown when the control is active/inactive.
+ */
+ enum PlaceholderType
+ {
+ PLACEHOLDER_TYPE_ACTIVE,
+ PLACEHOLDER_TYPE_INACTIVE,
+ };
+
+public: // Constructor.
+
+ /**
+ * @brief Create a new instance of a Controller.
+ *
+ * @return A pointer to a new Controller.
+ */
+ static ControllerPtr New();
+
+ /**
+ * @brief Create a new instance of a Controller.
+ *
+ * @param[in] controlInterface The control's interface.
+ *
+ * @return A pointer to a new Controller.
+ */
+ static ControllerPtr New( ControlInterface* controlInterface );
+
+ /**
* @brief Create a new instance of a Controller.
*
- * @param[in] controlInterface An interface used to request a text relayout.
+ * @param[in] controlInterface The control's interface.
+ * @param[in] editableControlInterface The editable control's interface.
+ *
* @return A pointer to a new Controller.
*/
- static ControllerPtr New( ControlInterface& controlInterface );
+ static ControllerPtr New( ControlInterface* controlInterface,
+ EditableControlInterface* editableControlInterface );
+
+public: // Configure the text controller.
/**
* @brief Called to enable text input.
bool IsSmoothHandlePanEnabled() const;
/**
+ * @brief Sets the maximum number of characters that can be inserted into the TextModel
+ *
+ * @param[in] maxCharacters maximum number of characters to be accepted
+ */
+ void SetMaximumNumberOfCharacters( Length maxCharacters );
+
+ /**
+ * @brief Sets the maximum number of characters that can be inserted into the TextModel
+ *
+ * @param[in] maxCharacters maximum number of characters to be accepted
+ */
+ int GetMaximumNumberOfCharacters();
+
+ /**
+ * @brief Called to enable/disable cursor blink.
+ *
+ * @note Only editable controls should calls this.
+ * @param[in] enabled Whether the cursor should blink or not.
+ */
+ void SetEnableCursorBlink( bool enable );
+
+ /**
+ * @brief Query whether cursor blink is enabled.
+ *
+ * @return Whether the cursor should blink or not.
+ */
+ bool GetEnableCursorBlink() const;
+
+ /**
+ * @brief Whether to enable the multi-line layout.
+ *
+ * @param[in] enable \e true enables the multi-line (by default)
+ */
+ void SetMultiLineEnabled( bool enable );
+
+ /**
+ * @return Whether the multi-line layout is enabled.
+ */
+ bool IsMultiLineEnabled() const;
+
+ /**
+ * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
+ */
+ void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
+
+ /**
+ * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
+ */
+ LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
+
+ /**
+ * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
+ */
+ void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
+
+ /**
+ * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
+ */
+ LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
+
+public: // Update.
+
+ /**
* @brief Replaces any text previously set.
*
* @note This will be converted into UTF-32 when stored in the text model.
void GetText( std::string& text ) const;
/**
- * @brief Remove a given number of characters
- *
- * When predictve text is used the pre-edit text is removed and inserted again with the new characters.
- * The UpdateInputStyleType @type parameter if set to DONT_UPDATE_INPUT_STYLE avoids to update the input
- * style when pre-edit text is removed.
- *
- * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
- * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset.
- * @param[in] type Whether to update the input style.
- * @return True if the remove was successful.
- */
- bool RemoveText( int cursorOffset,
- int numberOfCharacters,
- UpdateInputStyleType type );
-
- /**
* @brief Replaces any placeholder text previously set.
*
* @param[in] type Different placeholder-text can be shown when the control is active/inactive.
void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
/**
- * @brief Sets the maximum number of characters that can be inserted into the TextModel
- *
- * @param[in] maxCharacters maximum number of characters to be accepted
+ * @ brief Update the text after a font change
+ * @param[in] newDefaultFont The new font to change to
*/
- void SetMaximumNumberOfCharacters( Length maxCharacters );
+ void UpdateAfterFontChange( const std::string& newDefaultFont );
- /**
- * @brief Sets the maximum number of characters that can be inserted into the TextModel
- *
- * @param[in] maxCharacters maximum number of characters to be accepted
- */
- int GetMaximumNumberOfCharacters();
+public: // Default style & Input style
/**
* @brief Set the default font family.
float GetDefaultPointSize() const;
/**
- * @ brief Update the text after a font change
- * @param[in] newDefaultFont The new font to change to
- */
- void UpdateAfterFontChange( const std::string& newDefaultFont );
-
- /**
* @brief Set the text color
*
* @param textColor The text color
const Vector4& GetShadowColor() const;
/**
- * @brief Sets the shadow's properties string.
- *
- * @note The string is stored to be recovered.
- *
- * @param[in] shadowProperties The shadow's properties string.
- */
- void SetDefaultShadowProperties( const std::string& shadowProperties );
-
- /**
- * @brief Retrieves the shadow's properties string.
- *
- * @return The shadow's properties string.
- */
- const std::string& GetDefaultShadowProperties() const;
-
- /**
* @brief Set the underline color.
*
* @param[in] color color of underline.
float GetUnderlineHeight() const;
/**
- * @brief Sets the underline's properties string.
- *
- * @note The string is stored to be recovered.
- *
- * @param[in] underlineProperties The underline's properties string.
- */
- void SetDefaultUnderlineProperties( const std::string& underlineProperties );
-
- /**
- * @brief Retrieves the underline's properties string.
- *
- * @return The underline's properties string.
- */
- const std::string& GetDefaultUnderlineProperties() const;
-
- /**
* @brief Sets the emboss's properties string.
*
* @note The string is stored to be recovered.
*/
const std::string& GetInputOutlineProperties() const;
+public: // Queries & retrieves.
+
/**
- * @brief Called to enable/disable cursor blink.
+ * @brief Return the layout engine.
*
- * @note Only editable controls should calls this.
- * @param[in] enabled Whether the cursor should blink or not.
+ * @return A reference to the layout engine.
*/
- void SetEnableCursorBlink( bool enable );
+ LayoutEngine& GetLayoutEngine();
/**
- * @brief Query whether cursor blink is enabled.
+ * @brief Return a view of the text.
*
- * @return Whether the cursor should blink or not.
+ * @return A reference to the view.
*/
- bool GetEnableCursorBlink() const;
+ View& GetView();
/**
* @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
*/
float GetHeightForWidth( float width );
+public: // Relayout.
+
/**
* @brief Triggers a relayout which updates View (if necessary).
*
UpdateTextType Relayout( const Size& size );
/**
- * @brief Process queued events which modify the model.
+ * @brief Request a relayout using the ControlInterface.
*/
- void ProcessModifyEvents();
+ void RequestRelayout();
+
+public: // Input style change signals.
/**
- * @brief Used to remove placeholder text.
+ * @return Whether the queue of input style changed signals is empty.
*/
- void ResetText();
+ bool IsInputStyleChangedSignalsQueueEmpty();
/**
- * @brief Used to reset the cursor position after setting a new text.
+ * @brief Process all pending input style changed signals.
*
- * @param[in] cursorIndex Where to place the cursor.
+ * 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 ResetCursorPosition( CharacterIndex cursorIndex );
+ void ProcessInputStyleChangedSignals();
+
+public: // Text-input Event Queuing.
/**
- * @brief Used to reset the scroll position after setting a new text.
+ * @brief Called by editable UI controls when keyboard focus is gained.
*/
- void ResetScrollPosition();
+ void KeyboardFocusGainEvent();
/**
- * @brief Used to process an event queued from SetText()
+ * @brief Called by editable UI controls when focus is lost.
*/
- void TextReplacedEvent();
+ void KeyboardFocusLostEvent();
/**
- * @brief Used to process an event queued from key events etc.
+ * @brief Called by editable UI controls when key events are received.
+ *
+ * @param[in] event The key event.
+ * @param[in] type Used to distinguish between regular key events and IMF events.
*/
- void TextInsertedEvent();
+ bool KeyEvent( const Dali::KeyEvent& event );
/**
- * @brief Used to process an event queued from backspace key etc.
+ * @brief Called by editable UI controls when a tap gesture occurs.
+ * @param[in] tapCount The number of taps.
+ * @param[in] x The x position relative to the top-left of the parent control.
+ * @param[in] y The y position relative to the top-left of the parent control.
*/
- void TextDeletedEvent();
+ void TapEvent( unsigned int tapCount, float x, float y );
/**
- * @brief Lays-out the text.
- *
- * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
+ * @brief Called by editable UI controls when a pan gesture occurs.
*
- * @param[in] size A the size of a bounding box to layout text within.
- * @param[in] operations The layout operations which need to be done.
- * @param[out] layoutSize The size of the laid-out text.
+ * @param[in] state The state of the gesture.
+ * @param[in] displacement This distance panned since the last pan gesture.
*/
- bool DoRelayout( const Size& size,
- OperationsMask operations,
- Size& layoutSize );
+ void PanEvent( Gesture::State state, const Vector2& displacement );
/**
- * @brief Whether to enable the multi-line layout.
+ * @brief Called by editable UI controls when a long press gesture occurs.
*
- * @param[in] enable \e true enables the multi-line (by default)
+ * @param[in] state The state of the gesture.
+ * @param[in] x The x position relative to the top-left of the parent control.
+ * @param[in] y The y position relative to the top-left of the parent control.
*/
- void SetMultiLineEnabled( bool enable );
+ void LongPressEvent( Gesture::State state, float x, float y );
/**
- * @return Whether the multi-line layout is enabled.
+ * @brief Event received from IMF manager
+ *
+ * @param[in] imfManager The IMF manager.
+ * @param[in] imfEvent The event received.
+ * @return A data struture indicating if update is needed, cursor position and current text.
*/
- bool IsMultiLineEnabled() const;
+ ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
/**
- * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
+ * @brief Event from Clipboard notifying an Item has been selected for pasting
*/
- void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
+ void PasteClipboardItemEvent();
+
+protected: // Inherit from Text::Decorator::ControllerInterface.
/**
- * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
+ * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
*/
- LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
+ virtual void GetTargetSize( Vector2& targetSize );
/**
- * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
+ * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
*/
- void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
+ virtual void AddDecoration( Actor& actor, bool needsClipping );
/**
- * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
+ * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
*/
- LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
+ virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
+
+protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
/**
- * @brief Calulates the vertical offset to align the text inside the bounding box.
- *
- * @param[in] size The size of the bounding box.
+ * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
*/
- void CalculateVerticalOffset( const Size& size );
+ virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
+
+private: // Update.
/**
- * @brief Return the layout engine.
+ * @brief Called by editable UI controls when key events are received.
*
- * @return A reference to the layout engine.
+ * @param[in] text The text to insert.
+ * @param[in] type Used to distinguish between regular key events and IMF events.
*/
- LayoutEngine& GetLayoutEngine();
+ void InsertText( const std::string& text, InsertType type );
/**
- * @brief Return a view of the text.
- *
- * @return A reference to the view.
+ * @brief Paste given string into Text model
+ * @param[in] stringToPaste this string will be inserted into the text model
*/
- View& GetView();
-
- // Text-input Event Queuing
+ void PasteText( const std::string& stringToPaste );
/**
- * @brief Called by editable UI controls when keyboard focus is gained.
+ * @brief Remove a given number of characters
+ *
+ * When predictve text is used the pre-edit text is removed and inserted again with the new characters.
+ * The UpdateInputStyleType @type parameter if set to DONT_UPDATE_INPUT_STYLE avoids to update the input
+ * style when pre-edit text is removed.
+ *
+ * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
+ * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset.
+ * @param[in] type Whether to update the input style.
+ * @return True if the remove was successful.
*/
- void KeyboardFocusGainEvent();
+ bool RemoveText( int cursorOffset,
+ int numberOfCharacters,
+ UpdateInputStyleType type );
/**
- * @brief Called by editable UI controls when focus is lost.
+ * @brief Checks if text is selected and if so removes it.
+ * @return true if text was removed
*/
- void KeyboardFocusLostEvent();
+ bool RemoveSelectedText();
+
+private: // Relayout.
/**
- * @brief Called by editable UI controls when key events are received.
+ * @brief Lays-out the text.
*
- * @param[in] event The key event.
- * @param[in] type Used to distinguish between regular key events and IMF events.
+ * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
+ *
+ * @param[in] size A the size of a bounding box to layout text within.
+ * @param[in] operations The layout operations which need to be done.
+ * @param[out] layoutSize The size of the laid-out text.
*/
- bool KeyEvent( const Dali::KeyEvent& event );
+ bool DoRelayout( const Size& size,
+ OperationsMask operations,
+ Size& layoutSize );
/**
- * @brief Called by editable UI controls when key events are received.
+ * @brief Calulates the vertical offset to align the text inside the bounding box.
*
- * @param[in] text The text to insert.
- * @param[in] type Used to distinguish between regular key events and IMF events.
+ * @param[in] size The size of the bounding box.
*/
- void InsertText( const std::string& text, InsertType type );
+ void CalculateVerticalOffset( const Size& size );
+
+private: // Events.
/**
- * @brief Checks if text is selected and if so removes it.
- * @return true if text was removed
+ * @brief Process queued events which modify the model.
*/
- bool RemoveSelectedText();
+ void ProcessModifyEvents();
/**
- * @brief Called by editable UI controls when a tap gesture occurs.
- * @param[in] tapCount The number of taps.
- * @param[in] x The x position relative to the top-left of the parent control.
- * @param[in] y The y position relative to the top-left of the parent control.
+ * @brief Used to process an event queued from SetText()
*/
- void TapEvent( unsigned int tapCount, float x, float y );
+ void TextReplacedEvent();
/**
- * @brief Called by editable UI controls when a pan gesture occurs.
- *
- * @param[in] state The state of the gesture.
- * @param[in] displacement This distance panned since the last pan gesture.
+ * @brief Used to process an event queued from key events etc.
*/
- void PanEvent( Gesture::State state, const Vector2& displacement );
+ void TextInsertedEvent();
/**
- * @brief Called by editable UI controls when a long press gesture occurs.
- *
- * @param[in] state The state of the gesture.
- * @param[in] x The x position relative to the top-left of the parent control.
- * @param[in] y The y position relative to the top-left of the parent control.
+ * @brief Used to process an event queued from backspace key etc.
*/
- void LongPressEvent( Gesture::State state, float x, float y );
+ void TextDeletedEvent();
/**
* @brief Creates a selection event.
void SelectEvent( float x, float y, bool selectAll );
/**
- * @brief Event received from IMF manager
+ * @brief Helper to KeyEvent() to handle the backspace case.
*
- * @param[in] imfManager The IMF manager.
- * @param[in] imfEvent The event received.
- * @return A data struture indicating if update is needed, cursor position and current text.
- */
- ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
-
- /**
- * @brief Paste given string into Text model
- * @param[in] stringToPaste this string will be inserted into the text model
- */
- void PasteText( const std::string& stringToPaste );
-
- /**
- * @brief Event from Clipboard notifying an Item has been selected for pasting
+ * @return True if a character was deleted.
*/
- void PasteClipboardItemEvent();
+ bool BackspaceKeyEvent();
- /**
- * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
- */
- virtual void GetTargetSize( Vector2& targetSize );
+private: // Helpers.
/**
- * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
+ * @brief Used to remove the text included the placeholder text.
*/
- virtual void AddDecoration( Actor& actor, bool needsClipping );
+ void ResetText();
/**
- * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
+ * @brief Helper to show the place holder text..
*/
- virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
+ void ShowPlaceholderText();
/**
- * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
+ * @brief Helper to clear font-specific data (only).
*/
- virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
-
-protected:
+ void ClearFontData();
/**
- * @brief A reference counted object may only be deleted by calling Unreference().
+ * @brief Helper to clear text's style data.
*/
- virtual ~Controller();
-
-private:
+ void ClearStyleData();
/**
- * @brief Helper to KeyEvent() to handle the backspace case.
+ * @brief Used to reset the cursor position after setting a new text.
*
- * @return True if a character was deleted.
+ * @param[in] cursorIndex Where to place the cursor.
*/
- bool BackspaceKeyEvent();
+ void ResetCursorPosition( CharacterIndex cursorIndex );
/**
- * @brief Helper to clear font-specific data.
+ * @brief Used to reset the scroll position after setting a new text.
*/
- void ShowPlaceholderText();
+ void ResetScrollPosition();
+
+private: // Private contructors & copy operator.
/**
- * @brief Helper to clear font-specific data (only).
+ * @brief Private constructor.
*/
- void ClearFontData();
+ Controller();
/**
- * @brief Helper to clear text's style data.
+ * @brief Private constructor.
*/
- void ClearStyleData();
+ Controller( ControlInterface* controlInterface );
/**
* @brief Private constructor.
*/
- Controller( ControlInterface& controlInterface );
+ Controller( ControlInterface* controlInterface,
+ EditableControlInterface* editableControlInterface );
// Undefined
Controller( const Controller& handle );
// Undefined
Controller& operator=( const Controller& handle );
+protected: // Destructor.
+
+ /**
+ * @brief A reference counted object may only be deleted by calling Unreference().
+ */
+ virtual ~Controller();
+
private:
struct Impl;
} // namespace Dali
-#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__
+#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff