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