dali/devel-api/common/stage-devel.h

   1 #ifndef DALI_STAGE_DEVEL_H
   2 #define DALI_STAGE_DEVEL_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/public-api/common/stage.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace DevelStage
  28 {
  29
  30 typedef Signal< bool (const KeyEvent&) > KeyEventGeneratedSignalType;      ///< Stage key event generated signal type
  31
  32 /**
  33  * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
  34  *
  35  * @param[in] stage The stage to emit a signal
  36  * @return The return is true if KeyEvent is consumed, otherwise false.
  37  */
  38 DALI_CORE_API KeyEventGeneratedSignalType& KeyEventGeneratedSignal( Dali::Stage stage );
  39
  40 } // namespace DevelStage
  41
  42 } // namespace Dali
  43
  44 #endif // DALI_STAGE_DEVEL_H