inc/FAppIAppControlEventListener.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @if OSPDEPREC
  19  * @file                FAppIAppControlEventListener.h
  20  * @brief               This is the header file for the %IAppControlEventListener interface.
  21  *
  22  * This header file contains the declarations of the %IAppControlEventListener interface.
  23  * @endif
  24  */
  25
  26 #ifndef _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_
  27 #define _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_
  28
  29 #include <FBaseRtIEventListener.h>
  30
  31 namespace Tizen { namespace Base { class String; } }
  32 namespace Tizen { namespace Base { namespace Collection { class IList; } } }
  33
  34 namespace Tizen { namespace App
  35 {
  36
  37 /**
  38 * @if OSPDEPREC
  39 * @interface    IAppControlEventListener
  40 * @brief                <i>[Deprecated]</i> This interface defines a listener for the %AppControl result events.
  41 *
  42 * @deprecated   This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
  43 * @since        2.0
  44 *
  45 * The %IAppControlEventListener interface defines a listener for the AppControl result events.
  46 * @endif
  47 */
  48 class _OSP_EXPORT_ IAppControlEventListener
  49         : virtual public Tizen::Base::Runtime::IEventListener
  50 {
  51 public:
  52         /**
  53          * @if OSPDEPREC
  54          * This polymorphic destructor should be overridden if required. @n
  55          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  56          *
  57          * @brief       <i> [Deprecated] </i>
  58          *
  59          * @deprecated  This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
  60          * @since       2.0
  61          * @endif
  62          */
  63         virtual ~IAppControlEventListener(void) {}
  64
  65         /**
  66          * @if OSPDEPREC
  67          * Called when the application control is completed. @n
  68          * The client can get the callback result for some application controls by implementing this listener. @n
  69          * The %OnAppControlCompleted() method is called after AppControl::Start() is done listening to application controls.
  70          *
  71          * @brief       <i> [Deprecated] </i>
  72          *
  73          * @deprecated  This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
  74          * @since       2.0
  75          *
  76          * @param[in]   providerId              The provider ID
  77          * @param[in]   operationId             The operation ID used for application control invocation
  78          * @param[in]   pResultList             The list of callback strings for application control
  79          *
  80          * @remarks
  81          *                              - The specified @c pResultList provides the result code for the first array element.
  82          *                              - When the invoked application control is terminated without sending a result,
  83          *                              then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED.
  84          *                              - Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form
  85          *                              (UiApp::OnForeground()). @n If the %UiApp::OnForeground() method is being used in the application logic, it is recommended to avoid switching forms in this listener.
  86          * @see         Tizen::App::AppControl
  87          * @endif
  88          */
  89         virtual void OnAppControlCompleted(const Tizen::Base::String& providerId, const Tizen::Base::String& operationId, const Tizen::Base::Collection::IList* pResultList) = 0;
  90
  91 protected:
  92         //
  93         // This method is for internal use only.
  94         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  95         //
  96         // This method is reserved and may change its name at any time without prior notice.
  97         //
  98         // @since       2.0
  99         //
 100         virtual void IAppControlEventListener_Reserved1(void) {}
 101
 102         //
 103         // This method is for internal use only.
 104         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 105         //
 106         // This method is reserved and may change its name at any time without prior notice.
 107         //
 108         // @since       2.0
 109         //
 110         virtual void IAppControlEventListener_Reserved2(void) {}
 111
 112         //
 113         // This method is for internal use only.
 114         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 115         //
 116         // This method is reserved and may change its name at any time without prior notice.
 117         //
 118         // @since       2.0
 119         //
 120         virtual void IAppControlEventListener_Reserved3(void) {}
 121 }; // IAppControlEventListener
 122
 123 } } // Tizen::App
 124
 125 #endif // _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_