src/ui/inc/FUiCtrl_SearchBarEvent.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 /**
  19  * @file                FUiCtrl_SearchBarEvent.h
  20  * @brief               This is the header file for _SearchBarEvent class.
  21  * @version             1.0
  22  *
  23  * This header file contains declaration of _SearchBarEvent class.
  24  * The SearchBarEvent class can call listener's method. So, when event occurred,
  25  * application can handle it appropriately.
  26  *
  27  */
  28 #ifndef _FUI_CTRL_INTERNAL_SEARCH_BAR_EVENT_H_
  29 #define _FUI_CTRL_INTERNAL_SEARCH_BAR_EVENT_H_
  30
  31 #include <FBaseResult.h>
  32 #include <FBaseRt_Event.h>
  33 #include <FOspConfig.h>
  34
  35 namespace Tizen { namespace Ui { namespace Controls
  36 {
  37
  38 class _SearchBar;
  39
  40 enum _SearchBarEventStatus
  41 {
  42         _SEARCH_BAR_EVENT_MODE_CHANGE = 0,
  43         _SEARCH_BAR_EVENT_CONTENT_AREA_RESIZE
  44 };
  45
  46 /**
  47 * @class        _SearchBarEvent
  48 * @brief        This class handles a action event. It is inherited from Event class.
  49 *
  50 * The Window(root of all widgets) class has an instance of the _SearchBarEvent class as a member variable.
  51 * Applications can register searchbar event listeners through it. When a searchbar event occurred,
  52 * the _SearchBarEvent class finds listener and calls the appropriate listener's method.
  53 *
  54 */
  55 class _SearchBarEvent
  56         : public Tizen::Base::Runtime::_Event
  57 {
  58 // Lifecycle
  59 public:
  60         /**
  61          * This is the default class destructor.
  62          *
  63          */
  64         virtual ~_SearchBarEvent(void);
  65
  66         static _SearchBarEvent* CreateInstanceN(const _SearchBar& source);
  67
  68 // Accessors
  69         /**
  70          * This method returns the owner of this event.
  71          *
  72          * @return              See the comment above.
  73          */
  74         const _SearchBar* GetSource(void) const;
  75
  76         static Tizen::Base::Runtime::IEventArg* CreateSearchBarEventArgN(_SearchBarEventStatus status);
  77
  78 // Operations
  79 protected:
  80         /**
  81          * This is the default class constructor.
  82          *
  83          * @remarks             After creating an instance of this class, you must explicitly call one of
  84          *                              construction methods to initialize the instance.
  85          *
  86          */
  87         _SearchBarEvent(const _SearchBar& source);
  88
  89         /**
  90          * This method checks the arg and finds out the type of event. After that this method calls appopriate
  91          * pListener's method.
  92          *
  93          * @param[in]   listener        It is a event listener related to this action event.
  94          * @param[in]   arg                     It is an argument-like instance of action event retransmitted to the listener's method
  95          *                                                      as an argument.
  96          * @exception   E_SUCCESS               - The method is successful.
  97          * @exception   E_ARG_NULL              - The listener is null.
  98          * @exception   E_INVALID_ARG   - The argument passed to a method contains an invalid value.@n
  99          *                                                                &nbsp;&nbsp;The pListener is not the instance of IActionEventListener class or
 100          *                                                                the p__SearchBarEventArg is not the instance of _SearchBarEventArg class.
 101          *
 102          */
 103         virtual void FireImpl(Tizen::Base::Runtime::IEventListener& listener, const Tizen::Base::Runtime::IEventArg& arg);
 104
 105 //Attributess
 106 private:
 107         const _SearchBar* __pSource;
 108
 109 }; // _SearchBarEvent
 110
 111 }}} // Tizen::Ui::Controls
 112
 113 #endif // _FUI_CTRL_INTERNAL_SEARCH_BAR_EVENT_H_