src/ui/inc/FUiCtrl_ISearchBarEventListener.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_ISearchBarEventListener.h
  20  * @brief               This is the header file for the _ISearchBarEventListener interface.
  21  *
  22  * This header file contains the declarations of the _ISearchBarEventListener
  23  * interface.
  24  */
  25 #ifndef _FUI_CTRL_INTERNAL_ISEARCH_BAR_EVENT_LISTENER_H_
  26 #define _FUI_CTRL_INTERNAL_ISEARCH_BAR_EVENT_LISTENER_H_
  27
  28 // incluses
  29 #include <FBaseRtIEventListener.h>
  30 #include <FUiCtrlSearchBar.h>
  31
  32 namespace Tizen {namespace Ui { namespace Controls
  33 {
  34
  35 class _SearchBar;
  36
  37 /**
  38  * @interface   _ISearchBarEventListener
  39  * @brief           This interface implements the listener for SearchBar events.
  40  * @since           2.0
  41  *
  42  * The _ISearchBarEventListener interface enables the implementer to receive the
  43  * SearchBar events.
  44  */
  45 class _ISearchBarEventListener
  46         : virtual public Tizen::Base::Runtime::IEventListener
  47 {
  48 // Lifecycle
  49 public:
  50         /**
  51          * This is the destructor for this class.
  52          *
  53          * @since       2.0
  54          */
  55         virtual ~_ISearchBarEventListener(void) {}
  56
  57
  58 // Operation
  59 public:
  60         /**
  61          * Notifies that the mode of the SearchBar is changed.
  62          *
  63          * @since               2.0
  64          * @param[in]   source  The source of the event
  65          * @param[in]   mode    The current search bar mode.
  66          */
  67         virtual void OnSearchBarModeChanged(Tizen::Ui::Controls::_SearchBar& source, SearchBarMode mode) = 0;
  68
  69 }; // _ISearchBarEventListener
  70
  71 }}} // Tizen::Ui::Controls
  72
  73 #endif // _FUI_CTRL_INTERNAL_ISEARCH_BAR_EVENT_LISTENER_H_