adaptors/devel-api/adaptor-framework/imf-manager.h

   1 #ifndef __DALI_IMF_MANAGER_H__
   2 #define __DALI_IMF_MANAGER_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 #include <dali/public-api/object/base-handle.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24 #include "input-method-options.h"
  25
  26 namespace Dali
  27 {
  28
  29 namespace Internal DALI_INTERNAL
  30 {
  31 namespace Adaptor
  32 {
  33 class ImfManager;
  34 }
  35 }
  36
  37 /**
  38  * @brief The ImfManager class
  39  *
  40  * Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
  41  */
  42 class DALI_IMPORT_API ImfManager : public BaseHandle
  43 {
  44 public:
  45
  46   /**
  47   * @brief The direction of text.
  48   */
  49   enum TextDirection
  50   {
  51     LeftToRight,
  52     RightToLeft,
  53   };
  54
  55   /**
  56    * @brief Events that are generated by the IMF.
  57    */
  58   enum ImfEvent
  59   {
  60     VOID,                ///< No event
  61     PREEDIT,             ///< Pre-Edit changed
  62     COMMIT,              ///< Commit recieved
  63     DELETESURROUNDING,   ///< Event to delete a range of characters from the string
  64     GETSURROUNDING,      ///< Event to query string and cursor position
  65     PRIVATECOMMAND       ///< Private command sent from the input panel
  66   };
  67
  68   /**
  69    * @brief Enumeration for state of the input panel.
  70    */
  71   enum State
  72   {
  73     DEFAULT = 0,   ///< Unknown state
  74     SHOW,          ///< Input panel is shown
  75     HIDE,          ///< Input panel is hidden
  76     WILL_SHOW      ///< Input panel in process of being shown
  77   };
  78
  79   /**
  80    * @brief Enumeration for the type of Keyboard.
  81    */
  82   enum KeyboardType
  83   {
  84     SOFTWARE_KEYBOARD,  ///< Software keyboard (Virtual keyboard) is default
  85     HARDWARE_KEYBOARD   ///< Hardware keyboard
  86   };
  87
  88   /**
  89    * @brief This structure is used to pass on data from the IMF regarding predictive text.
  90    */
  91   struct ImfEventData
  92   {
  93     /**
  94      * @brief Default Constructor.
  95      */
  96     ImfEventData()
  97     : predictiveString(),
  98       eventName( VOID ),
  99       cursorOffset( 0 ),
 100       numberOfChars ( 0 )
 101     {
 102     };
 103
 104     /**
 105      * @brief Constructor
 106      *
 107      * @param[in] aEventName The name of the event from the IMF.
 108      * @param[in] aPredictiveString The pre-edit or commit string.
 109      * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
 110      * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
 111      */
 112     ImfEventData( ImfEvent aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
 113     : predictiveString( aPredictiveString ),
 114       eventName( aEventName ),
 115       cursorOffset( aCursorOffset ),
 116       numberOfChars( aNumberOfChars )
 117     {
 118     }
 119
 120     // Data
 121     std::string predictiveString; ///< The pre-edit or commit string.
 122     ImfEvent eventName;           ///< The name of the event from the IMF.
 123     int cursorOffset;             ///< Start position from the current cursor position to start deleting characters.
 124     int numberOfChars;            ///< number of characters to delete from the cursorOffset.
 125   };
 126
 127   /**
 128    * @brief Data required by IMF from the callback
 129    */
 130   struct ImfCallbackData
 131   {
 132     /**
 133      * @brief Constructor
 134      */
 135     ImfCallbackData()
 136     : currentText(),
 137       cursorPosition( 0 ),
 138       update( false ),
 139       preeditResetRequired( false )
 140     {
 141     }
 142
 143     /**
 144      * @brief Constructor
 145      * @param[in] aUpdate True if cursor position needs to be updated
 146      * @param[in] aCursorPosition new position of cursor
 147      * @param[in] aCurrentText current text string
 148      * @param[in] aPreeditResetRequired flag if preedit reset is required.
 149      */
 150     ImfCallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
 151     : currentText( aCurrentText ),
 152       cursorPosition( aCursorPosition ),
 153       update( aUpdate ),
 154       preeditResetRequired( aPreeditResetRequired )
 155     {
 156     }
 157
 158     std::string currentText;      ///< current text string
 159     int cursorPosition;           ///< new position of cursor
 160     bool update               :1; ///< if cursor position needs to be updated
 161     bool preeditResetRequired :1; ///< flag if preedit reset is required.
 162   };
 163
 164   typedef Signal< void (ImfManager&) > ImfManagerSignalType; ///< Keyboard actived signal
 165   typedef Signal< ImfCallbackData ( ImfManager&, const ImfEventData& ) > ImfEventSignalType; ///< keyboard events
 166   typedef Signal< void () > VoidSignalType;
 167   typedef Signal< void (bool) > StatusSignalType;
 168   typedef Signal< void (KeyboardType) > KeyboardTypeSignalType; ///< keyboard type
 169
 170 public:
 171
 172   /**
 173    * @brief Retrieve a handle to the instance of ImfManager.
 174    * @return A handle to the ImfManager.
 175    */
 176   static ImfManager Get();
 177
 178   /**
 179    * @brief Activate the IMF.
 180    *
 181    * It means that the text editing is started at somewhere.
 182    * If the H/W keyboard isn't connected then it will show the virtual keyboard.
 183    */
 184   void Activate();
 185
 186   /**
 187    * @brief Deactivate the IMF.
 188    *
 189    * It means that the text editing is finished at somewhere.
 190    */
 191   void Deactivate();
 192
 193   /**
 194    * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
 195    *
 196    * If true then keyboard will be restored (activated) after focus is regained.
 197    * @return restoration status.
 198    */
 199   bool RestoreAfterFocusLost() const;
 200
 201   /**
 202    * @brief Set status whether the IMF has to restore the keyboard after losing focus.
 203    *
 204    * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
 205    */
 206   void SetRestoreAfterFocusLost( bool toggle );
 207
 208   /**
 209    * @brief Send message reset the pred-edit state / imf module.
 210    *
 211    * Used to interupt pre-edit state maybe due to a touch input.
 212    */
 213   void Reset();
 214
 215   /**
 216    * @brief Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation.
 217    */
 218   void NotifyCursorPosition();
 219
 220   /**
 221    * @brief Sets cursor position stored in VirtualKeyboard, this is required by the IMF context.
 222    *
 223    * @param[in] cursorPosition position of cursor
 224    */
 225   void SetCursorPosition( unsigned int cursorPosition );
 226
 227   /**
 228    * @brief Gets cursor position stored in VirtualKeyboard, this is required by the IMF context.
 229    *
 230    * @return current position of cursor
 231    */
 232   unsigned int GetCursorPosition() const;
 233
 234   /**
 235    * @brief Method to store the string required by the IMF, this is used to provide predictive word suggestions.
 236    *
 237    * @param[in] text The text string surrounding the current cursor point.
 238    */
 239   void SetSurroundingText( const std::string& text );
 240
 241   /**
 242    * @brief Gets current text string set within the IMF manager, this is used to offer predictive suggestions.
 243    *
 244    * @return current position of cursor
 245    */
 246   const std::string& GetSurroundingText() const;
 247
 248   /**
 249  * @brief Notifies IMF context that text input is set to multi line or not
 250  *
 251  * @param[in] multiLine True if multiline text input is used
 252  */
 253   void NotifyTextInputMultiLine( bool multiLine );
 254
 255   /**
 256    * @brief Returns text direction of the keyboard's current input language.
 257    * @return The direction of the text.
 258    */
 259   TextDirection GetTextDirection();
 260
 261   /**
 262    * @brief Provides size and position of keyboard.
 263    *
 264    * Position is relative to whether keyboard is visible or not.
 265    * If keyboard is not visible then position will be off the screen.
 266    * If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
 267    * the values then taken down.  So ideally GetInputMethodArea() should be called after Show().
 268    * @return rect which is keyboard panel x, y, width, height
 269    */
 270   Dali::Rect<int> GetInputMethodArea();
 271
 272   /**
 273    * @brief Set one or more of the Input Method options
 274    * @param[in] options The options to be applied
 275    */
 276   void ApplyOptions( const InputMethodOptions& options );
 277
 278   /**
 279    * @brief Sets up the input-panel specific data.
 280    * @param[in] data The specific data to be set to the input panel
 281    */
 282   void SetInputPanelUserData( const std::string& data );
 283
 284   /**
 285    * @brief Gets the specific data of the current active input panel.
 286    * @param[in] data The specific data to be got from the input panel
 287    */
 288   void GetInputPanelUserData( std::string& data );
 289
 290   /**
 291    * @brief Gets the state of the current active input panel.
 292    * @return The state of the input panel.
 293    */
 294   State GetInputPanelState();
 295
 296   /**
 297    * @brief Sets the return key on the input panel to be visible or invisible.
 298    *
 299    * The default is true.
 300    * @param[in] visible True if the return key is visible(enabled), false otherwise.
 301    */
 302   void SetReturnKeyState( bool visible );
 303
 304   /**
 305    * @brief Enable to show the input panel automatically when focused.
 306    * @param[in] enabled If true, the input panel will be shown when focused
 307    */
 308   void AutoEnableInputPanel( bool enabled );
 309
 310   /**
 311    * @brief Shows the input panel.
 312    */
 313   void ShowInputPanel();
 314
 315   /**
 316    * @brief Hides the input panel.
 317    */
 318   void HideInputPanel();
 319
 320   /**
 321    * @brief Gets the keyboard type.
 322    *
 323    * The default keyboard type is SOFTWARE_KEYBOARD.
 324    * @return The keyboard type
 325    */
 326   KeyboardType GetKeyboardType();
 327
 328   /**
 329    * @brief Gets the current language locale of the input panel.
 330    *
 331    * ex) en_US, en_GB, en_PH, fr_FR, ...
 332    * @return The current language locale of the input panel
 333    */
 334   std::string GetInputPanelLocale();
 335
 336 public:
 337
 338   // Signals
 339
 340   /**
 341    * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
 342    *
 343    * @return The IMF Activated signal.
 344    */
 345   ImfManagerSignalType& ActivatedSignal();
 346
 347   /**
 348    * @brief This is emitted when the IMF manager receives an event from the IMF.
 349    *
 350    * @return The Event signal containing the event data.
 351    */
 352   ImfEventSignalType& EventReceivedSignal();
 353
 354   /**
 355    * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
 356    *
 357    * A callback of the following type may be connected:
 358    * @code
 359    *   void YourCallbackName(bool keyboardShown);
 360    * @endcode
 361    * If the parameter keyboardShown is true, then the keyboard has just shown, if it is false, then it
 362    * has just been hidden.
 363    * @return The signal to connect to.
 364    */
 365   StatusSignalType& StatusChangedSignal();
 366
 367   /**
 368    * @brief Connect to this signal to be notified when the virtual keyboard is resized.
 369    *
 370    * A callback of the following type may be connected:
 371    * @code
 372    *   void YourCallbackName();
 373    * @endcode
 374    * User can get changed size by using GetInputMethodArea() in the callback
 375    * @return The signal to connect to.
 376    */
 377   VoidSignalType& ResizedSignal();
 378
 379   /**
 380    * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
 381    *
 382    * A callback of the following type may be connected:
 383    * @code
 384    *   void YourCallbackName();
 385    * @endcode
 386    * User can get the text direction of the language by calling GetTextDirection() in the callback.
 387    * @return The signal to connect to.
 388    */
 389   VoidSignalType& LanguageChangedSignal();
 390
 391   /**
 392    * @brief Connect to this signal to be notified when the keyboard type is changed.
 393    *
 394    * A callback of the following type may be connected:
 395    * @code
 396    *   void YourCallbackName( KeyboardType keyboard );
 397    * @endcode
 398    *
 399    * @return The signal to connect to.
 400    */
 401   KeyboardTypeSignalType& KeyboardTypeChangedSignal();
 402
 403   // Construction & Destruction
 404
 405   /**
 406    * @brief Constructor.
 407    */
 408   ImfManager();
 409
 410   /**
 411    * @brief Destructor
 412    *
 413    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 414    */
 415   ~ImfManager();
 416
 417   /**
 418    * @brief This constructor is used by ImfManager::Get().
 419    *
 420    * @param[in] imfManager A pointer to the imf Manager.
 421    */
 422   explicit DALI_INTERNAL ImfManager( Internal::Adaptor::ImfManager* imfManager );
 423 };
 424
 425 } // namespace Dali
 426
 427 #endif // __DALI_IMF_MANAGER_H__