src/ui/inc/FUiCtrl_ExpandableEditAreaEvent.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
  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_ExpandableEditAreaEvent.h
  19  * @brief               This is the header file for _ExpandableEditAreaEvent class.
  20  *
  21  * This header file contains declaration of _ExpandableEditAreaEvent class.
  22  */
  23 #ifndef _FUICTRL_EXPANDABLE_EDITAREA_EVENT_H_
  24 #define _FUICTRL_EXPANDABLE_EDITAREA_EVENT_H_
  25
  26 #include <FBaseResult.h>
  27 #include <FBaseRt_Event.h>
  28 #include <FOspConfig.h>
  29
  30 namespace Tizen { namespace Ui
  31 {
  32 class _Control;
  33 } } // Tizen::Ui
  34
  35 namespace Tizen { namespace Ui { namespace Controls
  36 {
  37
  38 enum _ExpandableEditAreaEventStatus
  39 {
  40         _EXPANDABLE_EDITAREA_EVENT_ADDED = 0,
  41         _EXPANDABLE_EDITAREA_EVENT_REMOVED
  42 };
  43
  44 /**
  45 * @class        _ExpandableEditAreaEvent
  46 * @brief        This class handles a action event. It is inherited from Event class.
  47 *
  48 * The Window(root of all widgets) class has an instance of the _ExpandableEditAreaEvent class as a member variable.
  49 *
  50 */
  51 class _ExpandableEditAreaEvent
  52         : public Tizen::Base::Runtime::_Event
  53 {
  54 // Lifecycle
  55 public:
  56         /**
  57          * This is the default class destructor.
  58          *
  59          */
  60         virtual ~_ExpandableEditAreaEvent(void);
  61
  62         static _ExpandableEditAreaEvent* CreateInstanceN(const Tizen::Ui::_Control& source);
  63
  64 // Accessors
  65
  66         /**
  67          * This method returns the owner of this event.
  68          *
  69          * @return              See the comment above.
  70          */
  71         const Tizen::Ui::_Control* GetSource(void) const;
  72
  73     static Tizen::Base::Runtime::IEventArg* CreateExpandableEditAreaEventArgN(_ExpandableEditAreaEventStatus status, int newLineCount);
  74
  75 // Operations
  76 protected:
  77         /**
  78          * This is the default class constructor.
  79          *
  80          * @remarks             After creating an instance of this class, you must explicitly call one of
  81          *                              construction methods to initialize the instance.
  82          *
  83          */
  84         _ExpandableEditAreaEvent(const Tizen::Ui::_Control& source);
  85
  86         /**
  87          * This method checks the arg and finds out the type of event. After that this method calls appopriate
  88          * pListener's method.
  89          *
  90          * @param[in]   listener        It is a event listener related to this action event.
  91          * @param[in]   arg                     It is an argument-like instance of action event retransmitted to the listener's method
  92          *                                                      as an argument.
  93          * @exception   E_SUCCESS               - The method is successful.
  94          * @exception   E_ARG_NULL              - The listener is null.
  95          * @exception   E_INVALID_ARG   - The argument passed to a method contains an invalid value.@n
  96          *                                                                &nbsp;&nbsp;The pListener is not the instance of IActionEventListener class or
  97          *                                                                the p__ActionEventArg is not the instance of _ActionEventArg class.
  98          *
  99          */
 100         virtual void FireImpl(Tizen::Base::Runtime::IEventListener& listener, const Tizen::Base::Runtime::IEventArg& arg);
 101
 102 //Attributess
 103 private:
 104         const Tizen::Ui::_Control* __pSource;
 105 };      // _ExpandableEditAreaEvent
 106
 107 }}} // Tizen::Ui::Controls
 108
 109 #endif // _FUICTRL_EXPANDABLE_EDITAREA_EVENT_H_