// EXTERNAL INCLUDES
#define __DALI_IMF_MANAGER_H__
#include <dali/public-api/object/base-handle.h>
-#include <dali/public-api/signals/dali-signal-v2.h>
+#include <dali/public-api/signals/dali-signal.h>
+#include <dali/devel-api/adaptor-framework/input-method-options.h>
namespace Dali DALI_IMPORT_API
{
}
}
-typedef void* ImfContext;
-
/**
* @brief The ImfManager class
+ *
* Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
*/
class ImfManager : public BaseHandle
{
public:
+ /**
+ * @brief Events that are generated by the IMF.
+ */
enum ImfEvent
{
- VOID,
- PREEDIT,
- COMMIT,
- DELETESURROUNDING,
- GETSURROUNDING
+ VOID, ///< No event
+ PREEDIT, ///< Pre-Edit changed
+ COMMIT, ///< Commit recieved
+ DELETESURROUNDING, ///< Event to delete a range of characters from the string
+ GETSURROUNDING, ///< Event to query string and cursor position
+ PRIVATECOMMAND ///< Private command sent from the input panel
};
/**
- * This structure is used to pass on data from the IMF regarding predictive text.
+ * @brief This structure is used to pass on data from the IMF regarding predictive text.
*/
struct ImfEventData
{
/**
- * Default Constructor.
+ * @brief Default Constructor.
*/
ImfEventData()
- : eventName( VOID ),
- predictiveString(""),
+ : predictiveString(),
+ eventName( VOID ),
cursorOffset( 0 ),
numberOfChars ( 0 )
{
};
/**
- * Constructor
+ * @brief Constructor
+ *
* @param[in] aEventName The name of the event from the IMF.
* @param[in] aPredictiveString The pre-edit or commit string.
* @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
* @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
*/
- ImfEventData(ImfEvent aEventName, const std::string& aPredictiveString, int aCursorOffset,int aNumberOfChars )
- : eventName(aEventName), predictiveString(aPredictiveString), cursorOffset( aCursorOffset ), numberOfChars( aNumberOfChars )
+ ImfEventData( ImfEvent aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
+ : predictiveString( aPredictiveString ),
+ eventName( aEventName ),
+ cursorOffset( aCursorOffset ),
+ numberOfChars( aNumberOfChars )
{
}
// Data
- ImfEvent eventName; // The name of the event from the IMF.
- std::string predictiveString; // The pre-edit or commit string.
- int cursorOffset; // Start position from the current cursor position to start deleting characters.
- int numberOfChars; //number of characters to delete from the cursorOffset.
+ std::string predictiveString; ///< The pre-edit or commit string.
+ ImfEvent eventName; ///< The name of the event from the IMF.
+ int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
+ int numberOfChars; ///< number of characters to delete from the cursorOffset.
};
/**
- * Data required my IMF from the callback
+ * @brief Data required by IMF from the callback
*/
struct ImfCallbackData
{
- ImfCallbackData( )
- : update( false ), cursorPosition( 0 ), preeditResetRequired ( false )
+ /**
+ * @brief Constructor
+ */
+ ImfCallbackData()
+ : currentText(),
+ cursorPosition( 0 ),
+ update( false ),
+ preeditResetRequired( false )
{
}
- ImfCallbackData(bool aUpdate, int aCursorPosition, std::string aCurrentText, bool aPreeditResetRequired )
- : update(aUpdate), cursorPosition(aCursorPosition), currentText( aCurrentText ), preeditResetRequired( aPreeditResetRequired )
+ /**
+ * @brief Constructor
+ * @param[in] aUpdate True if cursor position needs to be updated
+ * @param[in] aCursorPosition new position of cursor
+ * @param[in] aCurrentText current text string
+ * @param[in] aPreeditResetRequired flag if preedit reset is required.
+ */
+ ImfCallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
+ : currentText( aCurrentText ),
+ cursorPosition( aCursorPosition ),
+ update( aUpdate ),
+ preeditResetRequired( aPreeditResetRequired )
{
}
- bool update; // if cursor position needs to be updated
- int cursorPosition; // new position of cursor
- std::string currentText; // current text string
- bool preeditResetRequired; // flag if preedit reset is required.
+ std::string currentText; ///< current text string
+ int cursorPosition; ///< new position of cursor
+ bool update :1; ///< if cursor position needs to be updated
+ bool preeditResetRequired :1; ///< flag if preedit reset is required.
};
- typedef SignalV2< void (ImfManager&) > ImfManagerSignalV2;
-
- typedef SignalV2< ImfCallbackData ( ImfManager&, const ImfEventData& ) > ImfEventSignalV2;
+ typedef Signal< void (ImfManager&) > ImfManagerSignalType; ///< Keyboard actived signal
+ typedef Signal< ImfCallbackData ( ImfManager&, const ImfEventData& ) > ImfEventSignalType; ///< keyboard events
+ typedef Signal< void () > VoidSignalType;
+ typedef Signal< void (bool) > StatusSignalType;
public:
/**
- * Retrieve a handle to the instance of ImfManager.
+ * @brief Retrieve a handle to the instance of ImfManager.
* @return A handle to the ImfManager.
*/
static ImfManager Get();
/**
- * Get the current imf context.
- * @return current imf context.
- */
- ImfContext GetContext();
-
- /**
- * Activate the IMF.
+ * @brief Activate the IMF.
+ *
* It means that the text editing is started at somewhere.
* If the H/W keyboard isn't connected then it will show the virtual keyboard.
*/
void Activate();
/**
- * Deactivate the IMF.
+ * @brief Deactivate the IMF.
+ *
* It means that the text editing is finished at somewhere.
*/
void Deactivate();
/**
- * Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
+ * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
+ *
* If true then keyboard will be restored (activated) after focus is regained.
* @return restoration status.
*/
bool RestoreAfterFocusLost() const;
/**
- * Set status whether the IMF has to restore the keyboard after losing focus.
+ * @brief Set status whether the IMF has to restore the keyboard after losing focus.
+ *
* @param[in] toggle True means that keyboard should be restored after focus lost and regained.
*/
- void SetRestoreAferFocusLost( bool toggle );
+ void SetRestoreAfterFocusLost( bool toggle );
/**
- * Send message reset the pred-edit state / imf module. Used to interupt pre-edit state maybe due to a touch input.
+ * @brief Send message reset the pred-edit state / imf module.
+ *
+ * Used to interupt pre-edit state maybe due to a touch input.
*/
void Reset();
/**
- * Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation
+ * @brief Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation.
*/
void NotifyCursorPosition();
/**
- * Sets cursor position stored in VirtualKeyboard, this is required by the IMF context
+ * @brief Sets cursor position stored in VirtualKeyboard, this is required by the IMF context.
+ *
* @param[in] cursorPosition position of cursor
*/
void SetCursorPosition( unsigned int cursorPosition );
/**
- * Gets cursor position stored in VirtualKeyboard, this is required by the IMF context
+ * @brief Gets cursor position stored in VirtualKeyboard, this is required by the IMF context.
+ *
* @return current position of cursor
*/
- int GetCursorPosition();
+ unsigned int GetCursorPosition() const;
/**
- * Method to store the string required by the IMF, this is used to provide predictive word suggestions.
+ * @brief Method to store the string required by the IMF, this is used to provide predictive word suggestions.
+ *
* @param[in] text The text string surrounding the current cursor point.
*/
- void SetSurroundingText( std::string text );
+ void SetSurroundingText( const std::string& text );
/**
- * Gets current text string set within the IMF manager, this is used to offer predictive suggestions
+ * @brief Gets current text string set within the IMF manager, this is used to offer predictive suggestions.
+ *
* @return current position of cursor
*/
- std::string GetSurroundingText();
+ const std::string& GetSurroundingText() const;
+
+ /**
+ * @brief Notifies IMF context that text input is set to multi line or not
+ */
+ void NotifyTextInputMultiLine( bool multiLine );
+
+ /**
+ * @brief Set one or more of the Input Method options
+ * @param[in] options The options to be applied
+ */
+ void ApplyOptions( const InputMethodOptions& options );
public:
// Signals
/**
- * This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
+ * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
+ *
* @return The IMF Activated signal.
*/
- ImfManagerSignalV2& ActivatedSignal();
+ ImfManagerSignalType& ActivatedSignal();
/**
- * This is emitted when the IMF manager receives an event from the IMF
+ * @brief This is emitted when the IMF manager receives an event from the IMF.
+ *
* @return The Event signal containing the event data.
*/
- ImfEventSignalV2& EventReceivedSignal();
+ ImfEventSignalType& EventReceivedSignal();
+
+ /**
+ * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
+ *
+ * @return The signal connect to status changed event.
+ */
+ StatusSignalType& StatusChangedSignal();
+
+ /**
+ * @brief Connect to this signal to be notified when the virtual keyboard is resized.
+ *
+ * @return The signal to connect to resized event.
+ */
+ VoidSignalType& ResizedSignal();
+
+ /**
+ * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
+ *
+ * @return The signal to connect to language changed event.
+ */
+ VoidSignalType& LanguageChangedSignal();
// Construction & Destruction
/**
- * Constructor
+ * @brief Constructor.
*/
ImfManager();
/**
- * Non virtual destructor.
+ * @brief Destructor
+ *
+ * This is non-virtual since derived Handle types must not contain data or virtual methods.
*/
~ImfManager();
/**
- * This constructor is used by ImfManager::Get().
+ * @brief This constructor is used by ImfManager::Get().
+ *
* @param[in] imfManager A pointer to the imf Manager.
*/
- ImfManager( Internal::Adaptor::ImfManager* imfManager );
+ explicit ImfManager( Internal::Adaptor::ImfManager* imfManager );
};
} // namespace Dali
projects / platform / core / uifw / dali-toolkit.git / blobdiff