dali/internal/event/events/key-event-processor.h

   1 #ifndef DALI_INTERNAL_KEY_EVENT_PROCESSOR_H
   2 #define DALI_INTERNAL_KEY_EVENT_PROCESSOR_H
   3
   4 /*
   5  * Copyright (c) 2021 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 #include <vector>
  22
  23 namespace Dali
  24 {
  25 namespace Integration
  26 {
  27 struct KeyEvent;
  28 }
  29
  30 namespace Internal
  31 {
  32 class Scene;
  33 class Stage;
  34
  35 /**
  36  *  KeyEventProcessor receives the filtered key events from the Dali Event processor.
  37  *
  38  *  When a key event is received the KeyEventProcessor queues the event in the scene events queue.
  39  *  Any actor can be set by the actor api to be the focus of key events.  The actor is then sent the key event.
  40  *  If no actor is set for focus then the key event is discarded.
  41  */
  42 class KeyEventProcessor
  43 {
  44 public:
  45   /**
  46    * Create a Key event processor.
  47    * @param[in] scene The scene the event processor belongs to.
  48    */
  49   KeyEventProcessor(Scene& scene);
  50
  51   /**
  52    * Non-virtual destructor; KeyEventProcessor is not a base class
  53    */
  54   ~KeyEventProcessor();
  55
  56   /**
  57    * This function is called by the event processor whenever a key event occurs.
  58    * @param[in] event The key event that has occurred.
  59    */
  60   void ProcessKeyEvent(const Integration::KeyEvent& event);
  61
  62 private:
  63   // Undefined
  64   KeyEventProcessor(const KeyEventProcessor&);
  65
  66   // Undefined
  67   KeyEventProcessor& operator=(const KeyEventProcessor& rhs);
  68
  69 private:
  70   Scene& mScene; ///< Used to deliver key events
  71 };
  72
  73 } // namespace Internal
  74
  75 } // namespace Dali
  76
  77 #endif // DALI_INTERNAL_KEY_EVENT_PROCESSOR_H