|
1 /* |
|
2 * Copyright (c) 2007 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 * Interface through which the FEP can use pop up bubble components |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 |
|
30 #ifndef __AKN_FEP_UI_INTERFACE_WORD_POPUP_CONTENT_H |
|
31 #define __AKN_FEP_UI_INTERFACE_WORD_POPUP_CONTENT_H |
|
32 |
|
33 #include <e32base.h> |
|
34 #include <eikcmobs.h> |
|
35 #include <avkon.hrh> |
|
36 |
|
37 |
|
38 |
|
39 class MAknFepUiWordPopupContent |
|
40 { |
|
41 public: |
|
42 // Enum copied from CAknFepExactWordPopupContent |
|
43 enum TArrowDirection |
|
44 { |
|
45 EUpwards, //!< The arrow included in the popup points upwards |
|
46 EDownwards //!< The arrow included in the popup points downwards |
|
47 }; |
|
48 public: |
|
49 virtual ~MAknFepUiWordPopupContent() = 0; |
|
50 public: |
|
51 /** |
|
52 * Sets the text to be shown in the popup |
|
53 */ |
|
54 virtual void SetTextL( const TDesC& aText ) = 0; |
|
55 |
|
56 /** |
|
57 * Sets the direction of the arrow included in the popup. This should be used as a hint |
|
58 * about the direction to tap to select the word shown in the popup. |
|
59 */ |
|
60 virtual void SetArrowDirection( TArrowDirection aDirection ) = 0; |
|
61 /** |
|
62 * Sets the delay used before showing the preview popup. The default |
|
63 * delay is one second. |
|
64 * @param aDelay Delay in microseconds. |
|
65 */ |
|
66 virtual void SetPopUpShowDelay( const TTimeIntervalMicroSeconds32& aDelay ) = 0; |
|
67 |
|
68 /** |
|
69 * Sets the preview popup visible after specified delay. If the popup |
|
70 * is already visible it is hidden immediately and shown again after the |
|
71 * showing delay. Popup is automatically hidden after its hiding delay |
|
72 * unless the delay is zero in which case the popup is shown infinitely. |
|
73 */ |
|
74 virtual void ShowPopUp() = 0; |
|
75 |
|
76 /** |
|
77 * Hides the popup immediately. |
|
78 */ |
|
79 virtual void HidePopUp() = 0; |
|
80 |
|
81 /** |
|
82 * Sets the position of preview popup. Popup's size is determined by the |
|
83 * size of its content. The popup is placed left and down from the given |
|
84 * point. If fixed mode is used then this function has no effect. |
|
85 * @param aPoint Popup's position. |
|
86 */ |
|
87 virtual void SetPosition( const TPoint& aPoint ) = 0; |
|
88 |
|
89 /** |
|
90 * Updates popup's size to reflect a change in content's size. |
|
91 * Should be called if the size of the content is changed dynamically. |
|
92 */ |
|
93 virtual void UpdateContentSize() = 0; |
|
94 |
|
95 /** |
|
96 * Returns the popup's size. |
|
97 */ |
|
98 virtual TSize Size() const = 0; |
|
99 |
|
100 /** |
|
101 * Returns true if the popup is visible. |
|
102 */ |
|
103 virtual TBool IsPopUpVisible() = 0; |
|
104 }; |
|
105 |
|
106 #endif |