src/ui/inc/FUiCtrl_TextBlockEvent.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_TextBlockEvent.h
  20 * @brief                This is the header file for _TextBlockEvent class.
  21 *
  22 * This header file contains declaration of _TextBlockEvent class.
  23 *
  24 */
  25
  26 #ifndef _FUI_CTRL_TEXT_BLOCK_EVENT_H_
  27 #define _FUI_CTRL_TEXT_BLOCK_EVENT_H_
  28
  29 #include <FBaseResult.h>
  30 #include <FBaseRt_Event.h>
  31 #include <FOspConfig.h>
  32 #include <FUiControl.h>
  33
  34 namespace Tizen { namespace Ui
  35 {
  36 class _Control;
  37 }} // Tizen::Ui
  38
  39 namespace Tizen { namespace Ui { namespace Controls
  40 {
  41 /**
  42 * @class        _TextBlockEvent
  43 * @brief        This class handles a text Block event event. It is inherited from Event class.
  44 *
  45 */
  46 class _TextBlockEvent
  47         : public Tizen::Base::Runtime::_Event
  48 {
  49 // Lifecycle
  50 public:
  51         /**
  52         * This is the default class destructor.
  53         *
  54         */
  55         virtual ~_TextBlockEvent(void);
  56
  57         static _TextBlockEvent* CreateInstanceN(const Tizen::Ui::_Control& source);
  58
  59 // Accessors
  60 public:
  61         /**
  62         * This method returns the owner of this event.
  63         *
  64         * @return               See the comment above.
  65         */
  66         const Tizen::Ui::_Control* GetSource(void) const;
  67
  68         // Operations
  69 protected:
  70         /**
  71         * This is the default class constructor.
  72         *
  73         * @remarks              After creating an instance of this class, you must explicitly call one of
  74         *                               construction methods to initialize the instance.
  75         *
  76         */
  77         _TextBlockEvent(const Tizen::Ui::_Control& source);
  78
  79         /**
  80         * This method checks the arg and finds out the type of event. After that this method calls appopriate
  81         * pListener's method.
  82         *
  83         * @param[in]    listener        It is a event listener related to this item event.
  84         * @param[in]    arg                     It is an argument-like instance of item event retransmitted to the listener's method
  85         *                                                       as an argument.
  86         * @exception    E_SUCCESS               - The method is successful.
  87         * @exception    E_ARG_NULL              - The listener is null.
  88         * @exception    E_INVALID_ARG   - The argument passed to a method contains an invalid value.@n
  89         *                                                                 &nbsp;&nbsp;The pListener is not the instance of IItemEventListener class or
  90         *                                                                 the pItemEventArg is not the instance of _CustomItemEventArg class.
  91         *
  92         */
  93         virtual void FireImpl(Tizen::Base::Runtime::IEventListener& listener, const Tizen::Base::Runtime::IEventArg& arg);
  94
  95 public:
  96         static Tizen::Base::Runtime::IEventArg* CreateTextBlockEventArgN(int start, int end);
  97
  98         //Attributess
  99 private:
 100         const Tizen::Ui::_Control* __pSource;
 101 }; // _TextBlockEvent
 102
 103 }}} // Tizen::Ui::Controls
 104
 105 #endif  //_FUI_CTRL_TEXT_BLOCK_EVENT_H_