base/dali-toolkit/public-api/focus-manager/keyinput-focus-manager.h

   1 #ifndef __DALI_TOOLKIT_KEYINPUT_FOCUS_MANAGER_H__
   2 #define __DALI_TOOLKIT_KEYINPUT_FOCUS_MANAGER_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali DALI_IMPORT_API
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class KeyInputFocusManager;
  33 }
  34
  35 /**
  36  * KeyInputFocusManager
  37  * This class provides the functionality of registering for keyboard events for controls.
  38  * The keyinput focus manager maintains a stack of controls, With the last added control receiving
  39  * all the keyboard events first. And if the conrol doesn't consume the event it is passed to
  40  * the next control in the stack. If none of the controls in the stack consume the key event then
  41  * UnhandledKeyEventSignal() is emitted.
  42  */
  43
  44  class KeyInputFocusManager : public BaseHandle
  45  {
  46  public:
  47   //Signal Names
  48   static const char* const SIGNAL_KEY_INPUT_FOCUS_CHANGED;
  49   static const char* const SIGNAL_UNHANDLED_KEY_EVENT;
  50
  51   // KeyInputFocusChanged
  52   typedef SignalV2< void (Control, Control) > KeyInputFocusChangedSignalV2;
  53
  54   // Unhandled Key Event
  55   typedef SignalV2< void (const KeyEvent&) > UnhandledKeyEventSignalV2;
  56
  57  public:
  58
  59   /**
  60    * Create a KeyInputFocusManager handle; this can be initialised with KeyInputFocusManager::Get()
  61    * Calling member functions with an uninitialised handle is not allowed.
  62    */
  63   KeyInputFocusManager();
  64
  65   /**
  66    * @brief Destructor
  67    *
  68    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  69    */
  70   ~KeyInputFocusManager();
  71
  72   /**
  73    * Get the singleton of KeyInputFocusManager object.
  74    * @return A handle to the KeyInputFocusManager control.
  75    */
  76   static KeyInputFocusManager Get();
  77
  78   /**
  79    * Sets keyboard focus for a control.
  80    * Note: A control can be set to be in focus and still not receive all the key events if another control has over ridden it.
  81    * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
  82    * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
  83    * controls above it in the focus stack.
  84    *
  85    * @pre The Control is not in the focus stack. If it is allready present in the top of the stack it results in a no-op, If it is
  86    * present in the stack but not on the top of the stack, then the control is moved to the top of the focus stack.
  87    * @param[in] control The Control to receive keyboard input
  88    */
  89   void SetFocus(Control control);
  90
  91   /**
  92    * Query for the control that is currently set to be on top of the fcous stack and receives all
  93    * keyboard input events first.
  94    * @return Pointer to the control set to receive keyboard inputs.
  95    */
  96   Control GetCurrentFocusControl() const;
  97
  98   /**
  99    * Removes focus for the given control, The control will no longer receive events from keyboard.
 100    * @param [in] control which should be removed from focus.
 101    */
 102   void RemoveFocus(Control control);
 103
 104   /**
 105    * Queries whether a control is currently part of the focus stack.
 106    * @param [in] control which should be queried.
 107    * @return True if it is part of the foucus stack False otherwise.
 108    */
 109   bool IsKeyboardListener(Control control);
 110
 111  public: // Signals
 112
 113   /**
 114    * This signal is emitted when the key input focus control changes.
 115    * Two control parameters are sent as part of this signal, the first being the signal that now has the focus, the second
 116    * being the one that has lost focus.
 117    * A callback of the following type may be connected:
 118    * @code
 119    *   void YourCallback(Control focusGainedControl, Control focusLostActor);
 120    * @endcode
 121    * @return The signal to connect to.
 122    */
 123   KeyInputFocusChangedSignalV2& KeyInputFocusChangedSignal();
 124
 125   /**
 126    * This signal is emitted when a key event was received, and none of the focused controls on the stage have consumed it.
 127    * A callback of the following type may be connected:
 128    * @code
 129    *   void YourCallbackName(const KeyEvent& event);
 130    * @endcode
 131    * @return The signal to connect to.
 132    */
 133   UnhandledKeyEventSignalV2& UnhandledKeyEventSignal();
 134
 135 private:
 136
 137   KeyInputFocusManager(Internal::KeyInputFocusManager *impl);
 138
 139 }; // class KeyInputFocusManager
 140
 141 } // namespace Toolkit
 142
 143 } // namespace Dali
 144
 145 #endif // __DALI_TOOLKIT_KEYINPUT_FOCUS_MANAGER_H__