|
1 /* |
|
2 * Copyright (c) 2006-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: Master header file for applications. Includes the entire |
|
15 * public API of the Hitchcock User Interface Toolkit. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 |
|
21 /** |
|
22 * @mainpage Hitchcock User Interface Toolkit |
|
23 * |
|
24 * @section sec1 Introduction |
|
25 * |
|
26 * The Hitchcock User Interface Toolkit (HUITK) is a library of classes that |
|
27 * can be used for creating graphical user interfaces that are primarily |
|
28 * two-dimensional, but can utilize three-dimensional objects and effects, for |
|
29 * instance rotations. HUITK has been designed to be used with hardware-accelerated |
|
30 * graphics, but limited functionality software-only rendering is also supported. |
|
31 * HUITK has been developed on Symbian OS 9.1. |
|
32 * |
|
33 * You are reading the HUITK API documentation. This is a reference manual |
|
34 * of the HUITK API classes. For higher-level developer documentation, see |
|
35 * @ref sec_info. |
|
36 * |
|
37 * @section sec2 Typical Usage |
|
38 * |
|
39 * Initialization: |
|
40 * - Create environment. Specify the renderer to use, e.g., EHuiRendererGles11. |
|
41 * - Create a display. The most convenient way is to use CHuiDisplayCoeControl. |
|
42 * - Create one or more control groups. |
|
43 * - Create controls and append them to the groups. |
|
44 * - Display one (or more) of the groups. |
|
45 * |
|
46 * Normal runtime behaviour: |
|
47 * - Action and animation commands can be posted using the environment. |
|
48 * - Controls handle input events in CHuiControl::OfferEventL(). |
|
49 * - Controls can manipulate visuals. |
|
50 * - Groups can be shown, hidden, and transformed. |
|
51 * - Display refresh is paused while nothing is happening. See |
|
52 * CHuiEnv::ContinueRefresh(). |
|
53 * |
|
54 * Cleanup: |
|
55 * - Delete CoeControls owned by the application (including |
|
56 * CHuiDisplayCoeControl instances). |
|
57 * - Shut down by deleting the environment. |
|
58 * |
|
59 * @section sec_groups Classes |
|
60 * |
|
61 * The following classes form the public API of the toolkit. The API |
|
62 * documentation also includes information about internal classes. Note that |
|
63 * exported methods are listed under an "Exported API" subsection |
|
64 * in each class's description. |
|
65 * |
|
66 * Core Functionality: |
|
67 * - CHuiEnv |
|
68 * - CHuiDisplay |
|
69 * - CHuiDisplayCoeControl |
|
70 * - CHuiControl |
|
71 * - CHuiControlGroup |
|
72 * - CHuiRoster |
|
73 * - CHuiStatic |
|
74 * - THuiTimedValue |
|
75 * - THuiTimedPoint |
|
76 * - THuiCommand (and derived classes such as THuiValueCommand) |
|
77 * - THuiEvent |
|
78 * |
|
79 * Utilities: |
|
80 * - HuiUtil (only static methods) |
|
81 * - MHuiMappingFunction implementations such as THuiLinearMappingFunction |
|
82 * - THuiRealPoint |
|
83 * - THuiRealRect |
|
84 * - THuiRealSize |
|
85 * |
|
86 * Graphics (note HuiDrawing.h): |
|
87 * - CHuiGc (available in CHuiVisual::Draw() methods) |
|
88 * - CHuiTransformation |
|
89 * - CHuiCurvePath |
|
90 * - CHuiMesh |
|
91 * - THuiMaterial |
|
92 * - CHuiS60Skin |
|
93 * - CHuiTextureManager |
|
94 * - CHuiTextureProcessor |
|
95 * - CHuiTexture |
|
96 * - CHuiAnimatedTexture |
|
97 * - THuiTextureHandle |
|
98 * - THuiImage (reference to a region of a texture) |
|
99 * |
|
100 * Visuals and Layouts (note HuiVisuals.h and HuiLayouts.h): |
|
101 * - CHuiVisual |
|
102 * - CHuiImageVisual |
|
103 * - CHuiLineVisual |
|
104 * - CHuiMeshVisual |
|
105 * - CHuiTextVisual |
|
106 * - CHuiLayout |
|
107 * - CHuiAnchorLayout |
|
108 * - CHuiFlowLayout |
|
109 * - CHuiGridLayout |
|
110 * |
|
111 * Brushes (note HuiBrushes.h): |
|
112 * - CHuiBrushArray (see CHuiVisual::EnableBrushesL()) |
|
113 * - CHuiBrush |
|
114 * - CHuiBorderBrush |
|
115 * - CHuiDropShadowBrush |
|
116 * - CHuiGradientBrush |
|
117 * - CHuiShadowBorderBrush |
|
118 * |
|
119 * Common controls: |
|
120 * - CHuiSoftKeyControl |
|
121 * |
|
122 * @section sec_info More Information |
|
123 * |
|
124 * More information is available in the Nokia internal Wiki pages: |
|
125 * http://nwiki.nokia.com/NSSProjects/HUIToolkit |
|
126 * |
|
127 * |
|
128 * Copyright © 2006 Nokia. All rights reserved. |
|
129 * |
|
130 * This material, including documentation and any related computer programs, |
|
131 * is protected by copyright controlled by Nokia. All rights are reserved. |
|
132 * Copying, including reproducing, storing, adapting or translating, any or |
|
133 * all of this material requires the prior written consent of Nokia. This |
|
134 * material also contains confidential information which may not be disclosed |
|
135 * to others without the prior written consent of Nokia. |
|
136 */ |
|
137 |
|
138 #include <uiacceltk/HuiCommand.h> |
|
139 #include <uiacceltk/HuiControl.h> |
|
140 #include <uiacceltk/HuiControlGroup.h> |
|
141 #include <uiacceltk/HuiRoster.h> |
|
142 #include <uiacceltk/HuiDisplay.h> |
|
143 #include <uiacceltk/HuiDisplayCoeControl.h> |
|
144 #include <uiacceltk/HuiEnv.h> |
|
145 #include <uiacceltk/HuiEvent.h> |
|
146 #include <uiacceltk/HuiPanic.h> |
|
147 #include <uiacceltk/HuiPlatform.h> |
|
148 #include <uiacceltk/HuiScheduler.h> |
|
149 #include <uiacceltk/HuiStatic.h> |
|
150 #include <uiacceltk/HuiTimedPoint.h> |
|
151 #include <uiacceltk/HuiTimedValue.h> |
|
152 #include <uiacceltk/huieventhandler.h> |
|
153 |
|
154 /* |
|
155 * Utilities |
|
156 */ |
|
157 #include <uiacceltk/HuiMappingFunctions.h> |
|
158 #include <uiacceltk/HuiObserverArray.h> |
|
159 #include <uiacceltk/HuiTimeObserver.h> |
|
160 #include <uiacceltk/HuiOwnedPointer.h> |
|
161 #include <uiacceltk/HuiInteractionInterval.h> |
|
162 #include <uiacceltk/HuiRealPoint.h> |
|
163 #include <uiacceltk/HuiRealRect.h> |
|
164 #include <uiacceltk/HuiRealSize.h> |
|
165 #include <uiacceltk/HuiUtil.h> |
|
166 #include <uiacceltk/HuiImageLoaderUtil.h> |
|
167 |
|
168 /* |
|
169 * Graphics |
|
170 */ |
|
171 #include <uiacceltk/HuiTransformation.h> |
|
172 #include <uiacceltk/HuiTextureManager.h> |
|
173 #include <uiacceltk/HuiTextureProcessor.h> |
|
174 #include <uiacceltk/HuiTextureIf.h> |
|
175 #include <uiacceltk/HuiSegmentedTexture.h> |
|
176 #include <uiacceltk/HuiShadowedTexture.h> |
|
177 #include <uiacceltk/HuiTexture.h> |
|
178 #include <uiacceltk/HuiTextureHandle.h> |
|
179 #include <uiacceltk/HuiCurvePath.h> |
|
180 #include <uiacceltk/HuiGc.h> |
|
181 #include <uiacceltk/HuiImage.h> |
|
182 #include <uiacceltk/HuiMesh.h> |
|
183 #include <uiacceltk/HuiMaterial.h> |
|
184 #include <uiacceltk/HuiTextMesh.h> |
|
185 #include <uiacceltk/HuiSkin.h> |
|
186 #include <uiacceltk/HuiS60Skin.h> |
|
187 #include <uiacceltk/HuiAnimatedTexture.h> |
|
188 |
|
189 /* |
|
190 * Visuals and Layouts |
|
191 */ |
|
192 #include <uiacceltk/HuiDrawing.h> |
|
193 #include <uiacceltk/HuiVisuals.h> |
|
194 #include <uiacceltk/HuiLayouts.h> |
|
195 |
|
196 /* |
|
197 * Brushes |
|
198 */ |
|
199 #include <uiacceltk/HuiBrushes.h> |
|
200 #include <uiacceltk/HuiBrushArray.h> |
|
201 |
|
202 /* |
|
203 * Common Controls |
|
204 * @ deprecated |
|
205 * |
|
206 */ |
|
207 #include <uiacceltk/HuiSoftKeyControl.h> |