24
|
1 |
/*
|
|
2 |
* Copyright (c) 2002-2004 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 |
* Description:
|
|
15 |
* Provides the CAknFepUICtrlContainerChinese definition.
|
|
16 |
*
|
|
17 |
*/
|
|
18 |
|
|
19 |
|
|
20 |
|
|
21 |
|
|
22 |
|
|
23 |
|
|
24 |
|
|
25 |
|
|
26 |
|
|
27 |
|
|
28 |
|
|
29 |
#ifndef __AKN_FEP_UI_CONTAINER_CHINESE_H__
|
|
30 |
#define __AKN_FEP_UI_CONTAINER_CHINESE_H__
|
|
31 |
|
|
32 |
#include <e32std.h>
|
|
33 |
|
|
34 |
class MAknFepUICtrlInputPane;
|
|
35 |
class MAknFepUICtrlCandidatePane;
|
|
36 |
class MAknFepUICtrlPinyinPopup;
|
|
37 |
class MAknFepUICtrlEditPane;
|
|
38 |
class MAknFepManagerUIInterface;
|
|
39 |
|
|
40 |
class MAknFepUICtrlContainerChinese
|
|
41 |
{
|
|
42 |
|
|
43 |
public:
|
|
44 |
/**
|
|
45 |
* Different layouts, the number represents the number of candidates visible in the candidate pane
|
|
46 |
*/
|
|
47 |
enum TPaneLayout
|
|
48 |
{
|
|
49 |
ELayoutInput = 6,
|
|
50 |
ELayoutCandidate = 7,
|
|
51 |
// the follow 2 lines be added for phrase creation
|
|
52 |
ELayoutPhraseCreation = 8,
|
|
53 |
ELayoutKeystroke = 9
|
|
54 |
};
|
|
55 |
public:
|
|
56 |
/**
|
|
57 |
* destructor
|
|
58 |
*/
|
|
59 |
virtual ~MAknFepUICtrlContainerChinese() = 0;
|
|
60 |
|
|
61 |
/**
|
|
62 |
* get the input pane
|
|
63 |
*
|
|
64 |
* @return pointer to the input pane, ownership is not passed
|
|
65 |
*/
|
|
66 |
virtual MAknFepUICtrlInputPane* InputPane() const = 0;
|
|
67 |
|
|
68 |
/**
|
|
69 |
* get the candidate pane
|
|
70 |
*
|
|
71 |
* @return pointer to the candidate pane, ownership is not passed
|
|
72 |
*/
|
|
73 |
virtual MAknFepUICtrlCandidatePane* CandidatePane() const = 0;
|
|
74 |
|
|
75 |
/**
|
|
76 |
* get the phrase pinyin popup window
|
|
77 |
*
|
|
78 |
* @return pointer to the phrase popup window, ownership is not passed
|
|
79 |
*/
|
|
80 |
virtual MAknFepUICtrlPinyinPopup* PinyinPopupWindow() const = 0;
|
|
81 |
|
|
82 |
/**
|
|
83 |
* phrase creation's EEP Ctrl
|
|
84 |
* get the pinyin phrase creation popup window
|
|
85 |
*
|
|
86 |
* @return pointer to the pinyin phrase popup window, ownership is not passed
|
|
87 |
*/
|
|
88 |
virtual MAknFepUICtrlEditPane* EditPaneWindow() const = 0;
|
|
89 |
|
|
90 |
/**
|
|
91 |
* Is the control displayed on the screen?
|
|
92 |
*
|
|
93 |
* @return if not enabled, returns EFalse
|
|
94 |
*
|
|
95 |
*/
|
|
96 |
virtual TBool IsEnabled() const = 0;
|
|
97 |
/**
|
|
98 |
* Enables the display of the control. Sets the control's
|
|
99 |
* window postion and visibility, but only if the value has
|
|
100 |
* changed (so it's ok to call it excessively).
|
|
101 |
*
|
|
102 |
* @param aEnable if ETrue, makes visible
|
|
103 |
* if EFalse, makes non-visible
|
|
104 |
*
|
|
105 |
*/
|
|
106 |
virtual void Enable(TBool aEnable) = 0;
|
|
107 |
|
|
108 |
/**
|
|
109 |
* Arrange the constituent panes into the correct proportions for
|
|
110 |
* the required layout.
|
|
111 |
*
|
|
112 |
* @param aPaneLayout the required layout
|
|
113 |
*
|
|
114 |
*/
|
|
115 |
virtual void SetLayout(TPaneLayout aPaneLayout) = 0;
|
|
116 |
|
|
117 |
|
|
118 |
/**
|
|
119 |
* Set the Highlight to the desired control.
|
|
120 |
*
|
|
121 |
* @param aValue if aValue is ETrue set the focus to the Candidate Pane.
|
|
122 |
* if aValue is EFalse set focus to the Chinese Input Pane
|
|
123 |
*/
|
|
124 |
virtual void FocusCandidatePane(TBool aValue) = 0;
|
|
125 |
|
|
126 |
/**
|
|
127 |
* enable/disable the rendering of the Horizontal Scroll Arrows.
|
|
128 |
*
|
|
129 |
* @param aValue if ETrue, enable the arrows
|
|
130 |
* if EFalse, disable the arrrows
|
|
131 |
*/
|
|
132 |
virtual void ShowHorizontalScrollArrows(TBool aValue) = 0;
|
|
133 |
|
|
134 |
/**
|
|
135 |
* enable/disable the rendering of the Vertical Scroll Arrows.
|
|
136 |
*
|
|
137 |
* @param aValue if ETrue, enable the arrows
|
|
138 |
* if EFalse, disable the arrrows
|
|
139 |
*/
|
|
140 |
virtual void ShowVerticalScrollArrows(TBool aValue) = 0;
|
|
141 |
|
|
142 |
/**
|
|
143 |
* Call this method if the fep is being displayed for a control that is
|
|
144 |
* contained in a popup window (i.e. a Query). It changes the layout
|
|
145 |
* of the container.
|
|
146 |
*
|
|
147 |
* @param aValue if ETrue, use the layout for display with a query
|
|
148 |
* if EFalse, use the normal layout
|
|
149 |
*/
|
|
150 |
virtual void SetIsShownWithPopupWindows(TBool aValue) = 0;
|
|
151 |
|
|
152 |
/**
|
|
153 |
* This function sets cursor position.
|
|
154 |
*
|
|
155 |
* @param aCurPos containing the cursor position
|
|
156 |
* @param aHeight containing font height
|
|
157 |
*/
|
|
158 |
virtual void SetContainerPosition(TPoint aCurPos,TInt aHeight) = 0;
|
|
159 |
|
|
160 |
/**
|
|
161 |
* Set Candidate and pinyin popup invisible(phrase creation)
|
|
162 |
*
|
|
163 |
*/
|
|
164 |
virtual void SetControlInVisible( TBool aVisible = ETrue ) = 0;
|
|
165 |
|
|
166 |
/**
|
|
167 |
* Set the state to phrase creation(phrase creation)
|
|
168 |
*/
|
|
169 |
virtual void PhraseCreation( TBool aPhraseCreation ) = 0;
|
|
170 |
|
|
171 |
/**
|
|
172 |
* Is the state is in phrase creation(phrase creation)
|
|
173 |
*
|
|
174 |
* @return if not phrase creation, return EFalse
|
|
175 |
*/
|
|
176 |
virtual TInt& IsPhraseCreation() = 0;
|
|
177 |
|
|
178 |
/**
|
|
179 |
* Set FepMan(phrase creation)
|
|
180 |
*
|
|
181 |
* @return if not enabled, return EFalse
|
|
182 |
*/
|
|
183 |
virtual void SetFepMan( MAknFepManagerUIInterface* aFepMan ) = 0;
|
|
184 |
|
|
185 |
};
|
|
186 |
#endif // __AKN_FEP_UI_CONTAINER_CHINESE_H__
|
|
187 |
|
|
188 |
// End of file
|
|
189 |
|