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