src/ui/inc/FUi_UiNotificationEvent.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://floralicense.org/license/
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an AS IS BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 /**
  18  * @file        FUi_UiNotificationEvent.h
  19  * @brief       This is the header file for the _UiNotificationEvent class.
  20  *
  21  * This header file contains the declarations of the %_UiNotificationEvent class.
  22  */
  23
  24 #ifndef _FUI_INTERNAL_UI_NOTIFICATION_EVENT_H_
  25 #define _FUI_INTERNAL_UI_NOTIFICATION_EVENT_H_
  26
  27 #include "FUi_UiEvent.h"
  28
  29 namespace Tizen { namespace Base { namespace Collection
  30 {
  31 class IList;
  32 }}} // Tizen::Base::Collection
  33
  34 namespace Tizen {namespace Ui
  35 {
  36
  37 class _INotificationEventListener;
  38
  39 /**
  40 * This is internal. If used in an application, the application can get rejected during the certification process.
  41 * @class        _UiNotificationEvent
  42 * @brief        This class impliments _UiNotificationEvent and
  43 * fire the Window Event object of a Ui Control.
  44 */
  45 class _OSP_EXPORT_ _UiNotificationEvent
  46         : public _UiEvent
  47 {
  48 // Lifecycle
  49 public:
  50         /**
  51         * This is the default class constructor.
  52         *
  53         */
  54         _UiNotificationEvent(const _UiObjectHandle& destination, Tizen::Base::Collection::IList* pArgs, _UiEventRouteType routeType = _UI_EVENT_ROUTE_TUNNEL_BUBBLE, const _UiObjectHandle& source = _UiObjectHandle());
  55         _UiNotificationEvent(const _UiNotificationEvent& rhs);
  56
  57         /**
  58          * This is the default class destructor.
  59          *
  60          */
  61         virtual ~_UiNotificationEvent(void);
  62
  63 public:
  64         _UiNotificationEvent& operator =(const _UiNotificationEvent& rhs);
  65
  66 public:
  67         Tizen::Base::Collection::IList* GetArgs(void) const;
  68
  69 private:
  70         virtual _UiNotificationEvent* CloneN(void) const;
  71         virtual _UiEventType GetEventType(void) const;
  72         virtual bool IsEventReceivable(const _Control& control) const;
  73         virtual result OnPreviewEventProcessing(const _Control& control, bool& isFiltered);
  74         virtual result OnEventProcessing(const _Control& control, bool& isFiltered);
  75         virtual result OnListenerProcessing(const _IUiEventListener& listener, bool& isFiltered);
  76
  77 private:
  78         result FireListener(const _INotificationEventListener* pListener, bool& isFiltered);
  79
  80 private:
  81         Tizen::Base::Collection::IList* __pArgs;
  82 };
  83
  84 }} // Tizen::Ui
  85
  86 #endif //_FUI_INTERNAL_UI_NOTIFICATION_EVENT_H_