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