2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
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
9 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 * @file FAppIAppControlEventListener.h
20 * @brief This is the header file for the %IAppControlEventListener interface.
22 * This header file contains the declarations of the %IAppControlEventListener interface.
25 #ifndef _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_
26 #define _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_
28 #include <FBaseRtIEventListener.h>
30 namespace Tizen { namespace Base { class String; } }
31 namespace Tizen { namespace Base { namespace Collection { class IList; } } }
33 namespace Tizen { namespace App
38 * @interface IAppControlEventListener
39 * @brief <i>[Deprecated]</i> This interface defines a listener for the AppControl result events.
41 * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
44 * The %IAppControlEventListener interface defines a listener for the AppControl result events.
47 class _OSP_EXPORT_ IAppControlEventListener
48 : virtual public Tizen::Base::Runtime::IEventListener
53 * This polymorphic destructor should be overridden if required.
54 * This way, the destructors of the derived classes are called when the destructor of this interface is called.
56 * @brief <i> [Deprecated] </i>
58 * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
62 virtual ~IAppControlEventListener(void) {}
66 * Called when the application control is completed. @n
67 * The client can get callback result for some application controls by implementing this listener. @n
68 * %OnAppControlCompleted() is called after AppControl::Start() with listener for some application controls.
70 * @brief <i> [Deprecated] </i>
72 * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface.
75 * @param[in] providerId The provider ID
76 * @param[in] operationId The operation ID used in application control invocation
77 * @param[in] pResultList The list of callback strings of application control
79 * @remarks The specified @c pResultList provides the result code for the first array element.
80 * @remarks When the invoked application control is terminated without sending a result,
81 * then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED.
82 * @remarks Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form
83 * (UiApp::OnForeground()). If %UiApp::OnForeground() is being used in the application logic,
84 * it is recommended to avoid switching forms in this listener.
85 * @see Tizen::App::AppControl
88 virtual void OnAppControlCompleted(const Tizen::Base::String& providerId, const Tizen::Base::String& operationId, const Tizen::Base::Collection::IList* pResultList) = 0;
92 // This method is for internal use only.
93 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
95 // This method is reserved and may change its name at any time without prior notice.
99 virtual void IAppControlEventListener_Reserved1(void) {}
102 // This method is for internal use only.
103 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
105 // This method is reserved and may change its name at any time without prior notice.
109 virtual void IAppControlEventListener_Reserved2(void) {}
112 // This method is for internal use only.
113 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
115 // This method is reserved and may change its name at any time without prior notice.
119 virtual void IAppControlEventListener_Reserved3(void) {}
120 }; // IAppControlEventListener
124 #endif // _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_