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