#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.
*/
// EXTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/imf-manager.h>
+#include <dali/devel-api/adaptor-framework/input-method-context.h>
#include <dali/public-api/events/gesture.h>
// INTERNAL INCLUDES
#include <dali-toolkit/public-api/text/text-enumerations.h>
#include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
+#include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
+#include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
#include <dali-toolkit/internal/text/decorator/text-decorator.h>
#include <dali-toolkit/internal/text/layouts/layout-engine.h>
-#include <dali-toolkit/internal/text/layouts/layout-wrap-mode.h>
#include <dali-toolkit/internal/text/hidden-text.h>
#include <dali-toolkit/internal/text/text-model-interface.h>
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
{
};
};
+ 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.
/**
*
* @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
* @brief Sets the text's wrap mode
* @param[in] text wrap mode The unit of wrapping
*/
- void SetLineWrapMode( Layout::LineWrap::Mode textWarpMode );
+ void SetLineWrapMode( Text::LineWrap::Mode textWarpMode );
/**
* @brief Retrieve text wrap mode previously set.
* @return text wrap mode
*/
- Layout::LineWrap::Mode GetLineWrapMode() const;
+ Text::LineWrap::Mode GetLineWrapMode() const;
/**
* @brief Enable or disable the text elide.
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.
*/
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 hidden character
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.
*
* @param[in] width The width in pixels of the outline, 0 indicates no outline
*/
- void SetOutlineWidth( float width );
+ void SetOutlineWidth( uint16_t width );
/**
* @brief Retrieves the width of an outline
*
* @return The width of the outline.
*/
- float GetOutlineWidth() const;
+ 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.
* @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.
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.
*/
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.
/**
*
* @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.
* @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 );
void LongPressEvent( Gesture::State state, float x, float y );
/**
- * @brief Event received from IMF manager
+ * @brief Creates a selection event.
*
- * @param[in] imfManager The IMF manager.
- * @param[in] imfEvent The event received.
+ * 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] 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
*/
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.
/**
* @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 );
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.
*/
virtual ~Controller();
+public:
+
+ struct Impl; ///< Made public for testing purposes
+
private:
- struct Impl;
Impl* mImpl;
};
projects / platform / core / uifw / dali-toolkit.git / blobdiff