2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
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
8 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file FSysIScreenEventListener.h
19 * @brief This is the header file for the %IScreenEventListener interface.
21 * This header file contains the declarations of the %IScreenEventListener interface.
24 #ifndef _FSYS_ISCREEN_EVENT_LISTENER_H_
25 #define _FSYS_ISCREEN_EVENT_LISTENER_H_
27 #include <FBaseResult.h>
28 #include <FBaseRtIEventListener.h>
30 namespace Tizen { namespace System
34 * @interface IScreenEventListener
35 * @brief This interface is the listener of the screen event.
39 * The %IScreenEventListener interface must be registered and implemented by an application to receive screen events from the system.
42 class _OSP_EXPORT_ IScreenEventListener
43 : public virtual Tizen::Base::Runtime::IEventListener
47 * Called when the screen turns on. @n
48 * Gets the released resources or resumes the operations that were paused or stopped in OnScreenOff().
52 virtual void OnScreenOn(void) = 0;
55 * Called when the screen turns off. @n
56 * Unless there is a strong reason to do otherwise, release resources (such as 3D, media, and sensors) to allow the device to enter the sleep mode to save the battery.
57 * Invoking a lengthy asynchronous method within this listener method can be risky, because it is not guaranteed to invoke a callback before the device enters the sleep mode.
58 * Similarly, do not perform lengthy operations in this listener method. All operations must be quick ones.
62 virtual void OnScreenOff(void) = 0;
65 * Called when the screen brightness is changed.
69 * @param[in] brightness The screen brightness between @c 0 to @c 10
71 virtual void OnScreenBrightnessChanged(int brightness) {}
76 // This method is for internal use only.
77 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
80 virtual void OnIScreenEventListener_Reserved1(void) {}
83 // This method is for internal use only.
84 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
87 virtual void OnIScreenEventListener_Reserved2(void) {}
89 }; // IScreenEventListener
93 #endif // _FSYS_ISCREEN_EVENT_LISTENER_H_