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=e3a7427a092ade6ce4e77d19f1b02914b91beed9;hp=4bb6f7c3451ee3ec3b2e047b4775cca578cbb33b;hb=41d36118a13932bcf1db39b780ac437fcda8aa08;hpb=3c2a5c792a154d11bd97cf587ae142b277ad45c0 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 4bb6f7c..82a7a15 --- 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) 2016 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,13 +19,17 @@ */ // EXTERNAL INCLUDES -#include +#include #include // INTERNAL INCLUDES +#include #include +#include +#include #include #include +#include #include namespace Dali @@ -56,7 +60,7 @@ typedef IntrusivePtr ControllerPtr; * * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface. */ -class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface +class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer { public: // Enumerated types. @@ -70,21 +74,20 @@ public: // Enumerated types. GET_SCRIPTS = 0x0002, VALIDATE_FONTS = 0x0004, GET_LINE_BREAKS = 0x0008, - GET_WORD_BREAKS = 0x0010, - BIDI_INFO = 0x0020, - SHAPE_TEXT = 0x0040, - GET_GLYPH_METRICS = 0x0080, - LAYOUT = 0x0100, - UPDATE_LAYOUT_SIZE = 0x0200, - REORDER = 0x0400, - ALIGN = 0x0800, - COLOR = 0x1000, - UPDATE_DIRECTION = 0x2000, + BIDI_INFO = 0x0010, + SHAPE_TEXT = 0x0020, + GET_GLYPH_METRICS = 0x0040, + LAYOUT = 0x0080, + UPDATE_LAYOUT_SIZE = 0x0100, + REORDER = 0x0200, + ALIGN = 0x0400, + COLOR = 0x0800, + UPDATE_DIRECTION = 0x1000, ALL_OPERATIONS = 0xFFFF }; /** - * @brief Used to distinguish between regular key events and IMF events + * @brief Used to distinguish between regular key events and InputMethodContext events */ enum InsertType { @@ -120,6 +123,37 @@ public: // Enumerated types. PLACEHOLDER_TYPE_INACTIVE, }; + /** + * @brief Enumeration for Font Size Type. + */ + enum FontSizeType + { + POINT_SIZE, // The size of font in points. + PIXEL_SIZE // The size of font in pixels. + }; + + struct NoTextTap + { + enum Action + { + NO_ACTION, ///< Does no action if there is a tap on top of an area with no text. + HIGHLIGHT, ///< Highlights the nearest text (at the beginning or end of the text) and shows the text's selection popup. + SHOW_SELECTION_POPUP ///< Shows the text's selection popup. + }; + }; + + struct TextFitInfo + { + enum Property + { + TEXT_FIT_ENABLE, + TEXT_FIT_MIN_SIZE, + TEXT_FIT_MAX_SIZE, + TEXT_FIT_STEP_SIZE, + TEXT_FIT_FONT_SIZE_TYPE + }; + }; + public: // Constructor. /** @@ -156,8 +190,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 @@ -303,24 +338,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. @@ -335,9 +382,146 @@ public: // Configure the text controller. bool IsTextElideEnabled() const; /** + * @brief Enable or disable the text fit. + * + * @param[in] enabled Whether to enable the text fit. + */ + void SetTextFitEnabled(bool enabled); + + /** + * @brief Whether the text fit is enabled or not. + * + * @return True if the text fit is enabled + */ + bool IsTextFitEnabled() const; + + /** + * @brief Sets minimum size valid for text fit. + * + * @param[in] minimum size value. + * @param[in] type The font size type is point size or pixel size + */ + void SetTextFitMinSize( float pointSize, FontSizeType type ); + + /** + * @brief Retrieves the minimum point size valid for text fit. + * + * @return The minimum point size valid for text fit + */ + float GetTextFitMinSize() const; + + /** + * @brief Sets maximum size valid for text fit. + * + * @param[in] maximum size value. + * @param[in] type The font size type is point size or pixel size + */ + void SetTextFitMaxSize( float pointSize, FontSizeType type ); + + /** + * @brief Retrieves the maximum point size valid for text fit. + * + * @return The maximum point size valid for text fit + */ + float GetTextFitMaxSize() const; + + /** + * @brief Sets step size for font increase valid for text fit. + * + * @param[in] step size value. + * @param[in] type The font size type is point size or pixel size + */ + void SetTextFitStepSize( float step, FontSizeType type ); + + /** + * @brief Retrieves the step point size valid for text fit. + * + * @return The step point size valid for text fit + */ + float GetTextFitStepSize() const; + + /** + * @brief Sets content size valid for text fit. + * + * @param[in] Content size value. + */ + void SetTextFitContentSize(Vector2 size); + + /** + * @brief Retrieves the content size valid for text fit. + * + * @return The content size valid for text fit + */ + Vector2 GetTextFitContentSize() 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 Enable or disable the grab handles for text selection. + * + * @param[in] enabled Whether to enable the grab handles + */ + void SetGrabHandlePopupEnabled( bool enabled ); + + /** + * @brief Returns whether the grab handles are enabled. + * + * @return True if the grab handles are enabled + */ + bool IsGrabHandlePopupEnabled() const; + + /** * @brief Sets input type to password * - * @note The string is displayed continuous "*" + * @note The string is displayed hidden character * * @param[in] passwordInput True if password input is enabled. */ @@ -350,6 +534,82 @@ public: // Configure the text controller. */ bool IsInputModePassword(); + /** + * @brief Sets the action when there is a double tap event on top of a text area with no text. + * + * @param[in] action The action to do. + */ + void SetNoTextDoubleTapAction( NoTextTap::Action action ); + + /** + * @brief Retrieves the action when there is a double tap event on top of a text area with no text. + * + * @return The action to do. + */ + NoTextTap::Action GetNoTextDoubleTapAction() const; + + /** + * @briefSets the action when there is a long press event on top of a text area with no text. + * + * @param[in] action The action to do. + */ + void SetNoTextLongPressAction( NoTextTap::Action action ); + + /** + * @brief Retrieves the action when there is a long press event on top of a text area with no text. + * + * @return The action to do. + */ + NoTextTap::Action GetNoTextLongPressAction() const; + + /** + * @brief Query if Underline settings were provided by string or map + * @return bool true if set by string + */ + bool IsUnderlineSetByString(); + + /** + * Set method underline setting were set by + * @param[in] bool, true if set by string + */ + void UnderlineSetByString( bool setByString ); + + /** + * @brief Query if shadow settings were provided by string or map + * @return bool true if set by string + */ + bool IsShadowSetByString(); + + /** + * Set method shadow setting were set by + * @param[in] bool, true if set by string + */ + 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. /** @@ -406,6 +666,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. @@ -425,6 +698,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. @@ -444,6 +738,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. @@ -463,18 +778,55 @@ public: // Default style & Input style FontSlant GetDefaultFontSlant() const; /** - * @brief Set the default point size. + * @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] pointSize The default point size. + * @param[in] fontSize The default font size + * @param[in] type The font size type is point size or pixel size */ - void SetDefaultPointSize( float pointSize ); + void SetDefaultFontSize( float fontSize, FontSizeType type ); /** * @brief Retrieve the default point size. * + * @param[in] type The font size type * @return The default point size. */ - float GetDefaultPointSize() const; + 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. @@ -533,6 +885,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. @@ -575,6 +941,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( uint16_t width ); + + /** + * @brief Retrieves the width of an outline + * + * @return The width of the outline. + */ + uint16_t 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. @@ -610,8 +1032,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. @@ -797,6 +1221,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. /** @@ -824,6 +1255,25 @@ public: // Queries & retrieves. float GetHeightForWidth( float width ); /** + * @brief Calculates the point size for text for given layout() + */ + void FitPointSizeforLayout( Size layoutSize ); + + /** + * @brief Checks if the point size fits within the layout size. + * + * @return Whether the point size fits within the layout size. + */ + bool CheckForTextFit( float pointSize, Size& layoutSize ); + + /** + * @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. @@ -837,6 +1287,96 @@ public: // Queries & retrieves. */ float GetScrollAmountByUserInput(); + /** + * @brief Get latest scroll amount, control size and layout size + * + * This method is used to get information of control's scroll + * @param[out] scrollPosition The current scrolled position + * @param[out] controlHeight The size of a UI control + * @param[out] layoutHeight The size of a bounding box to layout text within. + * + * @return Whether the text scroll position is changed or not after last update. + */ + bool GetTextScrollInfo( float& scrollPosition, float& controlHeight, float& layoutHeight ); + + /** + * @brief Used to set the hidden input option + */ + void SetHiddenInputOption( const Property::Map& options ); + + /** + * @brief Used to get the hidden input option + */ + 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 ); + + /** + * @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 ); + + /** + * @brief Retrieves if showing real text or not. + * @return The value of showing real text. + */ + bool IsShowingRealText() const; + public: // Relayout. /** @@ -844,10 +1384,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. @@ -885,7 +1426,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 ); @@ -915,19 +1456,44 @@ public: // Text-input Event Queuing. void LongPressEvent( Gesture::State state, float x, float y ); /** - * @brief Event received from IMF manager + * @brief Creates a selection event. + * + * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed. + * + * @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. + * @param[in] selectAll Whether the whole text is selected. + */ + void SelectEvent( float x, float y, bool selectAll ); + + /** + * @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; + + /** + * @brief Create an actor that renders the text background color + * + * @return the created actor or an empty handle if no background color needs to be rendered. + */ + Actor CreateBackgroundActor(); + protected: // Inherit from Text::Decorator::ControllerInterface. /** @@ -952,13 +1518,20 @@ protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface. */ virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button ); +protected: // Inherit from HiddenText. + + /** + * @brief Invoked from HiddenText when showing time of the last character was expired + */ + virtual void DisplayTimeExpired(); + 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 ); @@ -1035,22 +1608,12 @@ private: // Events. void TextDeletedEvent(); /** - * @brief Creates a selection event. - * - * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed. - * - * @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. - * @param[in] selectAll Whether the whole text is selected. - */ - 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. @@ -1117,9 +1680,12 @@ protected: // Destructor. */ virtual ~Controller(); +public: + + struct Impl; ///< Made public for testing purposes + private: - struct Impl; Impl* mImpl; };