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