inc/FWebCtrlITextSearchListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 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                FWebCtrlITextSearchListener.h
  20  * @brief               This is the header file for the %ITextSearchListener interface.
  21  *
  22  * This header file contains the declarations of the %ITextSearchListener interface.
  23  */
  24 #ifndef _FWEB_CTRL_ITEXT_SEARCH_LISTENER_H_
  25 #define _FWEB_CTRL_ITEXT_SEARCH_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28
  29 namespace Tizen { namespace Web { namespace Controls
  30 {
  31
  32 /**
  33  * @interface   ITextSearchListener
  34  * @brief               This interface is for receiving the result of the search operation made by asynchronous methods.
  35  *
  36  * @since               2.0
  37  *
  38  * The %ITextSearchListener interface receives the result of the search operation made by asynchronous methods.
  39  */
  40 class _OSP_EXPORT_ ITextSearchListener
  41              : public virtual Tizen::Base::Runtime::IEventListener
  42
  43 {
  44
  45 public:
  46
  47         /**
  48          * This polymorphic destructor should be overridden if required. @n
  49          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  50          *
  51          * @since               2.0
  52          */
  53         virtual ~ITextSearchListener(void) {}
  54
  55         /**
  56          * Called when the text is found.
  57          *
  58          * @since               2.0
  59          *
  60          * @param[in]   totalCount              The total count of the matches
  61          * @param[in]   currentOrdinal  The ordinal of the currently selected match @n
  62          *                                                              If there is no match, it is set to zero.
  63          */
  64         virtual void OnTextFound(int totalCount, int currentOrdinal) = 0;
  65
  66 protected:
  67
  68         //
  69         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  70         //
  71         // Gets the Impl instance.
  72         //
  73         // @since               2.0
  74         //
  75         virtual void ITextSearchListener_Reserved1(void) {};
  76
  77         //
  78         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  79         //
  80         // Gets the Impl instance.
  81         //
  82         // @since               2.0
  83         //
  84         virtual void ITextSearchListener_Reserved2(void) {};
  85 };
  86
  87 }}} // Tizen::Web::Controls
  88 #endif // _FWEB_CTRL_ITEXT_SEARCH_LISTENER_H_