src/ui/inc/FUiCtrl_ITextBlockEventListener.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                FUiCtrl_ITextBlockEventListener.h
  19  * @brief               This is the header file for the _ITextBlockEventListener interface.
  20  *
  21  * This header file contains the declarations of the _ITextBlockEventListener interface.
  22  */
  23 #ifndef _FUI_CTRL_INTERNAL_ITEXT_BLOCK_EVENT_LISTENER_H_
  24 #define _FUI_CTRL_INTERNAL_ITEXT_BLOCK_EVENT_LISTENER_H_
  25
  26 // Includes
  27 #include <FBaseRtIEventListener.h>
  28
  29 // forward declaration
  30 namespace Tizen { namespace Ui
  31 {
  32 class _Control;
  33 }} // Tizen::Ui
  34
  35 // namespace declaration
  36 namespace Tizen { namespace Ui { namespace Controls
  37 {
  38 /**
  39  * @interface   ITextBlockEventListener
  40  * @brief           This interface implements the listener for text block events.
  41  * @since           2.0
  42  *
  43  * The ITextBlockEventListener interface enables the implementer to receive the
  44  * text block selection event.
  45  */
  46 class _ITextBlockEventListener
  47         : virtual public Tizen::Base::Runtime::IEventListener
  48 {
  49 // Lifecycle
  50 public:
  51         /**
  52          * This is the destructor for this class.
  53          * @since               2.0
  54          */
  55         virtual ~_ITextBlockEventListener(void) {}
  56
  57
  58 // Operation
  59 public:
  60         /**
  61          * Notifies that a text block is selected.
  62          * @since               2.0
  63          *
  64          * @param[in]   source  The source of the event
  65          * @param[in]   start   The starting index of the selected text block.
  66          * @param[in]   end     The end index of the selected text block.
  67          */
  68         virtual void OnTextBlockSelected(Tizen::Ui::_Control& source, int start, int end) = 0;
  69
  70 }; // _ITextBlockEventListener
  71
  72 }}} // Tizen::Ui::Controls
  73
  74 #endif // _FUI_CTRL_INTERNAL_ITEXT_BLOCK_EVENT_LISTENER_H_