inc/FUiCtrlIExpandableEditAreaEventListener.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        FUiCtrlIExpandableEditAreaEventListener.h
  19  * @brief       This is the header file for the %IExpandableEditAreaEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IExpandableEditAreaEventListener interface.
  22  */
  23 #ifndef _FUI_CTRL_IEXPANDABLE_EDIT_AREA_EVENT_LISTENER_H_
  24 #define _FUI_CTRL_IEXPANDABLE_EDIT_AREA_EVENT_LISTENER_H_
  25
  26 // includes
  27 #include <FBaseRtIEventListener.h>
  28 #include <FUiCtrlExpandableEditArea.h>
  29
  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  IExpandableEditAreaEventListener
  40   * @brief          This interface defines a listener for the %ExpandableEditArea events.
  41   *
  42   * @since          2.0
  43   *
  44   * The %IExpandableEditAreaEventListener interface is the listener interface for receiving %ExpandableEditArea events. @n
  45   *
  46   * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_exp_editarea.htm">ExpandableEditArea</a>.
  47   *
  48   */
  49 class _OSP_EXPORT_ IExpandableEditAreaEventListener
  50         : public Tizen::Base::Runtime::IEventListener
  51 {
  52
  53 // Lifecycle
  54 public:
  55         /**
  56          * This is the destructor for this class.
  57          *
  58          * @since        2.0
  59          */
  60         virtual ~IExpandableEditAreaEventListener(void) {}
  61
  62
  63 // Operations
  64 public:
  65         /**
  66          * Called when a new line is added to ExpandableEditArea.
  67          *
  68          * @since       2.0
  69          *
  70          * @param[in]   source          The source of the event
  71          * @param[in]   newLineCount    The new line count
  72          */
  73         virtual void OnExpandableEditAreaLineAdded(Tizen::Ui::Controls::ExpandableEditArea& source, int newLineCount) = 0;
  74
  75         /**
  76          * Called when a line is removed from ExpandableEditArea.
  77          *
  78          * @since       2.0
  79          *
  80          * @param[in]   source          The source of the event
  81          * @param[in]   newLineCount    The new line count
  82          */
  83         virtual void OnExpandableEditAreaLineRemoved(Tizen::Ui::Controls::ExpandableEditArea& source, int newLineCount) = 0;
  84
  85
  86 // Reserves
  87 protected:
  88         //
  89         // This method is for internal use only.
  90         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  91         //
  92         //       This method is reserved and may change its name at any time without prior notice.
  93         //
  94         //       @since      2.0
  95         //
  96         virtual void IExpandableEditAreaEventListener_Reserved1(void) { }
  97
  98         //
  99         // This method is for internal use only.
 100         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 101         //
 102         //       This method is reserved and may change its name at any time without prior notice.
 103         //
 104         //       @since      2.0
 105         //
 106         virtual void IExpandableEditAreaEventListener_Reserved2(void) { }
 107
 108         //
 109         // This method is for internal use only.
 110         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 111         //
 112         //       This method is reserved and may change its name at any time without prior notice.
 113         //
 114         //       @since      2.0
 115         //
 116         virtual void IExpandableEditAreaEventListener_Reserved3(void) { }
 117 };  // IExpandableEditAreaEventListener
 118
 119 }}} // Tizen::Ui::Controls
 120
 121 #endif //_FUI_CTRL_IEXPANDABLE_EDIT_AREA_EVENT_LISTENER_H_