inc/FUiILanguageEventListener.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        FUiILanguageEventListener.h
  19  * @brief       This is the header file for the %ILanguageEventListener interface.
  20  *
  21  * This header file contains the declarations of the %ILanguageEventListener interface.
  22  */
  23
  24 #ifndef _FUI_ILANGUAGE_EVENT_LISTENER_H_
  25 #define _FUI_ILANGUAGE_EVENT_LISTENER_H_
  26
  27 #include <FBaseRtIEventListener.h>
  28 #include <FLclLocale.h>
  29
  30 namespace Tizen {namespace Ui
  31 {
  32
  33 class Control;
  34
  35 /**
  36  * @interface  ILanguageEventListener
  37  * @brief      This interface implements the listener for the language event.
  38  *
  39  * @since               2.0
  40  *
  41  * The %ILanguageEventListener interface receives language events. The class that processes a language event
  42  * implements this interface, and the instance created with that class is registered with a UI control, using the control's
  43  * AddLanguageEventListener() method.
  44  *
  45  * When the current input language is changed (for example, when the user toggles the input language from the virtual
  46  * keypad), the listener's OnLanguageChanged() method is invoked.
  47  */
  48
  49 class _OSP_EXPORT_ ILanguageEventListener
  50         : public Tizen::Base::Runtime::IEventListener
  51 {
  52
  53 // Operation
  54
  55 public:
  56         /**
  57          * This is the default constructor for this class.
  58          *
  59          * @since                               2.0
  60          */
  61         ILanguageEventListener(void) {};
  62
  63         /**
  64          * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  65          *
  66          * @since                               2.0
  67          */
  68         virtual ~ILanguageEventListener(void) {}
  69
  70         /**
  71          * Called when the input language is changed.
  72          *
  73          * @since               2.0
  74          *
  75          * @param[in]   source              The source of the event
  76          * @param[in]   oldLanguage    The previous input language
  77          * @param[in]   newLanguage     The current input language
  78          */
  79         virtual void OnLanguageChanged(const Tizen::Ui::Control& source, Tizen::Locales::LanguageCode oldLanguage, Tizen::Locales::LanguageCode newLanguage) = 0;
  80
  81 // Reserves
  82 protected:
  83         //
  84         // This method is for internal use only. Using this method can cause behavioral,
  85         // security-related, and consistency-related issues in the application.
  86         //
  87         // This method is reserved and may change its name at any time without prior notice.
  88         //
  89         virtual void ILanguageEventListener_Reserved1(void) { }
  90
  91         //
  92         // This method is for internal use only. Using this method can cause behavioral,
  93         // 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         virtual void ILanguageEventListener_Reserved2(void) { }
  98
  99         //
 100         // This method is for internal use only. Using this method can cause behavioral,
 101         // security-related, and consistency-related issues in the application.
 102         //
 103         // This method is reserved and may change its name at any time without prior notice.
 104         //
 105         virtual void ILanguageEventListener_Reserved3(void) { }
 106 }; // ILanguageEventListener
 107
 108 }} // Tizen::Ui
 109
 110 #endif