(KeyEvents) Removing deprecated and unused KeyEvents
authorAgnelo Vaz <agnelo.vaz@samsung.com>
Fri, 28 Feb 2014 10:34:02 +0000 (10:34 +0000)
committerPaul Wisbey <p.wisbey@samsung.com>
Mon, 3 Mar 2014 18:34:53 +0000 (18:34 +0000)
[Issue#] N/A
[Problem] N/A
[Cause] N/A
[Solution] Removing Deprecated parts of KeyEvent
           Removing cursorOffset and numberOfCharacters memebers variables as not used
[Verification] Build Repo

automated-tests/dali-test-suite/events/utc-Dali-KeyEvent.cpp
capi/dali/public-api/events/key-event.h
dali/integration-api/events/key-event-integ.cpp
dali/integration-api/events/key-event-integ.h
dali/internal/event/events/key-event-processor.cpp
dali/public-api/events/key-event.cpp

index e791758..b9412a7 100644 (file)
@@ -121,7 +121,7 @@ static void UtcDaliKeyEventConstructor()
 {
   TestApplication application; // Reset all test adapter return codes
 
-  KeyEvent event(TEST_STRING_1,"i", 99, SHIFT_MODIFIER, 0, 0, KeyEvent::Down);  // set name to test, key string to i and modifier to shift
+  KeyEvent event(TEST_STRING_1,"i", 99, SHIFT_MODIFIER, 0, KeyEvent::Down);  // set name to test, key string to i and modifier to shift
 
   DALI_TEST_EQUALS(TEST_STRING_1, event.keyPressedName, TEST_LOCATION); // check key name
   DALI_TEST_EQUALS("i", event.keyPressed, TEST_LOCATION); // check key string
@@ -181,7 +181,7 @@ static void UtcDaliKeyEventIsNotShiftModifier()
 {
   TestApplication application; // Reset all test adapter return codes
 
-  KeyEvent event("i","i", CTRL_MODIFIER, 0, 0, KeyEvent::Down);
+  KeyEvent event("i","i", 0, CTRL_MODIFIER, 0, KeyEvent::Down);
 
   DALI_TEST_EQUALS(CTRL_MODIFIER, event.keyModifier, TEST_LOCATION);  // check different modifier used
 
@@ -193,11 +193,11 @@ static void UtcDaliKeyEventIsNotCtrlModifier()
 {
   TestApplication application; // Reset all test adapter return codes
 
-  KeyEvent event("i","i", ALT_MODIFIER, 0, 0, KeyEvent::Up);
+  KeyEvent event("i","i", 0, ALT_MODIFIER, 0, KeyEvent::Up);
 
-    DALI_TEST_EQUALS(ALT_MODIFIER, event.keyModifier, TEST_LOCATION);  // check different modifier used
+  DALI_TEST_EQUALS(ALT_MODIFIER, event.keyModifier, TEST_LOCATION);  // check different modifier used
 
-    DALI_TEST_EQUALS(false, event.IsCtrlModifier(), TEST_LOCATION);
+  DALI_TEST_EQUALS(false, event.IsCtrlModifier(), TEST_LOCATION);
 }
 
 // Positive fail test case for a method
@@ -205,7 +205,7 @@ static void UtcDaliKeyEventIsNotAltModifier()
 {
   TestApplication application; // Reset all test adapter return codes
 
-  KeyEvent event("i","i", SHIFT_MODIFIER, 0, 0, KeyEvent::Up);
+  KeyEvent event("i","i", 0, SHIFT_MODIFIER, 0, KeyEvent::Up);
 
   DALI_TEST_EQUALS(SHIFT_MODIFIER, event.keyModifier, TEST_LOCATION);  // check different modifier used
 
@@ -217,7 +217,7 @@ static void UtcDaliKeyEventANDModifer()
 {
   TestApplication application; // Reset all test adapter return codes
 
-  KeyEvent event("i","i", SHIFT_AND_CTRL_MODIFIER, 0, 0, KeyEvent::Down);
+  KeyEvent event("i","i", 0, SHIFT_AND_CTRL_MODIFIER, 0, KeyEvent::Down);
   DALI_TEST_EQUALS(true, event.IsCtrlModifier() & event.IsShiftModifier(), TEST_LOCATION);
 
   event.keyModifier = SHIFT_MODIFIER;
@@ -230,7 +230,7 @@ static void UtcDaliKeyEventORModifer()
 {
   TestApplication application; // Reset all test adapter return codes
 
-  KeyEvent event("i","i", SHIFT_AND_CTRL_MODIFIER, 0, 0, KeyEvent::Down);
+  KeyEvent event("i","i", 0, SHIFT_AND_CTRL_MODIFIER, 0, KeyEvent::Down);
   DALI_TEST_EQUALS(true, event.IsCtrlModifier() | event.IsAltModifier(), TEST_LOCATION);
 
   event.keyModifier = SHIFT_MODIFIER;
@@ -243,7 +243,7 @@ static void UtcDaliKeyEventState()
 {
   TestApplication application; // Reset all test adapter return codes
 
-  KeyEvent event("i","i", SHIFT_AND_CTRL_MODIFIER, 0, 0, KeyEvent::Down);
+  KeyEvent event("i","i", 0, SHIFT_AND_CTRL_MODIFIER, 0, KeyEvent::Down);
   DALI_TEST_EQUALS(true, event.IsCtrlModifier() | event.IsAltModifier(), TEST_LOCATION);
 
   event.keyModifier = SHIFT_MODIFIER;
@@ -262,8 +262,6 @@ static void UtcDaliIntegrationKeyEvent()
     DALI_TEST_CHECK( keyEvent.keyString == std::string() );
     DALI_TEST_EQUALS( keyEvent.keyCode, -1, TEST_LOCATION );
     DALI_TEST_EQUALS( keyEvent.keyModifier, 0, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.cursorOffset, 0, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.numberOfChars, 0, TEST_LOCATION );
     DALI_TEST_EQUALS( keyEvent.time, 0u, TEST_LOCATION );
     DALI_TEST_EQUALS( keyEvent.state, Integration::KeyEvent::Down, TEST_LOCATION);
   }
@@ -271,47 +269,6 @@ static void UtcDaliIntegrationKeyEvent()
   {
     const std::string keyName("keyName");
     const std::string keyString("keyString");
-    const int keyModifier(134);
-    const int offset(10);
-    const int characters(12);
-    const Integration::KeyEvent::State keyState(Integration::KeyEvent::Up);
-
-    Integration::KeyEvent keyEvent(keyName, keyString, keyModifier, offset, characters, keyState);
-    DALI_TEST_EQUALS( keyEvent.type, Integration::Event::Key, TEST_LOCATION );
-    DALI_TEST_CHECK( keyEvent.keyName == keyName );
-    DALI_TEST_CHECK( keyEvent.keyString == keyString );
-    DALI_TEST_EQUALS( keyEvent.keyCode, -1, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.keyModifier, keyModifier, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.cursorOffset, offset, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.numberOfChars, characters, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.time, 0u, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.state, keyState, TEST_LOCATION);
-  }
-
-  {
-    const std::string keyName("keyName");
-    const std::string keyString("keyString");
-    const int keyCode(1201);
-    const int keyModifier(123);
-    const int offset(321);
-    const int characters(102);
-    const Integration::KeyEvent::State keyState(Integration::KeyEvent::Up);
-
-    Integration::KeyEvent keyEvent(keyName, keyString, keyCode, keyModifier, offset, characters, keyState);
-    DALI_TEST_EQUALS( keyEvent.type, Integration::Event::Key, TEST_LOCATION );
-    DALI_TEST_CHECK( keyEvent.keyName == keyName );
-    DALI_TEST_CHECK( keyEvent.keyString == keyString );
-    DALI_TEST_EQUALS( keyEvent.keyCode, keyCode, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.keyModifier, keyModifier, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.cursorOffset, offset, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.numberOfChars, characters, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.time, 0u, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.state, keyState, TEST_LOCATION);
-  }
-
-  {
-    const std::string keyName("keyName");
-    const std::string keyString("keyString");
     const int keyCode(333);
     const int keyModifier(312);
     const int offset(29);
@@ -319,14 +276,12 @@ static void UtcDaliIntegrationKeyEvent()
     const unsigned long timeStamp(132);
     const Integration::KeyEvent::State keyState(Integration::KeyEvent::Up);
 
-    Integration::KeyEvent keyEvent(keyName, keyString, keyCode, keyModifier, offset, characters, timeStamp, keyState);
+    Integration::KeyEvent keyEvent(keyName, keyString, keyCode, keyModifier, timeStamp, keyState);
     DALI_TEST_EQUALS( keyEvent.type, Integration::Event::Key, TEST_LOCATION );
     DALI_TEST_CHECK( keyEvent.keyName == keyName );
     DALI_TEST_CHECK( keyEvent.keyString == keyString );
     DALI_TEST_EQUALS( keyEvent.keyCode, keyCode, TEST_LOCATION );
     DALI_TEST_EQUALS( keyEvent.keyModifier, keyModifier, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.cursorOffset, offset, TEST_LOCATION );
-    DALI_TEST_EQUALS( keyEvent.numberOfChars, characters, TEST_LOCATION );
     DALI_TEST_EQUALS( keyEvent.time, timeStamp, TEST_LOCATION );
     DALI_TEST_EQUALS( keyEvent.state, keyState, TEST_LOCATION);
   }
index ef72f69..70dccc6 100644 (file)
@@ -58,44 +58,15 @@ struct KeyEvent
   KeyEvent();
 
   /**
-   * @deprecated Use KeyEvent(std::string keyName, std::string keyString, int keyCode, int keyModifier, int cursorOffset, int numberOfChars) constructor instead.
-   *
-   * Constructor
-   * @param[in]  keyName    The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
-   * @param[in]  keyString  A string of input characters or key pressed
-   * @param[in]  keyModifier  The key modifier for special keys like shift and alt
-   * @param[in]  cursorOffset  Used by the IMF keyboard and predictive text to specify a start position from the current cursor position to start deleting characters.
-   * @param[in]  numberOfChars Used by the IMF keyboard and predictive text to specify how many characters to delete from the cursorOffset.
-   * @param[in]  keyState The state of the key event.
-   */
-  KeyEvent(const std::string& keyName, const std::string& keyString, const int& keyModifier, const int& cursorOffset, const int& numberOfChars, const State& keyState);
-
-  /**
-   * @deprecated Use KeyEvent(std::string keyName, std::string keyString, int keyCode, int keyModifier, int cursorOffset, unsigned long timeStamp, int numberOfChars) constructor instead.
-   *
-   * Constructor
-   * @param[in]  keyName       The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
-   * @param[in]  keyString     A string of input characters or key pressed
-   * @param[in]  keyCode       The unique key code for the key pressed.
-   * @param[in]  keyModifier   The key modifier for special keys like shift and alt
-   * @param[in]  cursorOffset  Used by the IMF keyboard and predictive text to specify a start position from the current cursor position to start deleting characters.
-   * @param[in]  numberOfChars Used by the IMF keyboard and predictive text to specify how many characters to delete from the cursorOffset.
-   * @param[in]  keyState The state of the key event.
-   */
-  KeyEvent(const std::string& keyName, const std::string& keyString, const int& keyCode, const int& keyModifier, const int& cursorOffset, const int& numberOfChars, const State& keyState);
-
-  /**
    * Constructor
    * @param[in]  keyName       The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
    * @param[in]  keyString     A string of input characters or key pressed
    * @param[in]  keyCode       The unique key code for the key pressed.
    * @param[in]  keyModifier   The key modifier for special keys like shift and alt
-   * @param[in]  cursorOffset  Used by the IMF keyboard and predictive text to specify a start position from the current cursor position to start deleting characters.
-   * @param[in]  numberOfChars Used by the IMF keyboard and predictive text to specify how many characters to delete from the cursorOffset.
    * @param[in]  timeStamp The time (in ms) that the key event occurred.
    * @param[in]  keyState The state of the key event.
    */
-  KeyEvent(const std::string& keyName, const std::string& keyString, const int& keyCode, const int& keyModifier, const int& cursorOffset, const int& numberOfChars, const unsigned long& timeStamp, const State& keyState);
+  KeyEvent(const std::string& keyName, const std::string& keyString, int keyCode, int keyModifier, unsigned long timeStamp, const State& keyState);
 
   /**
    * Destructor
@@ -143,16 +114,6 @@ struct KeyEvent
   int  keyModifier;
 
   /**
-   * offset from current cursor position as provided by input framework
-   */
-  int cursorOffset;
-
-  /**
-   * number of characters from offset position to operate on as provided by input framework, usually to delete the given range.
-   */
-  int numberOfChars;
-
-  /**
    * The time (in ms) that the key event occurred.
    */
   unsigned long time;
index c0ac7c5..dc9ace4 100644 (file)
@@ -29,47 +29,17 @@ KeyEvent::KeyEvent()
   keyString(),
   keyCode(-1),
   keyModifier(0),
-  cursorOffset(0),
-  numberOfChars(0),
   time(0),
   state(KeyEvent::Down)
 {
 }
 
-KeyEvent::KeyEvent(const std::string& keyName, const std::string& keyString, const int& keyModifier, const int& offset, const int& characters, const State& keyState)
-: Event(Key),
-  keyName(keyName),
-  keyString(keyString),
-  keyCode(-1),
-  keyModifier(keyModifier),
-  cursorOffset(offset),
-  numberOfChars(characters),
-  time(0),
-  state(keyState)
-{
-}
-
-KeyEvent::KeyEvent(const std::string& keyName, const std::string& keyString, const int& keyCode, const int& keyModifier, const int& offset, const int& characters, const State& keyState)
-: Event(Key),
-  keyName(keyName),
-  keyString(keyString),
-  keyCode(keyCode),
-  keyModifier(keyModifier),
-  cursorOffset(offset),
-  numberOfChars(characters),
-  time(0),
-  state(keyState)
-{
-}
-
-KeyEvent::KeyEvent(const std::string& keyName, const std::string& keyString, const int& keyCode, const int& keyModifier, const int& offset, const int& characters, const unsigned long& timeStamp, const State& keyState)
+KeyEvent::KeyEvent(const std::string& keyName, const std::string& keyString, int keyCode, int keyModifier, unsigned long timeStamp, const State& keyState)
 : Event(Key),
   keyName(keyName),
   keyString(keyString),
   keyCode(keyCode),
   keyModifier(keyModifier),
-  cursorOffset(offset),
-  numberOfChars(characters),
   time(timeStamp),
   state(keyState)
 {
index d976a40..db544df 100644 (file)
@@ -52,61 +52,19 @@ struct KeyEvent : public Event
   KeyEvent();
 
   /**
-   * @deprecated Use KeyEvent(std::string keyName, std::string keyString, int keyCode, int keyModifier, int cursorOffset, int numberOfChars) constructor instead.
-   *
-   * Constructor
-   * @param[in]  keyName  The name of character/key pressed
-   * @param[in]  keyPressed  The character/key pressed
-   * @param[in]  keyModifier  The raw key code for this character
-   * @param[in]  cursorOffset  Offset from cursor position ( Used by input framework )
-   * @param[in]  numberOfChars  Number of characters from offset to perform actio on ( Used by input framework )
-   * @param[in]  keyState The state of the key event.
-   */
-  KeyEvent(const std::string& keyName,
-           const std::string& keyPressed,
-           const int& keyModifier,
-           const int& cursorOffset,
-           const int& numberOfChars,
-           const State& keyState);
-
-  /**
-   * @deprecated Use KeyEvent(std::string keyName, std::string keyString, int keyCode, int keyModifier, int cursorOffset, unsigned long timeStamp, int numberOfChars) constructor instead.
-   *
    * Constructor
    * @param[in]  keyName       The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
    * @param[in]  keyString     A string of input characters or key pressed
    * @param[in]  keyCode       The unique key code for the key pressed.
    * @param[in]  keyModifier   The key modifier for special keys like shift and alt
-   * @param[in]  cursorOffset  Used by the IMF keyboard and predictive text to specify a start position from the current cursor position to start deleting characters.
-   * @param[in]  numberOfChars Used by the IMF keyboard and predictive text to specify how many characters to delete from the cursorOffset.
-   * @param[in]  keyState The state of the key event.
-   */
-  KeyEvent(const std::string& keyName,
-           const std::string& keyString,
-           const int& keyCode,
-           const int& keyModifier,
-           const int& cursorOffset,
-           const int& numberOfChars,
-           const State& keyState);
-
-  /**
-   * Constructor
-   * @param[in]  keyName       The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
-   * @param[in]  keyString     A string of input characters or key pressed
-   * @param[in]  keyCode       The unique key code for the key pressed.
-   * @param[in]  keyModifier   The key modifier for special keys like shift and alt
-   * @param[in]  cursorOffset  Used by the IMF keyboard and predictive text to specify a start position from the current cursor position to start deleting characters.
-   * @param[in]  numberOfChars Used by the IMF keyboard and predictive text to specify how many characters to delete from the cursorOffset.
    * @param[in]  timeStamp The time (in ms) that the key event occurred.
    * @param[in]  keyState The state of the key event.
    */
   KeyEvent(const std::string& keyName,
            const std::string& keyString,
-           const int& keyCode,
-           const int& keyModifier,
-           const int& cursorOffset,
-           const int& numberOfChars,
-           const unsigned long& timeStamp,
+           int keyCode,
+           int keyModifier,
+           unsigned long timeStamp,
            const State& keyState);
 
   /**
@@ -137,16 +95,6 @@ struct KeyEvent : public Event
   int  keyModifier;
 
   /**
-   *@copydoc Dali::KeyEvent::cursorOffset
-   */
-  int cursorOffset;
-
-  /**
-   *@copydoc Dali::KeyEvent::numberOfChars
-   */
-  int numberOfChars;
-
-  /**
    *@copydoc Dali::KeyEvent::time
    */
   unsigned long time;
index d822c5c..6e819e1 100644 (file)
@@ -40,7 +40,7 @@ KeyEventProcessor::~KeyEventProcessor()
 
 void KeyEventProcessor::ProcessKeyEvent(const Integration::KeyEvent& event)
 {
-  KeyEvent keyEvent(event.keyName, event.keyString, event.keyCode, event.keyModifier, event.cursorOffset, event.numberOfChars, static_cast<KeyEvent::State>(event.state));
+  KeyEvent keyEvent(event.keyName, event.keyString, event.keyCode, event.keyModifier, event.time, static_cast<KeyEvent::State>(event.state));
 
   // Emit the key event signal from stage.
   mStage.EmitKeyEventSignal(keyEvent);
index 0a329a0..7c9bc0d 100644 (file)
@@ -34,43 +34,15 @@ KeyEvent::KeyEvent()
   keyPressed(""),
   keyCode(KEY_INVALID_CODE),
   keyModifier(0),
-  cursorOffset(0),
-  numberOfChars(0),
   state(KeyEvent::Down)
 {
 }
 
-KeyEvent::KeyEvent(const std::string& keyName, const std::string& keyPressed, const int& keyModifier, const int& offset, const int& characters, const State& keyState)
-: keyPressedName(keyName),
-  keyPressed(keyPressed),
-  keyCode(KEY_INVALID_CODE),
-  keyModifier(keyModifier),
-  cursorOffset(offset),
-  numberOfChars(characters),
-  time(0),
-  state(keyState)
-{
-}
-
-KeyEvent::KeyEvent(const std::string& keyName, const std::string& keyString, const int& keyCode, const int& keyModifier, const int& cursorOffset, const int& numberOfChars, const State& keyState)
-: keyPressedName(keyName),
-  keyPressed(keyString),
-  keyCode(keyCode),
-  keyModifier(keyModifier),
-  cursorOffset(cursorOffset),
-  numberOfChars(numberOfChars),
-  time(0),
-  state(keyState)
-{
-}
-
-KeyEvent::KeyEvent(const std::string& keyName, const std::string& keyString, const int& keyCode, const int& keyModifier, const int& cursorOffset, const int& numberOfChars, const unsigned long& timeStamp, const State& keyState)
+KeyEvent::KeyEvent(const std::string& keyName, const std::string& keyString, int keyCode, int keyModifier,unsigned long timeStamp, const State& keyState)
 : keyPressedName(keyName),
   keyPressed(keyString),
   keyCode(keyCode),
   keyModifier(keyModifier),
-  cursorOffset(cursorOffset),
-  numberOfChars(numberOfChars),
   time(timeStamp),
   state(keyState)
 {