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=25bb13b3698b5aead7f8e09bb1fd64057d30cd66;hp=b9cbb2c95fc4845cd3b79c9dae9e9416f091a77e;hb=9346cf33ef49063185d54fbbfc186864d96c51ca;hpb=0e07671d24b10bd49423ec6ce22817000bb18336 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 b9cbb2c..25bb13b --- 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,56 @@ 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. + */ + void SetSelectionEnabled( bool enabled ); + + /** + * @brief Whether the text selection is enabled or not. + * @return True if the text selection is enabled + */ + 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 @@ -422,6 +488,30 @@ 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 + */ + bool IsFontStyleSetByString(); + + /** + * Set method font style setting were set by + * @param[in] bool, true if set by string + */ + void FontStyleSetByString( bool setByString ); + public: // Update. /** @@ -478,6 +568,19 @@ public: // Default style & Input style const std::string& GetDefaultFontFamily() const; /** + * @brief Sets the placeholder text font family. + * @param[in] placeholderTextFontFamily The placeholder text font family. + */ + void SetPlaceholderFontFamily( const std::string& placeholderTextFontFamily ); + + /** + * @brief Retrieves the placeholder text font family. + * + * @return The placeholder text font family + */ + const std::string& GetPlaceholderFontFamily() const; + + /** * @brief Sets the default font weight. * * @param[in] weight The font weight. @@ -497,6 +600,27 @@ public: // Default style & Input style FontWeight GetDefaultFontWeight() const; /** + * @brief Sets the placeholder text font weight. + * + * @param[in] weight The font weight + */ + void SetPlaceholderTextFontWeight( FontWeight weight ); + + /** + * @brief Whether the font's weight has been defined. + * + * @return True if the placeholder text font weight is defined + */ + bool IsPlaceholderTextFontWeightDefined() const; + + /** + * @brief Retrieves the placeholder text font weight. + * + * @return The placeholder text font weight + */ + FontWeight GetPlaceholderTextFontWeight() const; + + /** * @brief Sets the default font width. * * @param[in] width The font width. @@ -516,6 +640,27 @@ public: // Default style & Input style FontWidth GetDefaultFontWidth() const; /** + * @brief Sets the placeholder text font width. + * + * @param[in] width The font width + */ + void SetPlaceholderTextFontWidth( FontWidth width ); + + /** + * @brief Whether the font's width has been defined. + * + * @return True if the placeholder text font width is defined + */ + bool IsPlaceholderTextFontWidthDefined() const; + + /** + * @brief Retrieves the placeholder text font width. + * + * @return The placeholder text font width + */ + FontWidth GetPlaceholderTextFontWidth() const; + + /** * @brief Sets the default font slant. * * @param[in] slant The font slant. @@ -535,9 +680,30 @@ public: // Default style & Input style FontSlant GetDefaultFontSlant() const; /** + * @brief Sets the placeholder text font slant. + * + * @param[in] slant The font slant + */ + void SetPlaceholderTextFontSlant( FontSlant slant ); + + /** + * @brief Whether the font's slant has been defined. + * + * @return True if the placeholder text font slant is defined + */ + bool IsPlaceholderTextFontSlantDefined() const; + + /** + * @brief Retrieves the placeholder text font slant. + * + * @return The placeholder text font slant + */ + FontSlant GetPlaceholderTextFontSlant() const; + + /** * @brief Set the default font size. * - * @param[in] size The default font size. + * @param[in] fontSize The default font size * @param[in] type The font size type is point size or pixel size */ void SetDefaultFontSize( float fontSize, FontSizeType type ); @@ -551,6 +717,20 @@ public: // Default style & Input style float GetDefaultFontSize( FontSizeType type ) const; /** + * @brief Sets the Placeholder text font size. + * @param[in] fontSize The placeholder text font size + * @param[in] type The font size type is point size or pixel size + */ + void SetPlaceholderTextFontSize( float fontSize, FontSizeType type ); + + /** + * @brief Retrieves the Placeholder text font size. + * @param[in] type The font size type + * @return The placeholder font size + */ + float GetPlaceholderTextFontSize( FontSizeType type ) const; + + /** * @brief Sets the text's default color. * * @param color The default color. @@ -607,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. @@ -649,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. @@ -684,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. @@ -871,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. /** @@ -898,6 +1157,13 @@ public: // Queries & retrieves. float GetHeightForWidth( float width ); /** + * @brief Retrieves the text's number of lines for a given width. + * @param[in] width The width of the text's area. + * @ return The number of lines. + */ + int GetLineCount( float width ); + + /** * @brief Retrieves the text's model. * * @return A pointer to the text's model. @@ -933,6 +1199,50 @@ public: // Queries & retrieves. */ void GetHiddenInputOption( Property::Map& options ); + /** + * @brief Sets the Placeholder Properties. + * + * @param[in] map The placeholder property map + */ + void SetPlaceholderProperty( const Property::Map& map ); + + /** + * @brief Retrieves the Placeholder Property map. + * + * @param[out] map The property map + */ + 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 ); + public: // Relayout. /** @@ -981,7 +1291,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 ); @@ -1011,19 +1321,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. /** @@ -1061,7 +1378,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 ); @@ -1149,11 +1466,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. @@ -1220,9 +1538,12 @@ protected: // Destructor. */ virtual ~Controller(); +public: + + struct Impl; ///< Made public for testing purposes + private: - struct Impl; Impl* mImpl; };