#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
};
/**
- * @brief Used to distinguish between regular key events and IMF events
+ * @brief Used to distinguish between regular key events and InputMethodContext events
*/
enum InsertType
{
*
* @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
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
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.
* @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.
*/
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.
/**
*
* @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 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
* @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 );
*/
virtual ~Controller();
+public:
+
+ struct Impl; ///< Made public for testing purposes
+
private:
- struct Impl;
Impl* mImpl;
};