inc/FUiCtrlITokenFilter.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 /**
  19  * @file                FUiCtrlITokenFilter.h
  20  * @brief               This is the header file for the %ITokenFilter interface.
  21  *
  22  * This header file contains the declarations of the %ITokenFilter interface.
  23  */
  24 #ifndef _FUI_CTRL_ITOKEN_FILTER_H_
  25 #define _FUI_CTRL_ITOKEN_FILTER_H_
  26
  27 // includes
  28 #include <FBaseRtIEventListener.h>
  29
  30 // namespace declaration
  31 namespace Tizen { namespace Ui { namespace Controls
  32 {
  33 /**
  34  * @interface   ITokenFilter
  35  * @brief               This interface defines the token filter.
  36  *
  37  * @since   2.0
  38  *
  39  * The %ITokenFilter interface is the listener interface for replacing tokenized input in the ExpandableEditArea.
  40  *
  41  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/implementing_exp_editarea.htm">ExpandableEditArea</a>.
  42  *
  43  */
  44 class _OSP_EXPORT_ ITokenFilter
  45 {
  46 // Lifecycle
  47 public:
  48         /**
  49          * This is the destructor for this class.
  50          * @since  2.0
  51          */
  52         virtual ~ITokenFilter(void) {}
  53
  54 // Operation
  55 public:
  56         /**
  57          * Checks whether the text tokenized by the ExpandableEditArea instance must be replaced.
  58          *
  59          * @since       2.0
  60          *
  61          * @return      @c true if the text of the current token needs to be replaced, @n
  62          *              else @c false
  63          * @param[in]   token       The text of the current token
  64          * @param[out]  replacement     The user-defined replacement text
  65          */
  66         virtual bool ReplaceToken(const Tizen::Base::String& token, Tizen::Base::String& replacement) = 0;
  67
  68
  69 // Reserves
  70 protected:
  71         //
  72         // This method is for internal use only. Using this method can cause behavioral, security-related,
  73         // and consistency-related issues in the application.
  74         //
  75         // This method is reserved and may change its name at any time without
  76         // prior notice.
  77         //
  78         // @since      2.0
  79         //
  80         virtual void ITokenFilter_Reserved1(void) { }
  81
  82         //
  83         // This method is for internal use only. Using this method can cause behavioral, security-related,
  84         // and consistency-related issues in the application.
  85         //
  86         // This method is reserved and may change its name at any time without
  87         // prior notice.
  88         //
  89         // @since      2.0
  90         //
  91         virtual void ITokenFilter_Reserved2(void) { }
  92
  93         //
  94         // This method is for internal use only. Using this method can cause behavioral, security-related,
  95         // and consistency-related issues in the application.
  96         //
  97         // This method is reserved and may change its name at any time without
  98         // prior notice.
  99         //
 100         // @since      2.0
 101         //
 102         virtual void ITokenFilter_Reserved3(void) { }
 103 }; // ITokenFilter
 104
 105 }}}      //Tizen::Ui::Controls
 106 #endif //_FUI_CTRL_ITOKEN_FILTER_H_