automated-tests/src/dali-toolkit/dali-toolkit-test-utils/toolkit-input-method-context.h

   1 #ifndef DALI_TOOLKIT_TOOLKIT_INPUT_METHOD_CONTEXT_H
   2 #define DALI_TOOLKIT_TOOLKIT_INPUT_METHOD_CONTEXT_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #define DALI_INPUT_METHOD_CONTEXT_H
  23 #include <dali/public-api/actors/actor.h>
  24 #include <dali/public-api/object/base-handle.h>
  25 #include <dali/public-api/signals/dali-signal.h>
  26 #include <dali/devel-api/adaptor-framework/input-method-options.h>
  27 #include <dali/public-api/events/key-event.h>
  28
  29 namespace Dali DALI_IMPORT_API
  30 {
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 namespace Adaptor
  35 {
  36 class InputMethodContext;
  37 }
  38 }
  39
  40 /**
  41  * @brief The InputMethodContext class
  42  *
  43  * Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
  44  */
  45 class InputMethodContext : public BaseHandle
  46 {
  47 public:
  48
  49   /**
  50   * @brief The direction of text.
  51   */
  52   enum TextDirection
  53   {
  54     LeftToRight,
  55     RightToLeft,
  56   };
  57
  58   /**
  59    * @brief Events that are generated by the InputMethodContext.
  60    */
  61   enum EventType
  62   {
  63     VOID,                ///< No event
  64     PRE_EDIT,             ///< Pre-Edit changed
  65     COMMIT,              ///< Commit recieved
  66     DELETE_SURROUNDING,   ///< Event to delete a range of characters from the string
  67     GET_SURROUNDING,      ///< Event to query string and cursor position
  68     PRIVATE_COMMAND       ///< Private command sent from the input panel
  69   };
  70
  71   /**
  72    * @brief Enumeration for state of the input panel.
  73    */
  74   enum State
  75   {
  76     DEFAULT = 0,   ///< Unknown state
  77     SHOW,          ///< Input panel is shown
  78     HIDE,          ///< Input panel is hidden
  79     WILL_SHOW      ///< Input panel in process of being shown
  80   };
  81
  82   /**
  83    * @brief Enumeration for the type of Keyboard.
  84    */
  85   enum KeyboardType
  86   {
  87     SOFTWARE_KEYBOARD,  ///< Software keyboard (Virtual keyboard) is default
  88     HARDWARE_KEYBOARD   ///< Hardware keyboard
  89   };
  90
  91   /**
  92    * @brief Enumeration for the language mode of the input panel.
  93    */
  94   enum class InputPanelLanguage
  95   {
  96     AUTOMATIC,    ///< IME Language automatically set depending on the system display
  97     ALPHABET      ///< Latin alphabet at all times
  98   };
  99
 100   /**
 101    * @brief Enumeration for the preedit style types.
 102    */
 103   enum class PreeditStyle
 104   {
 105     NONE,                    ///< None style
 106     UNDERLINE,               ///< Underline substring style
 107     REVERSE,                 ///< Reverse substring style
 108     HIGHLIGHT,               ///< Highlight substring style
 109     CUSTOM_PLATFORM_STYLE_1, ///< Custom style for platform
 110     CUSTOM_PLATFORM_STYLE_2, ///< Custom style for platform
 111     CUSTOM_PLATFORM_STYLE_3, ///< Custom style for platform
 112     CUSTOM_PLATFORM_STYLE_4  ///< Custom style for platform
 113   };
 114
 115   /**
 116    * @brief This structure is for the preedit style types and indices.
 117    */
 118   struct PreeditAttributeData
 119   {
 120     PreeditStyle preeditType; /// The preedit style type
 121     unsigned int startIndex;  /// The start index of preedit
 122     unsigned int endIndex;    /// The end index of preedit
 123   };
 124
 125   /**
 126    * @brief This structure is used to pass on data from the InputMethodContext regarding predictive text.
 127    */
 128   struct EventData
 129   {
 130     /**
 131      * @brief Default Constructor.
 132      */
 133     EventData()
 134     : predictiveString(),
 135       eventName( VOID ),
 136       cursorOffset( 0 ),
 137       numberOfChars ( 0 )
 138     {
 139     };
 140
 141     /**
 142      * @brief Constructor
 143      *
 144      * @param[in] aEventName The name of the event from the input method context.
 145      * @param[in] aPredictiveString The pre-edit or commit string.
 146      * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
 147      * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
 148      */
 149     EventData( EventType aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
 150     : predictiveString( aPredictiveString ),
 151       eventName( aEventName ),
 152       cursorOffset( aCursorOffset ),
 153       numberOfChars( aNumberOfChars )
 154     {
 155     }
 156
 157     // Data
 158     std::string predictiveString; ///< The pre-edit or commit string.
 159     EventType eventName;           ///< The name of the event from the input method context.
 160     int cursorOffset;             ///< Start position from the current cursor position to start deleting characters.
 161     int numberOfChars;            ///< number of characters to delete from the cursorOffset.
 162   };
 163
 164   /**
 165    * @brief Data required by input method context from the callback
 166    */
 167   struct CallbackData
 168   {
 169     /**
 170      * @brief Constructor
 171      */
 172     CallbackData()
 173     : currentText(),
 174       cursorPosition( 0 ),
 175       update( false ),
 176       preeditResetRequired( false )
 177     {
 178     }
 179
 180     /**
 181      * @brief Constructor
 182      * @param[in] aUpdate True if cursor position needs to be updated
 183      * @param[in] aCursorPosition new position of cursor
 184      * @param[in] aCurrentText current text string
 185      * @param[in] aPreeditResetRequired flag if preedit reset is required.
 186      */
 187     CallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
 188     : currentText( aCurrentText ),
 189       cursorPosition( aCursorPosition ),
 190       update( aUpdate ),
 191       preeditResetRequired( aPreeditResetRequired )
 192     {
 193     }
 194
 195     std::string currentText;      ///< current text string
 196     int cursorPosition;           ///< new position of cursor
 197     bool update               :1; ///< if cursor position needs to be updated
 198     bool preeditResetRequired :1; ///< flag if preedit reset is required.
 199   };
 200
 201   typedef Signal< void (InputMethodContext&) > ActivatedSignalType; ///< Keyboard actived signal
 202   typedef Signal< CallbackData ( InputMethodContext&, const EventData& ) > KeyboardEventSignalType; ///< keyboard events
 203   typedef Signal< void () > VoidSignalType;
 204   typedef Signal< void (bool) > StatusSignalType;
 205
 206 public:
 207
 208   /**
 209    * @brief Create a handle to the instance of InputMethodContext.
 210    * @return A handle to the InputMethodContext.
 211    */
 212   static InputMethodContext New();
 213
 214   /**
 215    * @brief Create a handle to the instance of InputMethodContext.
 216    *
 217    * @param[in] actor The actor that uses the new InputMethodContext instance.
 218    * @return A handle to the InputMethodContext.
 219    */
 220   static InputMethodContext New( Actor actor );
 221
 222   /**
 223    * @brief Finalize the InputMethodContext.
 224    *
 225    * It means that the context will be deleted.
 226    */
 227   void Finalize();
 228
 229   /**
 230    * @brief Activate the input method context.
 231    *
 232    * It means that the text editing is started at somewhere.
 233    * If the H/W keyboard isn't connected then it will show the virtual keyboard.
 234    */
 235   void Activate();
 236
 237   /**
 238    * @brief Deactivate the input method context.
 239    *
 240    * It means that the text editing is finished at somewhere.
 241    */
 242   void Deactivate();
 243
 244   /**
 245    * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
 246    *
 247    * If true then keyboard will be restored (activated) after focus is regained.
 248    * @return restoration status.
 249    */
 250   bool RestoreAfterFocusLost() const;
 251
 252   /**
 253    * @brief Set status whether the input method context has to restore the keyboard after losing focus.
 254    *
 255    * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
 256    */
 257   void SetRestoreAfterFocusLost( bool toggle );
 258
 259   /**
 260    * @brief Send message reset the pred-edit state / input method context module.
 261    *
 262    * Used to interupt pre-edit state maybe due to a touch input.
 263    */
 264   void Reset();
 265
 266   /**
 267    * @brief Notifies ImfContext that the cursor position has changed, required for features like auto-capitalisation.
 268    */
 269   void NotifyCursorPosition();
 270
 271   /**
 272    * @brief Sets cursor position stored in VirtualKeyboard, this is required by the ImfContext.
 273    *
 274    * @param[in] cursorPosition position of cursor
 275    */
 276   void SetCursorPosition( unsigned int cursorPosition );
 277
 278   /**
 279    * @brief Gets cursor position stored in VirtualKeyboard, this is required by the ImfContext.
 280    *
 281    * @return current position of cursor
 282    */
 283   unsigned int GetCursorPosition() const;
 284
 285   /**
 286    * @brief Method to store the string required by the input method context, this is used to provide predictive word suggestions.
 287    *
 288    * @param[in] text The text string surrounding the current cursor point.
 289    */
 290   void SetSurroundingText( const std::string& text );
 291
 292   /**
 293    * @brief Gets current text string set within the input method context, this is used to offer predictive suggestions.
 294    *
 295    * @return current position of cursor
 296    */
 297   const std::string& GetSurroundingText() const;
 298
 299   /**
 300   * @brief Notifies ImfContext that text input is set to multi line or not
 301   */
 302   void NotifyTextInputMultiLine( bool multiLine );
 303
 304   /**
 305    * @brief Set one or more of the Input Method options
 306    * @param[in] options The options to be applied
 307    */
 308   void ApplyOptions( const InputMethodOptions& options );
 309
 310   /**
 311    * @brief Process event key down or up, whether filter a key to isf.
 312    *
 313    * @param[in] keyEvent The event key to be handled.
 314    * @return Whether the event key is handled.
 315    */
 316   bool FilterEventKey( const Dali::KeyEvent& keyEvent );
 317
 318   /**
 319    * @brief Sets the preedit type.
 320    *
 321    * @param[in] type The preedit style type
 322    */
 323   void SetPreeditStyle( PreeditStyle type );
 324
 325   /**
 326    * @brief Gets the preedit attrs data.
 327    *
 328    * @param[out] attrs The preedit attrs data.
 329    */
 330   void GetPreeditStyle( Vector<PreeditAttributeData>& attrs ) const;
 331
 332 public:
 333
 334   // Signals
 335
 336   /**
 337    * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
 338    *
 339    * @return The input method context Activated signal.
 340    */
 341   ActivatedSignalType& ActivatedSignal();
 342
 343   /**
 344    * @brief This is emitted when the input method context receives an event.
 345    *
 346    * @return The Event signal containing the event data.
 347    */
 348   KeyboardEventSignalType& EventReceivedSignal();
 349
 350   /**
 351    * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
 352    *
 353    * @return The signal connect to status changed event.
 354    */
 355   StatusSignalType& StatusChangedSignal();
 356
 357   /**
 358    * @brief Connect to this signal to be notified when the virtual keyboard is resized.
 359    *
 360    * @return The signal to connect to resized event.
 361    */
 362   VoidSignalType& ResizedSignal();
 363
 364   /**
 365    * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
 366    *
 367    * @return The signal to connect to language changed event.
 368    */
 369   VoidSignalType& LanguageChangedSignal();
 370
 371   // Construction & Destruction
 372
 373   /**
 374    * @brief Constructor.
 375    */
 376   InputMethodContext();
 377
 378   /**
 379    * @brief Destructor
 380    *
 381    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 382    */
 383   ~InputMethodContext();
 384
 385   /**
 386    * @brief This constructor is used by InputMethodContext::Get().
 387    *
 388    * @param[in] inputMethodContext A pointer to the input method context.
 389    */
 390   explicit InputMethodContext( Internal::Adaptor::InputMethodContext* inputMethodContext );
 391 };
 392
 393 } // namespace Dali
 394
 395 #endif // DALI_TOOLKIT_TOOLKIT_INPUT_METHOD_CONTEXT_H