inc/FUiCtrlIEditTextFilter.h

   1 //\r
   2 // Open Service Platform\r
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.\r
   4 //\r
   5 // Licensed under the Apache License, Version 2.0 (the License);\r
   6 // you may not use this file except in compliance with the License.\r
   7 // You may obtain a copy of the License at\r
   8 //\r
   9 //     http://www.apache.org/licenses/LICENSE-2.0\r
  10 //\r
  11 // Unless required by applicable law or agreed to in writing, software\r
  12 // distributed under the License is distributed on an "AS IS" BASIS,\r
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  14 // See the License for the specific language governing permissions and\r
  15 // limitations under the License.\r
  16 //\r
  17 \r
  18 /**\r
  19  * @file        FUiCtrlIEditTextFilter.h\r
  20  * @brief       This is the header file for the %IEditTextFilter interface.\r
  21  *\r
  22  * This header file contains the declarations of the %IEditTextFilter interface.\r
  23  *\r
  24  */\r
  25 #ifndef _FUI_CTRL_IEDIT_TEXT_FILTER_H_\r
  26 #define _FUI_CTRL_IEDIT_TEXT_FILTER_H_\r
  27 \r
  28 #include <FOspConfig.h>\r
  29 \r
  30 namespace Tizen {namespace Ui { namespace Controls\r
  31 {\r
  32 \r
  33 /**\r
  34  * @interface   IEditTextFilter\r
  35  * @brief               This interface defines the text filter.\r
  36  *\r
  37  * @since               2.1\r
  38  *\r
  39  * The %IEditTextFilter interface is the listener interface for handling texts, for example, from EditFields.\r
  40  * The class that processes a text event implements this interface, and the instance created with that class is registered with a\r
  41  * UI control, using the control's SetEditTextFilter() method. \r
  42  *\r
  43  */\r
  44 \r
  45 class _OSP_EXPORT_ IEditTextFilter\r
  46 {\r
  47 public:\r
  48         /**\r
  49          * This polymorphic destructor should be overridden if required.\r
  50          * This way, the destructors of the derived classes are called\r
  51          * when the destructor of this interface is called.\r
  52          *\r
  53          * @since       2.1\r
  54          */\r
  55         virtual ~IEditTextFilter(void) {}\r
  56 \r
  57         /**\r
  58          * Checks whether the text to be pasted from the %Clipboard needs to be replaced by other text.\r
  59          *\r
  60          * @since       2.1\r
  61          *\r
  62          * @return      @c true if the pasted text needs to be replaced, @n\r
  63          *              else @c false\r
  64          * @param[in]           pastedText    The pasted text\r
  65          * @param[out]  replacedText    The user-defined replacement text\r
  66          */\r
  67         virtual bool ValidatePastedText(const Tizen::Base::String& pastedText, Tizen::Base::String& replacedText) = 0;\r
  68         \r
  69 protected:\r
  70         //\r
  71         // This method is for internal use only. Using this method can cause behavioral, security-related,\r
  72         // and consistency-related issues in the application.\r
  73         //\r
  74         // This method is reserved and may change its name at any time without\r
  75         // prior notice.\r
  76         //      \r
  77         virtual void IEditTextFilter_Reserved1(void) {}\r
  78 \r
  79         //\r
  80         // This method is for internal use only. Using this method can cause behavioral, security-related,
  81         // and consistency-related issues in the application.
  82         //
  83         // This method is reserved and may change its name at any time without
  84         // prior notice.
  85         //\r
  86         virtual void IEditTextFilter_Reserved2(void) {}\r
  87 \r
  88         //\r
  89         // This method is for internal use only. Using this method can cause behavioral, security-related,
  90         // and consistency-related issues in the application.
  91         //
  92         // This method is reserved and may change its name at any time without
  93         // prior notice.
  94         //\r
  95         virtual void IEditTextFilter_Reserved3(void) {}\r
  96 \r
  97         //\r
  98         // This method is for internal use only. Using this method can cause behavioral, security-related,\r
  99         // and consistency-related issues in the application.\r
 100         //\r
 101         // This method is reserved and may change its name at any time without\r
 102         // prior notice.\r
 103         //\r
 104         virtual void IEditTextFilter_Reserved4(void) {}\r
 105 \r
 106         //\r
 107         // This method is for internal use only. Using this method can cause behavioral, security-related,\r
 108         // and consistency-related issues in the application.\r
 109         //\r
 110         // This method is reserved and may change its name at any time without\r
 111         // prior notice.\r
 112         //\r
 113         virtual void IEditTextFilter_Reserved5(void) {}\r
 114 }; // IEditTextFilter\r
 115 \r
 116 }}} // Tizen::Ui::Controls\r
 117 \r
 118 #endif // _FUI_CTRL_IEDIT_TEXT_FILTER_H_\r
 119 \r