summaryrefslogtreecommitdiff
path: root/inc/FWebCtrlIWebUiEventListener.h
blob: 43d1839d1accd25da4bc3cc60a0d5385d4618868 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
//
// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

/**
 * @file		FWebCtrlIWebUiEventListener.h
 * @brief		This is the header file for the %IWebUiEventListener interface.
 *
 * This header file contains the declarations of the %IWebUiEventListener interface.
 */
#ifndef _FWEB_CTRL_IWEB_UI_EVENT_LISTENER_H_
#define _FWEB_CTRL_IWEB_UI_EVENT_LISTENER_H_

#include <FBaseRtIEventListener.h>
#include <FWebCtrlWeb.h>
#include <FGrpPoint.h>

namespace Tizen { namespace Web { namespace Controls
{

/**
 * @interface	IWebUiEventListener
 * @brief		This interface is used for receiving user interface (UI) related events caused by the layout changes of a control.
 *
 * @since		2.0
 *
 * The %IWebUiEventListener interface is used for receiving user interface (UI) related events caused by the layout changes of a control.
 * The browser engine requests a screen update through this interface when the layout of a page is changed.
 */
class _OSP_EXPORT_ IWebUiEventListener
	: public virtual Tizen::Base::Runtime::IEventListener
{
public:
	/**
	 * 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.
	 *
	 * @since	2.0
	 */
	virtual ~IWebUiEventListener(void) {}

	/**
	 * Called when the layout of a page is updated. @n
	 * The application must call Control::Show() if the screen needs to be updated.
	 *
	 * @since				2.0
	 *
	 * @param[in]		source				The source of the event
	 */
	virtual void OnWebPageShowRequested(Tizen::Web::Controls::Web& source) = 0;


	/**
	 * Called when a request for creating a new window is received. @n
	 * The returned Web control instance must be constructed by using a child window's Construct() method.
	 *
	 * @since				2.0
	 *
	 * @return			A pointer to the new WebWindow instance
	 */
	virtual Tizen::Web::Controls::Web* OnWebWindowCreateRequested(void) = 0;


	/**
	 * Called when a request for closing the window is received. @n
	 * This event is called from the parent window's listener that invoked the child window. @n
	 * The application must free the resource allocated for the Web Control.
	 *
	 * @since			 2.0
	 *
	 * @param[in]        source             The source of the closing event
	 */
	virtual void OnWebWindowCloseRequested(Tizen::Web::Controls::Web& source) = 0;

	/**
	 * Called when the selected block of a page is updated.
	 *
	 * @since                    2.0
	 *
	 * @param[in]              source             The source of the event
	 * @param[in]		startPoint		The starting point of the selected block
	 * @param[in]		endPoint		The ending point of the selected block
	 */
	virtual void OnWebPageBlockSelected(Tizen::Web::Controls::Web& source, Tizen::Graphics::Point& startPoint, Tizen::Graphics::Point& endPoint) = 0;


protected:
	//
	// This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
	//
	// Gets the Impl instance.
	//
	// @since		2.0
	//
	virtual void IWebUiEventListener_Reserved1(void) {};

	//
	// This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
	//
	// Gets the Impl instance.
	//
	// @since		2.0
	//
	virtual void IWebUiEventListener_Reserved2(void) {};

	//
	// This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
	//
	// Gets the Impl instance.
	//
	// @since		2.0
	//
	virtual void IWebUiEventListener_Reserved3(void) {};

	//
	// This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
	//
	// Gets the Impl instance.
	//
	// @since		2.0
	//
	virtual void IWebUiEventListener_Reserved4(void) {};

	//
	// This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
	//
	// Gets the Impl instance.
	//
	// @since		2.0
	//
	virtual void IWebUiEventListener_Reserved5(void) {};
}; // IWebUiEventListener

}}} // Tizen::Web::Controls
#endif // _FWEB_CTRL_IWEB_UI_EVENT_LISTENER_H_