dali-toolkit/devel-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) 2018 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
  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  * Signals
  44  * | %Signal Name         | Method                            |
  45  * |----------------------|-----------------------------------|
  46  * | keyInputFocusChanged | @ref KeyInputFocusChangedSignal() |
  47  */
  48 class DALI_TOOLKIT_API KeyInputFocusManager : public BaseHandle
  49 {
  50 public:
  51
  52   // KeyInputFocusChanged
  53   typedef Signal< void (Control, Control) > KeyInputFocusChangedSignalType;
  54
  55 public:
  56
  57   /**
  58    * Create a KeyInputFocusManager handle; this can be initialised with KeyInputFocusManager::Get()
  59    * Calling member functions with an uninitialised handle is not allowed.
  60    */
  61   KeyInputFocusManager();
  62
  63   /**
  64    * @brief Destructor
  65    *
  66    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  67    */
  68   ~KeyInputFocusManager();
  69
  70   /**
  71    * Get the singleton of KeyInputFocusManager object.
  72    * @return A handle to the KeyInputFocusManager control.
  73    */
  74   static KeyInputFocusManager Get();
  75
  76   /**
  77    * Sets keyboard focus for a control.
  78    * 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.
  79    * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
  80    * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
  81    * controls above it in the focus stack.
  82    *
  83    * @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
  84    * present in the stack but not on the top of the stack, then the control is moved to the top of the focus stack.
  85    * @param[in] control The Control to receive keyboard input
  86    */
  87   void SetFocus(Control control);
  88
  89   /**
  90    * Query for the control that is currently set to be on top of the fcous stack and receives all
  91    * keyboard input events first.
  92    * @return Pointer to the control set to receive keyboard inputs.
  93    */
  94   Control GetCurrentFocusControl() const;
  95
  96   /**
  97    * Removes focus for the given control, The control will no longer receive events from keyboard.
  98    * @param [in] control which should be removed from focus.
  99    */
 100   void RemoveFocus(Control control);
 101
 102 public: // Signals
 103
 104   /**
 105    * This signal is emitted when the key input focus control changes.
 106    * Two control parameters are sent as part of this signal, the first being the signal that now has the focus, the second
 107    * being the one that has lost focus.
 108    * A callback of the following type may be connected:
 109    * @code
 110    *   void YourCallback(Control focusGainedControl, Control focusLostActor);
 111    * @endcode
 112    * @return The signal to connect to.
 113    */
 114   KeyInputFocusChangedSignalType& KeyInputFocusChangedSignal();
 115
 116 private:
 117
 118   explicit DALI_INTERNAL KeyInputFocusManager(Internal::KeyInputFocusManager *impl);
 119
 120 }; // class KeyInputFocusManager
 121
 122 } // namespace Toolkit
 123
 124 } // namespace Dali
 125
 126 #endif // __DALI_TOOLKIT_KEYINPUT_FOCUS_MANAGER_H__