|
66
|
1 |
/*
|
|
|
2 |
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
|
3 |
* All rights reserved.
|
|
|
4 |
* This component and the accompanying materials are made available
|
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
|
6 |
* which accompanies this distribution, and is available
|
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
|
8 |
*
|
|
|
9 |
* Initial Contributors:
|
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
|
11 |
*
|
|
|
12 |
* Contributors:
|
|
|
13 |
*
|
|
|
14 |
* Defines an interface for LCDUI custom components
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
|
17 |
|
|
|
18 |
|
|
|
19 |
#ifndef MMIDCUSTOMCOMPONENT_H
|
|
|
20 |
#define MMIDCUSTOMCOMPONENT_H
|
|
|
21 |
|
|
|
22 |
// EXTERNAL INCLUDES
|
|
|
23 |
#include <e32std.h>
|
|
|
24 |
|
|
|
25 |
// FORWARD DECLARATIONS
|
|
|
26 |
class CCoeControl;
|
|
|
27 |
|
|
|
28 |
/**
|
|
|
29 |
* Interface for LCDUI custom components.
|
|
|
30 |
*
|
|
|
31 |
* This interface can be used to interact as a custom UI component
|
|
|
32 |
* in LCDUI components that implement a container for custom
|
|
|
33 |
* components.
|
|
|
34 |
*
|
|
|
35 |
* The client can use this interface to access information about
|
|
|
36 |
* UI controls that the implementing class provides.
|
|
|
37 |
*
|
|
|
38 |
* @lib lcdui
|
|
|
39 |
* @since S60 5.0
|
|
|
40 |
*/
|
|
|
41 |
class MMIDCustomComponent
|
|
|
42 |
{
|
|
|
43 |
public: // new types
|
|
|
44 |
/**
|
|
|
45 |
* Datatype indicates what change was made.
|
|
|
46 |
*/
|
|
|
47 |
enum TChange
|
|
|
48 |
{
|
|
|
49 |
EFullscreenChange,
|
|
|
50 |
EResolutionChange,
|
|
|
51 |
EPartialVKBChange,
|
|
|
52 |
EForegroundGained
|
|
|
53 |
};
|
|
|
54 |
|
|
|
55 |
public: // New methods
|
|
|
56 |
/**
|
|
|
57 |
* Returns the count of controls in this custom component.
|
|
|
58 |
*
|
|
|
59 |
* Note that the count must not change during the lifetime
|
|
|
60 |
* of the object. The count of all components is updated
|
|
|
61 |
* when it is added to the custom component container.
|
|
|
62 |
*
|
|
|
63 |
* This is done in order to improve the performance when counting
|
|
|
64 |
* countrols.
|
|
|
65 |
*
|
|
|
66 |
* @return The count of controls in this custom component.
|
|
|
67 |
* @since S60 5.0
|
|
|
68 |
*/
|
|
|
69 |
virtual TInt CustomComponentControlCount() const = 0;
|
|
|
70 |
|
|
|
71 |
/**
|
|
|
72 |
* Returns an UI control of this custom component.
|
|
|
73 |
*
|
|
|
74 |
* The index specifies which component is requested. The method
|
|
|
75 |
* works similar to CCoeControl::ComponentControl() method. The
|
|
|
76 |
* ownership of the control is NOT transferred to the caller.
|
|
|
77 |
*
|
|
|
78 |
* @param aIndex The index of the control to be retrieved.
|
|
|
79 |
* @return The UI control of this custom component.
|
|
|
80 |
* @since S60 5.0
|
|
|
81 |
*/
|
|
|
82 |
virtual CCoeControl* CustomComponentControl(TInt aIndex) = 0;
|
|
|
83 |
|
|
|
84 |
/**
|
|
|
85 |
* Indicates that the container is about to be disposed.
|
|
|
86 |
*
|
|
|
87 |
* The custom component does not have to remove itself
|
|
|
88 |
* from the container since the container removes all components
|
|
|
89 |
* when disposing.
|
|
|
90 |
*
|
|
|
91 |
* @since S60 5.0
|
|
|
92 |
*/
|
|
|
93 |
virtual void CustomComponentContainerDisposing() = 0;
|
|
|
94 |
|
|
|
95 |
/**
|
|
|
96 |
* Indicates if traversal can be done.
|
|
|
97 |
*
|
|
|
98 |
* Used when changing focus by key down and up.
|
|
|
99 |
*
|
|
|
100 |
* @param aEvent Key Event.
|
|
|
101 |
* @since S60 5.0
|
|
|
102 |
*/
|
|
|
103 |
virtual void TraverseL(const TKeyEvent& aEvent) = 0;
|
|
|
104 |
|
|
|
105 |
/**
|
|
|
106 |
* Processes the received pointer event.
|
|
|
107 |
*
|
|
|
108 |
* @param aPointerEvent The pointer event. iPosition will be reset to the
|
|
|
109 |
* parent window position. iParentPosition will be invalid for the
|
|
|
110 |
* container.
|
|
|
111 |
* @since S60 5.0
|
|
|
112 |
*/
|
|
|
113 |
virtual void ProcessPointerEventL(const TPointerEvent& aPointerEvent) = 0;
|
|
|
114 |
|
|
|
115 |
/**
|
|
|
116 |
* Gets the current touch-enabled state
|
|
|
117 |
*
|
|
|
118 |
* @return true if the component is touch-enabled, false otherwise
|
|
|
119 |
* @since S60 5.0
|
|
|
120 |
*/
|
|
|
121 |
virtual TBool IsTouchEnabled() = 0;
|
|
|
122 |
|
|
|
123 |
/**
|
|
|
124 |
* Handles fullscreen state of parent Canvas.
|
|
|
125 |
*
|
|
|
126 |
* @since S60 5.0
|
|
|
127 |
*/
|
|
|
128 |
virtual void HandleFullscreenModeChange() = 0;
|
|
|
129 |
|
|
|
130 |
/**
|
|
|
131 |
* Handles system resource change messages.
|
|
|
132 |
*
|
|
|
133 |
* @param aType A message UID value.
|
|
|
134 |
*
|
|
|
135 |
* @since S60 5.0
|
|
|
136 |
*/
|
|
|
137 |
virtual void HandleResourceChange(TInt aType) = 0;
|
|
|
138 |
|
|
|
139 |
/**
|
|
|
140 |
* Handles switching from foreground to background and vice versa.
|
|
|
141 |
*
|
|
|
142 |
* @param aForeground Flag if it switches to foreground or to backgound.
|
|
|
143 |
*
|
|
|
144 |
* @since S60 5.0
|
|
|
145 |
*/
|
|
|
146 |
virtual void HandleForeground(TBool aForeground) = 0;
|
|
|
147 |
|
|
|
148 |
protected: // Destructor
|
|
|
149 |
|
|
|
150 |
/**
|
|
|
151 |
* Destructor. Disallows destruction through this interface
|
|
|
152 |
*/
|
|
|
153 |
virtual ~MMIDCustomComponent() {}
|
|
|
154 |
};
|
|
|
155 |
|
|
|
156 |
#endif // MMIDCUSTOMCOMPONENT_H
|
|
|
157 |
|
|
|
158 |
// End of file
|