X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-controller.h;h=33f1f8f452a953df33994eea07d503501fda1930;hp=3d7639d927f1dd396f76f0c18d082f9807e89ebb;hb=7c4829108a1196e07f0eb93207ea234e3741642b;hpb=6a76d24e484c3eb9e23cab8cf29452f66a58d052 diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h old mode 100644 new mode 100755 index 3d7639d..33f1f8f --- a/dali-toolkit/internal/text/text-controller.h +++ b/dali-toolkit/internal/text/text-controller.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_TEXT_CONTROLLER_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 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. @@ -19,11 +19,14 @@ */ // EXTERNAL INCLUDES -#include +#include #include // INTERNAL INCLUDES +#include #include +#include +#include #include #include #include @@ -85,7 +88,7 @@ public: // Enumerated types. }; /** - * @brief Used to distinguish between regular key events and IMF events + * @brief Used to distinguish between regular key events and InputMethodContext events */ enum InsertType { @@ -176,8 +179,9 @@ public: // Configure the text controller. * * @note Selectable or editable controls should call this once after Controller::New(). * @param[in] decorator Used to create cursor, selection handle decorations etc. + * @param[in] inputMethodContext Used to manager ime. */ - void EnableTextInput( DecoratorPtr decorator ); + void EnableTextInput( DecoratorPtr decorator, InputMethodContext& inputMethodContext ); /** * @brief Used to switch between bitmap & vector based glyphs @@ -323,24 +327,36 @@ public: // Configure the text controller. * * @param[in] alignment The horizontal alignment. */ - void SetHorizontalAlignment( Layout::HorizontalAlignment alignment ); + void SetHorizontalAlignment( HorizontalAlignment::Type alignment ); /** * @copydoc ModelInterface::GetHorizontalAlignment() */ - Layout::HorizontalAlignment GetHorizontalAlignment() const; + HorizontalAlignment::Type GetHorizontalAlignment() const; /** * @brief Sets the text's vertical alignment. * * @param[in] alignment The vertical alignment. */ - void SetVerticalAlignment( Layout::VerticalAlignment alignment ); + void SetVerticalAlignment( VerticalAlignment::Type alignment ); /** * @copydoc ModelInterface::GetVerticalAlignment() */ - Layout::VerticalAlignment GetVerticalAlignment() const; + VerticalAlignment::Type GetVerticalAlignment() const; + + /** + * @brief Sets the text's wrap mode + * @param[in] text wrap mode The unit of wrapping + */ + void SetLineWrapMode( Text::LineWrap::Mode textWarpMode ); + + /** + * @brief Retrieve text wrap mode previously set. + * @return text wrap mode + */ + Text::LineWrap::Mode GetLineWrapMode() const; /** * @brief Enable or disable the text elide. @@ -355,6 +371,18 @@ public: // Configure the text controller. bool IsTextElideEnabled() const; /** + * @brief Enable or disable the placeholder text elide. + * @param enabled Whether to enable the placeholder text elide. + */ + void SetPlaceholderTextElideEnabled( bool enabled ); + + /** + * @brief Whether the placeholder text elide property is enabled. + * @return True if the placeholder text elide property is enabled, false otherwise. + */ + bool IsPlaceholderTextElideEnabled() const; + + /** * @brief Enable or disable the text selection. * @param[in] enabled Whether to enable the text selection. */ @@ -367,6 +395,32 @@ public: // Configure the text controller. bool IsSelectionEnabled() const; /** + * @brief Enable or disable the text selection using Shift key. + * @param enabled Whether to enable the text selection using Shift key + */ + void SetShiftSelectionEnabled( bool enabled ); + + /** + * @brief Whether the text selection using Shift key is enabled or not. + * @return True if the text selection using Shift key is enabled + */ + bool IsShiftSelectionEnabled() const; + + /** + * @brief Enable or disable the grab handles for text selection. + * + * @param[in] enabled Whether to enable the grab handles + */ + void SetGrabHandleEnabled( bool enabled ); + + /** + * @brief Returns whether the grab handles are enabled. + * + * @return True if the grab handles are enabled + */ + bool IsGrabHandleEnabled() const; + + /** * @brief Sets input type to password * * @note The string is displayed hidden character @@ -435,6 +489,18 @@ public: // Configure the text controller. void ShadowSetByString( bool setByString ); /** + * @brief Query if outline settings were provided by string or map + * @return bool true if set by string + */ + bool IsOutlineSetByString(); + + /** + * Set method outline setting were set by + * @param[in] bool, true if set by string + */ + void OutlineSetByString( bool setByString ); + + /** * @brief Query if font style settings were provided by string or map * @return bool true if set by string */ @@ -721,6 +787,20 @@ public: // Default style & Input style const Vector4& GetShadowColor() const; /** + * @brief Set the shadow blur radius. + * + * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur. + */ + void SetShadowBlurRadius( const float& shadowBlurRadius ); + + /** + * @brief Retrieve the shadow blur radius. + * + * @return The shadow blur radius. + */ + const float& GetShadowBlurRadius() const; + + /** * @brief Set the underline color. * * @param[in] color color of underline. @@ -763,6 +843,62 @@ public: // Default style & Input style float GetUnderlineHeight() const; /** + * @brief Set the outline color. + * + * @param[in] color color of outline. + */ + void SetOutlineColor( const Vector4& color ); + + /** + * @brief Retrieve the outline color. + * + * @return The outline color. + */ + const Vector4& GetOutlineColor() const; + + /** + * @brief Set the outline width + * + * @param[in] width The width in pixels of the outline, 0 indicates no outline + */ + void SetOutlineWidth( unsigned int width ); + + /** + * @brief Retrieves the width of an outline + * + * @return The width of the outline. + */ + unsigned int GetOutlineWidth() const; + + /** + * @brief Set the background color. + * + * @param[in] color color of background. + */ + void SetBackgroundColor( const Vector4& color ); + + /** + * @brief Retrieve the background color. + * + * @return The background color. + */ + const Vector4& GetBackgroundColor() const; + + /** + * @brief Set the background enabled flag. + * + * @param[in] enabled The background enabled flag. + */ + void SetBackgroundEnabled( bool enabled ); + + /** + * @brief Returns whether to enable text background or not. + * + * @return Whether text background is enabled. + */ + bool IsBackgroundEnabled() const; + + /** * @brief Sets the emboss's properties string. * * @note The string is stored to be recovered. @@ -798,8 +934,10 @@ public: // Default style & Input style * @brief Sets the default line spacing. * * @param[in] lineSpacing The line spacing. + * + * @return True if lineSpacing has been updated, false otherwise */ - void SetDefaultLineSpacing( float lineSpacing ); + bool SetDefaultLineSpacing( float lineSpacing ); /** * @brief Retrieves the default line spacing. @@ -985,6 +1123,13 @@ public: // Default style & Input style */ const std::string& GetInputOutlineProperties() const; + /** + * @brief Set the control's interface. + * + * @param[in] controlInterface The control's interface. + */ + void SetControlInterface( ControlInterface* controlInterface ); + public: // Queries & retrieves. /** @@ -1068,6 +1213,55 @@ public: // Queries & retrieves. */ void GetPlaceholderProperty( Property::Map& map ); + /** + * @brief Checks text direction. + * @return The text direction. + */ + Toolkit::DevelText::TextDirection::Type GetTextDirection(); + + /** + * @brief Retrieves vertical line alignment + * @return The vertical line alignment + */ + Toolkit::DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const; + + /** + * @brief Sets vertical line alignment + * @param[in] alignment The vertical line alignment for the text + */ + void SetVerticalLineAlignment( Toolkit::DevelText::VerticalLineAlignment::Type alignment ); + + /** + * @brief Retrieves ignoreSpaceAfterText value from model + * @return The value of ignoreSpaceAfterText + */ + bool IsIgnoreSpacesAfterText() const; + + /** + * @brief Sets ignoreSpaceAfterText value to model + * @param[in] ignore The value of ignoreSpacesAfterText for the text + */ + void SetIgnoreSpacesAfterText( bool ignore ); + + /** + * @brief Retrieves matchSystemLanguageDirection value from model + * @return The value of matchSystemLanguageDirection + */ + bool IsMatchSystemLanguageDirection() const; + + /** + * @brief Sets matchSystemLanguageDirection value to model + * @param[in] match The value of matchSystemLanguageDirection for the text + */ + void SetMatchSystemLanguageDirection( bool match ); + + /** + * @brief Sets layoutDirection value + * @param[in] layoutDirection The value of system language direction + */ + void SetLayoutDirection( Dali::LayoutDirection::Type layoutDirection ); + + public: // Relayout. /** @@ -1075,10 +1269,11 @@ public: // Relayout. * * @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. + * @param[in] layoutDirection The direction of the system language. * * @return Whether the text model or decorations were updated. */ - UpdateTextType Relayout( const Size& size ); + UpdateTextType Relayout( const Size& size, Dali::LayoutDirection::Type layoutDirection = Dali::LayoutDirection::LEFT_TO_RIGHT ); /** * @brief Request a relayout using the ControlInterface. @@ -1116,7 +1311,7 @@ public: // Text-input Event Queuing. * @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. + * @param[in] type Used to distinguish between regular key events and InputMethodContext events. */ bool KeyEvent( const Dali::KeyEvent& event ); @@ -1146,19 +1341,26 @@ public: // Text-input Event Queuing. void LongPressEvent( Gesture::State state, float x, float y ); /** - * @brief Event received from IMF manager + * @brief Event received from input method context * - * @param[in] imfManager The IMF manager. - * @param[in] imfEvent The event received. + * @param[in] inputMethodContext The input method context. + * @param[in] inputMethodContextEvent 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 ); + InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent ); /** * @brief Event from Clipboard notifying an Item has been selected for pasting */ void PasteClipboardItemEvent(); + /** + * @brief Return true when text control should clear key input focus when escape key is pressed. + * + * @return Whether text control should clear key input focus or not when escape key is pressed. + */ + bool ShouldClearFocusOnEscape() const; + protected: // Inherit from Text::Decorator::ControllerInterface. /** @@ -1196,7 +1398,7 @@ private: // Update. * @brief Called by editable UI controls when key events are received. * * @param[in] text The text to insert. - * @param[in] type Used to distinguish between regular key events and IMF events. + * @param[in] type Used to distinguish between regular key events and InputMethodContext events. */ void InsertText( const std::string& text, InsertType type ); @@ -1284,11 +1486,12 @@ private: // Events. void SelectEvent( float x, float y, bool selectAll ); /** - * @brief Helper to KeyEvent() to handle the backspace case. + * @brief Helper to KeyEvent() to handle the backspace or delete key case. * + * @param[in] keyCode The keycode for the key pressed * @return True if a character was deleted. */ - bool BackspaceKeyEvent(); + bool DeleteEvent( int keyCode ); private: // Helpers. @@ -1355,9 +1558,12 @@ protected: // Destructor. */ virtual ~Controller(); +public: + + struct Impl; ///< Made public for testing purposes + private: - struct Impl; Impl* mImpl; };