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   typedef Signal< void ( int ) > KeyboardResizedSignalType;  ///< Keyboard resized signal
 170   typedef Signal< void ( int ) > LanguageChangedSignalType;  ///< Language changed signal
 171
 172 public:
 173
 174   /**
 175    * @brief Finalize the IMF.
 176    *
 177    * It means that the context will be deleted.
 178    */
 179   void Finalize();
 180
 181   /**
 182    * @brief Retrieve a handle to the instance of ImfManager.
 183    * @return A handle to the ImfManager.
 184    */
 185   static ImfManager Get();
 186
 187   /**
 188    * @brief Activate the IMF.
 189    *
 190    * It means that the text editing is started at somewhere.
 191    * If the H/W keyboard isn't connected then it will show the virtual keyboard.
 192    */
 193   void Activate();
 194
 195   /**
 196    * @brief Deactivate the IMF.
 197    *
 198    * It means that the text editing is finished at somewhere.
 199    */
 200   void Deactivate();
 201
 202   /**
 203    * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
 204    *
 205    * If true then keyboard will be restored (activated) after focus is regained.
 206    * @return restoration status.
 207    */
 208   bool RestoreAfterFocusLost() const;
 209
 210   /**
 211    * @brief Set status whether the IMF has to restore the keyboard after losing focus.
 212    *
 213    * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
 214    */
 215   void SetRestoreAfterFocusLost( bool toggle );
 216
 217   /**
 218    * @brief Send message reset the pred-edit state / imf module.
 219    *
 220    * Used to interupt pre-edit state maybe due to a touch input.
 221    */
 222   void Reset();
 223
 224   /**
 225    * @brief Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation.
 226    */
 227   void NotifyCursorPosition();
 228
 229   /**
 230    * @brief Sets cursor position stored in VirtualKeyboard, this is required by the IMF context.
 231    *
 232    * @param[in] cursorPosition position of cursor
 233    */
 234   void SetCursorPosition( unsigned int cursorPosition );
 235
 236   /**
 237    * @brief Gets cursor position stored in VirtualKeyboard, this is required by the IMF context.
 238    *
 239    * @return current position of cursor
 240    */
 241   unsigned int GetCursorPosition() const;
 242
 243   /**
 244    * @brief Method to store the string required by the IMF, this is used to provide predictive word suggestions.
 245    *
 246    * @param[in] text The text string surrounding the current cursor point.
 247    */
 248   void SetSurroundingText( const std::string& text );
 249
 250   /**
 251    * @brief Gets current text string set within the IMF manager, this is used to offer predictive suggestions.
 252    *
 253    * @return current position of cursor
 254    */
 255   const std::string& GetSurroundingText() const;
 256
 257   /**
 258  * @brief Notifies IMF context that text input is set to multi line or not
 259  *
 260  * @param[in] multiLine True if multiline text input is used
 261  */
 262   void NotifyTextInputMultiLine( bool multiLine );
 263
 264   /**
 265    * @brief Returns text direction of the keyboard's current input language.
 266    * @return The direction of the text.
 267    */
 268   TextDirection GetTextDirection();
 269
 270   /**
 271    * @brief Provides size and position of keyboard.
 272    *
 273    * Position is relative to whether keyboard is visible or not.
 274    * If keyboard is not visible then position will be off the screen.
 275    * If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
 276    * the values then taken down.  So ideally GetInputMethodArea() should be called after Show().
 277    * @return rect which is keyboard panel x, y, width, height
 278    */
 279   Dali::Rect<int> GetInputMethodArea();
 280
 281   /**
 282    * @brief Set one or more of the Input Method options
 283    * @param[in] options The options to be applied
 284    */
 285   void ApplyOptions( const InputMethodOptions& options );
 286
 287   /**
 288    * @brief Sets up the input-panel specific data.
 289    * @param[in] data The specific data to be set to the input panel
 290    */
 291   void SetInputPanelData( const std::string& data );
 292
 293   /**
 294    * @brief Gets the specific data of the current active input panel.
 295    *
 296    * Input Panel Data is not always the data which is set by SetInputPanelData().
 297    * Data can be changed internally in the input panel.
 298    * It is just used to get a specific data from the input panel to an application.
 299    * @param[in] data The specific data to be got from the input panel
 300    */
 301   void GetInputPanelData( std::string& data );
 302
 303   /**
 304    * @brief Gets the state of the current active input panel.
 305    * @return The state of the input panel.
 306    */
 307   State GetInputPanelState();
 308
 309   /**
 310    * @brief Sets the return key on the input panel to be visible or invisible.
 311    *
 312    * The default is true.
 313    * @param[in] visible True if the return key is visible(enabled), false otherwise.
 314    */
 315   void SetReturnKeyState( bool visible );
 316
 317   /**
 318    * @brief Enable to show the input panel automatically when focused.
 319    * @param[in] enabled If true, the input panel will be shown when focused
 320    */
 321   void AutoEnableInputPanel( bool enabled );
 322
 323   /**
 324    * @brief Shows the input panel.
 325    */
 326   void ShowInputPanel();
 327
 328   /**
 329    * @brief Hides the input panel.
 330    */
 331   void HideInputPanel();
 332
 333   /**
 334    * @brief Gets the keyboard type.
 335    *
 336    * The default keyboard type is SOFTWARE_KEYBOARD.
 337    * @return The keyboard type
 338    */
 339   KeyboardType GetKeyboardType();
 340
 341   /**
 342    * @brief Gets the current language locale of the input panel.
 343    *
 344    * ex) en_US, en_GB, en_PH, fr_FR, ...
 345    * @return The current language locale of the input panel
 346    */
 347   std::string GetInputPanelLocale();
 348
 349 public:
 350
 351   // Signals
 352
 353   /**
 354    * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
 355    *
 356    * @return The IMF Activated signal.
 357    */
 358   ImfManagerSignalType& ActivatedSignal();
 359
 360   /**
 361    * @brief This is emitted when the IMF manager receives an event from the IMF.
 362    *
 363    * @return The Event signal containing the event data.
 364    */
 365   ImfEventSignalType& EventReceivedSignal();
 366
 367   /**
 368    * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
 369    *
 370    * A callback of the following type may be connected:
 371    * @code
 372    *   void YourCallbackName(bool keyboardShown);
 373    * @endcode
 374    * If the parameter keyboardShown is true, then the keyboard has just shown, if it is false, then it
 375    * has just been hidden.
 376    * @return The signal to connect to.
 377    */
 378   StatusSignalType& StatusChangedSignal();
 379
 380   /**
 381    * @brief Connect to this signal to be notified when the virtual keyboard is resized.
 382    *
 383    * A callback of the following type may be connected:
 384    * @code
 385    *   void YourCallbackName( int resolvedResize );
 386    * @endcode
 387    * The parameter sends the resolved resize defined by the IMF.
 388    *
 389    * User can get changed size by using GetInputMethodArea() in the callback
 390    * @return The signal to connect to.
 391    */
 392   KeyboardResizedSignalType& ResizedSignal();
 393
 394   /**
 395    * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
 396    *
 397    * A callback of the following type may be connected:
 398    * @code
 399    *   void YourCallbackName( int resolvedLanguage );
 400    * @endcode
 401    * The parameter sends the resolved language defined by the IMF.
 402    *
 403    * User can get the text direction of the language by calling GetTextDirection() in the callback.
 404    * @return The signal to connect to.
 405    */
 406   LanguageChangedSignalType& LanguageChangedSignal();
 407
 408   /**
 409    * @brief Connect to this signal to be notified when the keyboard type is changed.
 410    *
 411    * A callback of the following type may be connected:
 412    * @code
 413    *   void YourCallbackName( KeyboardType keyboard );
 414    * @endcode
 415    *
 416    * @return The signal to connect to.
 417    */
 418   KeyboardTypeSignalType& KeyboardTypeChangedSignal();
 419
 420   // Construction & Destruction
 421
 422   /**
 423    * @brief Constructor.
 424    */
 425   ImfManager();
 426
 427   /**
 428    * @brief Destructor
 429    *
 430    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 431    */
 432   ~ImfManager();
 433
 434   /**
 435    * @brief This constructor is used by ImfManager::Get().
 436    *
 437    * @param[in] imfManager A pointer to the imf Manager.
 438    */
 439   explicit DALI_INTERNAL ImfManager( Internal::Adaptor::ImfManager* imfManager );
 440 };
 441
 442 } // namespace Dali
 443
 444 #endif // __DALI_IMF_MANAGER_H__