]>
Commit | Line | Data |
---|---|---|
4514447c FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: platdetails.h | |
3 | // Purpose: Platform details page of the Doxygen manual | |
4 | // Author: wxWidgets team | |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | ||
880efa2a | 10 | /** |
4514447c | 11 | |
29f86fc1 | 12 | @page page_port Platform Details |
4514447c | 13 | |
928f1a07 FM |
14 | wxWidgets defines a common API across platforms, but uses the native graphical |
15 | user interface (GUI) on each platform, so your program will take on the native | |
16 | look and feel that users are familiar with. Unfortunately native toolkits and | |
17 | hardware do not always support the functionality that the wxWidgets API | |
18 | requires. This chapter collects notes about differences among supported platforms | |
19 | and ports. | |
4514447c | 20 | |
928f1a07 | 21 | @li @ref page_port_wxgtk |
0f6c9085 | 22 | @li @ref page_port_wxosx |
928f1a07 FM |
23 | @li @ref page_port_wxos2 |
24 | @li @ref page_port_wxmgl | |
25 | @li @ref page_port_wxx11 | |
1dfb6ff0 | 26 | @li @ref page_port_wxmotif |
928f1a07 FM |
27 | @li @ref page_port_wxmsw |
28 | @li @ref page_port_nativedocs | |
4514447c FM |
29 | |
30 | ||
928f1a07 | 31 | <hr> |
4514447c FM |
32 | |
33 | ||
34 | ||
928f1a07 | 35 | @section page_port_wxgtk wxGTK |
469e56bf | 36 | |
928f1a07 | 37 | @htmlonly |
fd779edb | 38 | <img src="logo_gtk.png" alt="GTK logo" title="GTK logo" class="logo"> |
928f1a07 | 39 | @endhtmlonly |
3c4f71cc | 40 | |
928f1a07 FM |
41 | wxGTK is a port of wxWidgets using the GTK+ library. |
42 | It makes use of GTK+'s native widgets wherever possible and uses | |
43 | wxWidgets' generic controls when needed. GTK+ itself has been | |
44 | ported to a number of systems, but so far only the original X11 | |
45 | version is supported. Support for other GTK+ backends is planned, | |
46 | such as the new DirectFB backend. | |
3c4f71cc | 47 | |
928f1a07 FM |
48 | All work is being done on GTK+ version 2.0 and above. Support for |
49 | GTK+ 1.2 will be deprecated in a later release. | |
3c4f71cc | 50 | |
5bb7884b | 51 | You will need GTK+ 2.6 or higher which is available from: |
3c4f71cc | 52 | |
928f1a07 | 53 | http://www.gtk.org |
3c4f71cc | 54 | |
928f1a07 | 55 | The newer version of GTK+ you use, the more native widgets and |
7ecc54df BP |
56 | features will be utilized. We have gone to great lengths to |
57 | allow compiling wxWidgets applications with the latest version of | |
928f1a07 | 58 | GTK+, with the resulting binary working on systems even with a |
7ecc54df | 59 | much earlier version of GTK+. You will have to ensure that the |
928f1a07 | 60 | application is launched with lazy symbol binding for that. |
3c4f71cc | 61 | |
928f1a07 FM |
62 | In order to configure wxWidgets to compile wxGTK you will |
63 | need use the @c --with-gtk argument to the @c configure script. | |
64 | This is the default for many systems. | |
3c4f71cc | 65 | |
928f1a07 FM |
66 | GTK+ 1.2 can still be used, albeit discouraged. For that you can |
67 | pass @c --with-gtk=1 to the @c configure script. | |
3c4f71cc | 68 | |
1dfb6ff0 | 69 | For further information, please see the files in @c docs/gtk |
928f1a07 | 70 | in the distribution. |
3c4f71cc VS |
71 | |
72 | ||
0f6c9085 | 73 | @section page_port_wxosx wxOSX |
3c4f71cc | 74 | |
928f1a07 | 75 | @htmlonly |
fd779edb | 76 | <img src="logo_osxleopard.png" alt="Mac OS X (Leopard) logo" |
928f1a07 FM |
77 | title="Mac OS X (Leopard) logo" class="logo"> |
78 | @endhtmlonly | |
469e56bf | 79 | |
0f6c9085 KO |
80 | @subsection page_port_wxosx_carbon wxOSX/Carbon |
81 | ||
2b8471fb KO |
82 | wxOSX/Carbon is a port of wxWidgets for the Macintosh OS platform. |
83 | Currently MacOS X 10.4 or higher are supported. wxOSX/Carbon can | |
5bb7884b | 84 | be compiled both using Apple's command line developer tools |
2b8471fb | 85 | as well as Apple's XCode IDE. wxOSX/Carbon supports both the Intel |
5bb7884b RR |
86 | and PowerPC architectures and can be used to produce |
87 | "universal binaries" in order create application which can run | |
2b8471fb | 88 | both architecture. Unfortunately, wxOSX/Carbon does not support any |
5bb7884b RR |
89 | 64-bit architecture since Apple decided not to port its Carbon |
90 | API entirely to 64-bit. | |
3c4f71cc | 91 | |
0f6c9085 KO |
92 | @note Carbon has been deprecated by Apple as of OS X 10.5 and will likely |
93 | be removed entirely in a future OS version. It's recommended you look into | |
94 | switching your app over to wxOSX/Cocoa as soon as possible. | |
95 | ||
f5fd8c24 | 96 | For further information, please see the files in @c docs/osx |
928f1a07 | 97 | in the distribution. |
3c4f71cc VS |
98 | |
99 | ||
100 | ||
0f6c9085 | 101 | @subsection page_port_wxosx_cocoa wxOSX/Cocoa |
5bb7884b | 102 | |
2b8471fb KO |
103 | wxOSX/Cocoa is another port of wxWidgets for the Macintosh OS |
104 | platform. In contrast to wxOSX/Carbon, it uses the Cocoa API | |
105 | in place of Carbon. Much work has gone into this port and many | |
106 | controls are functional, but the port has not reached the maturity | |
bce3699f | 107 | of the wxOSX/Carbon port yet. It is possible to use wxOSX/Cocoa |
5bb7884b RR |
108 | on 64-bit architectures. |
109 | ||
0f6c9085 KO |
110 | In order to configure wxWidgets to compile wxOSX/Cocoa you will |
111 | need to type: | |
112 | ||
113 | @verbatim configure --with-osx_cocoa @endverbatim | |
114 | ||
f5fd8c24 | 115 | For further information, please see the files in @c docs/osx |
1dfb6ff0 FM |
116 | in the distribution. |
117 | ||
0f6c9085 | 118 | @note There was a previous effort towards a Cocoa port called |
bce3699f | 119 | wxCocoa, which was implemented totally with Cocoa API unlike the OSX/Cocoa port |
2b8471fb | 120 | which uses OS X C APIs to share code, and while it is no longer being actively |
bce3699f | 121 | developed, docs for it are available in @c docs/cocoa in the distribution. |
2b8471fb KO |
122 | |
123 | ||
3c4f71cc | 124 | |
928f1a07 | 125 | @section page_port_wxmgl wxMGL |
3c4f71cc | 126 | |
928f1a07 FM |
127 | wxMGL is a port of wxWidgets using the MGL library available |
128 | from SciTech as the underlying graphics backend. wxMGL draws | |
5bb7884b RR |
129 | its widgets using the wxUniversal widget set which is part |
130 | of wxWidgets. MGL itself runs on a variety of platforms | |
928f1a07 FM |
131 | including DOS, Linux hardware (similar to the Linux framebuffer) |
132 | and various graphics systems such as Win32, X11 and OS/2. | |
133 | Note that currently MGL for Linux runs only on x86-based systems. | |
3c4f71cc | 134 | |
5bb7884b | 135 | You will MGL 5.0 or higher which is available from |
3c4f71cc | 136 | |
928f1a07 | 137 | http://www.scitechsoft.com/products/product_download.html |
3c4f71cc | 138 | |
928f1a07 FM |
139 | In order to configure wxWidgets to compile wxMGL you will |
140 | need to type: | |
3c4f71cc | 141 | |
928f1a07 | 142 | @verbatim configure --with-mgl --with-universal @endverbatim |
3c4f71cc | 143 | |
928f1a07 | 144 | Under DOS, wxMGL uses a dmake based make system. |
3c4f71cc | 145 | |
1dfb6ff0 | 146 | For further information, please see the files in @c docs/mgl |
928f1a07 | 147 | in the distribution. |
3c4f71cc VS |
148 | |
149 | ||
150 | ||
928f1a07 | 151 | @section page_port_wxos2 wxOS2 |
469e56bf | 152 | |
928f1a07 FM |
153 | wxOS2 is a port of wxWidgets for the IBM OS/2 Warp3 and Warp4 platforms. |
154 | This port is currently under construction and in beta phase. | |
469e56bf | 155 | |
1dfb6ff0 FM |
156 | For further information, please see the files in @c docs/os2 |
157 | in the distribution. | |
158 | ||
3c4f71cc VS |
159 | |
160 | ||
928f1a07 | 161 | @section page_port_wxx11 wxX11 |
469e56bf | 162 | |
928f1a07 | 163 | @htmlonly |
fd779edb | 164 | <img src="logo_x11.png" alt="X.org logo" title="X.org logo" class="logo"> |
928f1a07 | 165 | @endhtmlonly |
469e56bf | 166 | |
928f1a07 FM |
167 | wxX11 is a port of wxWidgets using X11 (The X Window System) |
168 | as the underlying graphics backend. wxX11 draws its widgets | |
169 | using the wxUniversal widget set which is now part of wxWidgets. | |
170 | wxX11 is well-suited for a number of special applications such | |
171 | as those running on systems with few resources (PDAs) or for | |
bbc5b7f8 | 172 | applications which need to use a special themed look. |
3c4f71cc | 173 | |
928f1a07 FM |
174 | In order to configure wxWidgets to compile wxX11 you will |
175 | need to type: | |
3c4f71cc | 176 | |
928f1a07 | 177 | @verbatim configure --with-x11 --with-universal @endverbatim |
3c4f71cc | 178 | |
1dfb6ff0 | 179 | For further information, please see the files in @c docs/x11 |
928f1a07 FM |
180 | in the distribution. There is also a page on the use of |
181 | wxWidgets for embedded applications on the wxWidgets web site. | |
3c4f71cc VS |
182 | |
183 | ||
184 | ||
1dfb6ff0 FM |
185 | @section page_port_wxmotif wxMotif |
186 | ||
187 | @htmlonly | |
fd779edb | 188 | <img src="logo_motif.png" alt="Motif logo" title="Motif logo" class="logo"> |
1dfb6ff0 FM |
189 | @endhtmlonly |
190 | ||
191 | wxMotif is a port of wxWidgets for X11 systems using Motif libraries. | |
192 | Motif libraries provide a clean and fast user interface at the expense | |
193 | of the beauty and candy of newer interfaces like GTK. | |
194 | ||
195 | For further information, please see the files in @c docs/motif | |
196 | in the distribution. | |
197 | ||
198 | ||
3c4f71cc VS |
199 | |
200 | ||
928f1a07 | 201 | @section page_port_wxmsw wxMSW |
469e56bf | 202 | |
928f1a07 | 203 | @htmlonly |
fd779edb | 204 | <img src="logo_win.png" alt="Windows logo" title="Windows logo" class="logo"> |
928f1a07 | 205 | @endhtmlonly |
469e56bf | 206 | |
7ecc54df BP |
207 | wxMSW is a port of wxWidgets for the Windows platforms including Windows 95, |
208 | 98, ME, 2000, NT, XP and Vista in ANSI and Unicode modes (for Windows 9x and | |
209 | ME through the MSLU extension library). wxMSW ensures native look and feel for | |
210 | XP when using wxWidgets version 2.3.3 or higher.wxMSW can be compiled with a | |
211 | great variety of compilers including Microsoft Studio VC++, Borland 5.5, | |
212 | MinGW32, Cygwin and Watcom as well as cross-compilation with a Linux-hosted | |
928f1a07 | 213 | MinGW32 tool chain. |
3c4f71cc | 214 | |
928f1a07 FM |
215 | For further information, please see the files in docs/msw |
216 | in the distribution. | |
3c4f71cc | 217 | |
928f1a07 | 218 | @subsection page_port_wxmsw_themedborders Themed borders on Windows |
3c4f71cc | 219 | |
3ed3a1c8 | 220 | Starting with wxWidgets 2.8.5, you can specify the @c wxBORDER_THEME style to have wxWidgets |
928f1a07 FM |
221 | use a themed border. Using the default XP theme, this is a thin 1-pixel blue border, |
222 | with an extra 1-pixel border in the window client background colour (usually white) to | |
223 | separate the client area's scrollbars from the border. | |
3c4f71cc | 224 | |
928f1a07 FM |
225 | If you don't specify a border style for a wxTextCtrl in rich edit mode, wxWidgets now gives |
226 | the control themed borders automatically, where previously they would take the Windows 95-style | |
7ecc54df | 227 | sunken border. Other native controls such as wxTextCtrl in non-rich edit mode, and wxComboBox |
928f1a07 | 228 | already paint themed borders where appropriate. To use themed borders on other windows, such |
3ed3a1c8 | 229 | as wxPanel, pass the @c wxBORDER_THEME style, or (apart from wxPanel) pass no border style. |
3c4f71cc | 230 | |
3ed3a1c8 BP |
231 | In general, specifying @c wxBORDER_THEME will cause a border of some kind to be used, chosen by the platform |
232 | and control class. To leave the border decision entirely to wxWidgets, pass @c wxBORDER_DEFAULT. | |
233 | This is not to be confused with specifying @c wxBORDER_NONE, which says that there should | |
928f1a07 | 234 | definitely be @e no border. |
3c4f71cc | 235 | |
928f1a07 | 236 | @subsubsection page_port_wxmsw_themedborders_details More detail on border implementation |
3c4f71cc | 237 | |
928f1a07 FM |
238 | The way that wxMSW decides whether to apply a themed border is as follows. |
239 | The theming code calls wxWindow::GetBorder() to obtain a border. If no border style has been | |
240 | passed to the window constructor, GetBorder() calls GetDefaultBorder() for this window. | |
241 | If wxBORDER_THEME was passed to the window constructor, GetBorder() calls GetDefaultBorderForControl(). | |
3c4f71cc | 242 | |
928f1a07 FM |
243 | The implementation of wxWindow::GetDefaultBorder() on wxMSW calls wxWindow::CanApplyThemeBorder() |
244 | which is a virtual function that tells wxWidgets whether a control can have a theme | |
245 | applied explicitly (some native controls already paint a theme in which case we should not | |
246 | apply it ourselves). Note that wxPanel is an exception to this rule because in many cases | |
247 | we wish to create a window with no border (for example, notebook pages). So wxPanel | |
248 | overrides GetDefaultBorder() in order to call the generic wxWindowBase::GetDefaultBorder(), | |
249 | returning wxBORDER_NONE. | |
3c4f71cc | 250 | |
928f1a07 | 251 | @subsection page_port_wxmsw_wince wxWinCE |
3c4f71cc | 252 | |
928f1a07 FM |
253 | wxWinCE is the name given to wxMSW when compiled on Windows CE devices; |
254 | most of wxMSW is common to Win32 and Windows CE but there are | |
255 | some simplifications, enhancements, and differences in | |
256 | behaviour. | |
3c4f71cc | 257 | |
928f1a07 FM |
258 | For building instructions, see docs/msw/wince in the |
259 | distribution, also the section about Visual Studio 2005 project | |
260 | files below. The rest of this section documents issues you | |
261 | need to be aware of when programming for Windows CE devices. | |
3c4f71cc | 262 | |
928f1a07 | 263 | @subsubsection page_port_wxmsw_wince_ General issues for wxWinCE programming |
3c4f71cc | 264 | |
928f1a07 FM |
265 | Mobile applications generally have fewer features and |
266 | simpler user interfaces. Simply omit whole sizers, static | |
267 | lines and controls in your dialogs, and use comboboxes instead | |
268 | of listboxes where appropriate. You also need to reduce | |
269 | the amount of spacing used by sizers, for which you can | |
270 | use a macro such as this: | |
3c4f71cc | 271 | |
3ed3a1c8 | 272 | @code |
928f1a07 FM |
273 | #if defined(__WXWINCE__) |
274 | #define wxLARGESMALL(large,small) small | |
275 | #else | |
276 | #define wxLARGESMALL(large,small) large | |
277 | #endif | |
3c4f71cc | 278 | |
928f1a07 FM |
279 | // Usage |
280 | topsizer->Add( CreateTextSizer( message ), 0, wxALL, wxLARGESMALL(10,0) ); | |
3ed3a1c8 | 281 | @endcode |
3c4f71cc | 282 | |
928f1a07 FM |
283 | There is only ever one instance of a Windows CE application running, |
284 | and wxWidgets will take care of showing the current instance and | |
285 | shutting down the second instance if necessary. | |
3c4f71cc | 286 | |
928f1a07 FM |
287 | You can test the return value of wxSystemSettings::GetScreenType() |
288 | for a qualitative assessment of what kind of display is available, | |
289 | or use wxGetDisplaySize() if you need more information. | |
3c4f71cc | 290 | |
928f1a07 FM |
291 | You can also use wxGetOsVersion to test for a version of Windows CE at |
292 | run-time (see the next section). However, because different builds | |
293 | are currently required to target different kinds of device, these | |
294 | values are hard-wired according to the build, and you cannot | |
295 | dynamically adapt the same executable for different major Windows CE | |
296 | platforms. This would require a different approach to the way | |
297 | wxWidgets adapts its behaviour (such as for menubars) to suit the | |
298 | style of device. | |
299 | ||
300 | See the "Life!" example (demos/life) for an example of | |
301 | an application that has been tailored for PocketPC and Smartphone use. | |
302 | ||
303 | @note don't forget to have this line in your .rc file, as for | |
304 | desktop Windows applications: | |
305 | ||
306 | @verbatim #include "wx/msw/wx.rc" @endverbatim | |
307 | ||
308 | @subsubsection page_port_wxmsw_wince_sdk Testing for WinCE SDKs | |
309 | ||
310 | Use these preprocessor symbols to test for the different types of device or SDK: | |
311 | ||
312 | @li @b __SMARTPHONE__ Generic mobile devices with phone buttons and a small display | |
313 | @li @b __PDA__ Generic mobile devices with no phone | |
314 | @li @b __HANDHELDPC__ Generic mobile device with a keyboard | |
315 | @li @b __WXWINCE__ Microsoft-powered Windows CE devices, whether PocketPC, Smartphone or Standard SDK | |
316 | @li @b WIN32_PLATFORM_WFSP Microsoft-powered smartphone | |
317 | @li @b __POCKETPC__ Microsoft-powered PocketPC devices with touch-screen | |
318 | @li @b __WINCE_STANDARDSDK__ Microsoft-powered Windows CE devices, for generic Windows CE applications | |
319 | @li @b __WINCE_NET__ Microsoft-powered Windows CE .NET devices (_WIN32_WCE is 400 or greater) | |
320 | ||
321 | wxGetOsVersion will return these values: | |
322 | ||
323 | @li @b wxWINDOWS_POCKETPC The application is running under PocketPC. | |
324 | @li @b wxWINDOWS_SMARTPHONE The application is running under Smartphone. | |
325 | @li @b wxWINDOWS_CE The application is running under Windows CE (built with the Standard SDK). | |
326 | ||
327 | ||
328 | @subsubsection page_port_wxmsw_wince_sizing Window sizing in wxWinCE | |
329 | ||
330 | Top level windows (dialogs, frames) are created always full-screen. Fit() of sizers will not rescale top | |
331 | level windows but instead will scale window content. | |
332 | ||
333 | If the screen orientation changes, the windows will automatically be resized | |
334 | so no further action needs to be taken (unless you want to change the layout | |
335 | according to the orientation, which you could detect in idle time, for example). | |
336 | When input panel (SIP) is shown, top level windows (frames and dialogs) resize | |
3ed3a1c8 | 337 | accordingly (see wxTopLevelWindow::HandleSettingChange()). |
928f1a07 FM |
338 | |
339 | @subsubsection page_port_wxmsw_wince_toplevel Closing top-level windows in wxWinCE | |
340 | ||
341 | You won't get a wxCloseEvent when the user clicks on the X in the titlebar | |
342 | on Smartphone and PocketPC; the window is simply hidden instead. However the system may send the | |
343 | event to force the application to close down. | |
344 | ||
345 | @subsubsection page_port_wxmsw_wince_hibernation Hibernation in wxWinCE | |
346 | ||
3ed3a1c8 | 347 | Smartphone and PocketPC will send a @c wxEVT_HIBERNATE to the application object in low |
928f1a07 | 348 | memory conditions. Your application should release memory and close dialogs, |
3ed3a1c8 BP |
349 | and wake up again when the next @c wxEVT_ACTIVATE or @c wxEVT_ACTIVATE_APP message is received. |
350 | (@c wxEVT_ACTIVATE_APP is generated whenever a @c wxEVT_ACTIVATE event is received | |
351 | in Smartphone and PocketPC, since these platforms do not support @c WM_ACTIVATEAPP.) | |
928f1a07 FM |
352 | |
353 | @subsubsection page_port_wxmsw_wince_hwbutt Hardware buttons in wxWinCE | |
354 | ||
3ed3a1c8 | 355 | Special hardware buttons are sent to a window via the @c wxEVT_HOTKEY event |
928f1a07 | 356 | under Smartphone and PocketPC. You should first register each required button with |
3ed3a1c8 | 357 | wxWindow::RegisterHotKey(), and unregister the button when you're done with it. For example: |
928f1a07 | 358 | |
3ed3a1c8 | 359 | @code |
928f1a07 FM |
360 | win->RegisterHotKey(0, wxMOD_WIN, WXK_SPECIAL1); |
361 | win->UnregisterHotKey(0); | |
3ed3a1c8 | 362 | @endcode |
928f1a07 | 363 | |
3ed3a1c8 | 364 | You may have to register the buttons in a @c wxEVT_ACTIVATE event handler |
928f1a07 FM |
365 | since other applications will grab the buttons. |
366 | ||
367 | There is currently no method of finding out the names of the special | |
368 | buttons or how many there are. | |
3c4f71cc | 369 | |
928f1a07 | 370 | @subsubsection page_port_wxmsw_wince_dialogs Dialogs in wxWinCE |
3c4f71cc | 371 | |
928f1a07 FM |
372 | PocketPC dialogs have an OK button on the caption, and so you should generally |
373 | not repeat an OK button on the dialog. You can add a Cancel button if necessary, but some dialogs | |
374 | simply don't offer you the choice (the guidelines recommend you offer an Undo facility | |
375 | to make up for it). When the user clicks on the OK button, your dialog will receive | |
3ed3a1c8 BP |
376 | a @c wxID_OK event by default. If you wish to change this, call wxDialog::SetAffirmativeId() |
377 | with the required identifier to be used. Or, override wxDialog::DoOK() (return @false to | |
928f1a07 | 378 | have wxWidgets simply call Close to dismiss the dialog). |
3c4f71cc | 379 | |
928f1a07 FM |
380 | Smartphone dialogs do @e not have an OK button on the caption, and are closed |
381 | using one of the two menu buttons. You need to assign these using wxTopLevelWindow::SetLeftMenu | |
3ed3a1c8 | 382 | and wxTopLevelWindow::SetRightMenu(), for example: |
3c4f71cc | 383 | |
3ed3a1c8 | 384 | @code |
928f1a07 FM |
385 | #ifdef __SMARTPHONE__ |
386 | SetLeftMenu(wxID_OK); | |
387 | SetRightMenu(wxID_CANCEL, _("Cancel")); | |
388 | #elif defined(__POCKETPC__) | |
389 | // No OK/Cancel buttons on PocketPC, OK on caption will close | |
390 | #else | |
391 | topsizer->Add( CreateButtonSizer( wxOK|wxCANCEL ), 0, wxEXPAND | wxALL, 10 ); | |
392 | #endif | |
3ed3a1c8 | 393 | @endcode |
3c4f71cc | 394 | |
3ed3a1c8 | 395 | For implementing property sheets (flat tabs), use a wxNotebook with @c wxNB_FLAT|wxNB_BOTTOM |
928f1a07 FM |
396 | and have the notebook left, top and right sides overlap the dialog by about 3 pixels |
397 | to eliminate spurious borders. You can do this by using a negative spacing in your | |
398 | sizer Add() call. The cross-platform property sheet dialog wxPropertySheetDialog is | |
399 | provided, to show settings in the correct style on PocketPC and on other platforms. | |
3c4f71cc | 400 | |
928f1a07 FM |
401 | Notifications (bubble HTML text with optional buttons and links) will also be |
402 | implemented in the future for PocketPC. | |
3c4f71cc | 403 | |
928f1a07 FM |
404 | Modeless dialogs probably don't make sense for PocketPC and Smartphone, since |
405 | frames and dialogs are normally full-screen, and a modeless dialog is normally | |
406 | intended to co-exist with the main application frame. | |
3c4f71cc | 407 | |
928f1a07 | 408 | @subsubsection page_port_wxmsw_wince_ppc Menubars and toolbars in PocketPC |
3c4f71cc | 409 | |
928f1a07 FM |
410 | On PocketPC, a frame must always have a menubar, even if it's empty. |
411 | An empty menubar/toolbar is automatically provided for dialogs, to hide | |
412 | any existing menubar for the duration of the dialog. | |
413 | ||
414 | Menubars and toolbars are implemented using a combined control, | |
415 | but you can use essentially the usual wxWidgets API; wxWidgets will combine the menubar | |
416 | and toolbar. However, there are some restrictions: | |
417 | ||
3ed3a1c8 | 418 | @li You must create the frame's primary toolbar with wxFrame::CreateToolBar(), |
928f1a07 FM |
419 | because this uses the special wxToolMenuBar class (derived from wxToolBar) |
420 | to implement the combined toolbar and menubar. Otherwise, you can create and manage toolbars | |
421 | using the wxToolBar class as usual, for example to implement an optional | |
422 | formatting toolbar above the menubar as Pocket Word does. But don't assign | |
423 | a wxToolBar to a frame using SetToolBar - you should always use CreateToolBar | |
424 | for the main frame toolbar. | |
425 | @li Deleting and adding tools to wxToolMenuBar after Realize is called is not supported. | |
426 | @li For speed, colours are not remapped to the system colours as they are | |
427 | in wxMSW. Provide the tool bitmaps either with the correct system button background, | |
428 | or with transparency (for example, using XPMs). | |
429 | @li Adding controls to wxToolMenuBar is not supported. However, wxToolBar supports | |
430 | controls. | |
431 | ||
7ecc54df | 432 | Unlike in all other ports, a wxDialog has a wxToolBar automatically created |
3ed3a1c8 BP |
433 | for you. You may either leave it blank, or access it with wxDialog::GetToolBar() |
434 | and add buttons, then calling wxToolBar::Realize(). You cannot set or recreate | |
928f1a07 FM |
435 | the toolbar. |
436 | ||
437 | @subsubsection page_port_wxmsw_wince_smart Menubars and toolbars in Smartphone | |
438 | ||
439 | On Smartphone, there are only two menu buttons, so a menubar is simulated | |
440 | using a nested menu on the right menu button. Any toolbars are simply ignored on | |
441 | Smartphone. | |
442 | ||
443 | @subsubsection page_port_wxmsw_wince_closing Closing windows in wxWinCE | |
444 | ||
445 | The guidelines state that applications should not have a Quit menu item, | |
446 | since the user should not have to know whether an application is in memory | |
447 | or not. The close button on a window does not call the window's | |
448 | close handler; it simply hides the window. However, the guidelines say that | |
449 | the Ctrl+Q accelerator can be used to quit the application, so wxWidgets | |
450 | defines this accelerator by default and if your application handles | |
451 | wxID_EXIT, it will do the right thing. | |
452 | ||
453 | @subsubsection page_port_wxmsw_wince_ctx Context menus in wxWinCE | |
454 | ||
3ed3a1c8 | 455 | To enable context menus in PocketPC, you currently need to call wxWindow::EnableContextMenu(), |
928f1a07 FM |
456 | a wxWinCE-only function. Otherwise the context menu event (wxContextMenuEvent) will |
457 | never be sent. This API is subject to change. | |
458 | ||
459 | Context menus are not supported in Smartphone. | |
460 | ||
461 | @subsubsection page_port_wxmsw_wince_ctrl Control differences on wxWinCE | |
462 | ||
463 | These controls and styles are specific to wxWinCE: | |
464 | ||
3ed3a1c8 | 465 | @li wxTextCtrl The @c wxTE_CAPITALIZE style causes a CAPEDIT control to |
928f1a07 FM |
466 | be created, which capitalizes the first letter. |
467 | ||
468 | These controls are missing from wxWinCE: | |
469 | ||
470 | @li MDI classes MDI is not supported under Windows CE. | |
471 | @li wxMiniFrame Not supported under Windows CE. | |
472 | ||
473 | Tooltips are not currently supported for controls, since on PocketPC controls with | |
474 | tooltips are distinct controls, and it will be hard to add dynamic | |
475 | tooltip support. | |
476 | ||
477 | Control borders on PocketPC and Smartphone should normally be specified with | |
3ed3a1c8 | 478 | @c wxBORDER_SIMPLE instead of @c wxBORDER_SUNKEN. Controls will usually adapt |
928f1a07 | 479 | appropriately by virtue of their GetDefaultBorder() function, but if you |
3ed3a1c8 | 480 | wish to specify a style explicitly you can use @c wxDEFAULT_CONTROL_BORDER |
928f1a07 FM |
481 | which will give a simple border on PocketPC and Smartphone, and the sunken border on |
482 | other platforms. | |
483 | ||
484 | @subsubsection page_port_wxmsw_wince_help Online help in wxWinCE | |
485 | ||
486 | You can use the help controller wxWinceHelpController which controls | |
487 | simple @c .htm files, usually installed in the Windows directory. | |
488 | See the Windows CE reference for how to format the HTML files. | |
489 | ||
490 | @subsubsection page_port_wxmsw_wince_install Installing your PocketPC and Smartphone applications | |
491 | ||
492 | To install your application, you need to build a CAB file using | |
493 | the parameters defined in a special .inf file. The CabWiz program | |
494 | in your SDK will compile the CAB file from the .inf file and | |
495 | files that it specifies. | |
496 | ||
497 | For delivery, you can simply ask the user to copy the CAB file to the | |
498 | device and execute the CAB file using File Explorer. Or, you can | |
499 | write a program for the desktop PC that will find the ActiveSync | |
500 | Application Manager and install the CAB file on the device, | |
501 | which is obviously much easier for the user. | |
502 | ||
503 | Here are some links that may help. | |
504 | ||
505 | @li A setup builder that takes CABs and builds a setup program is at | |
506 | http://www.eskimo.com/~scottlu/win/index.html. | |
507 | @li Sample installation files can be found in | |
508 | <tt>Windows CE Tools/wce420/POCKET PC 2003/Samples/Win32/AppInst</tt>. | |
509 | @li An installer generator using wxPython can be found at | |
510 | http://ppcquicksoft.iespana.es/ppcquicksoft/myinstall.html. | |
511 | @li Miscellaneous Windows CE resources can be found at | |
512 | http://www.orbworks.com/pcce/resources.html. | |
513 | @li Installer creation instructions with a setup.exe for installing to PPC can be found at | |
514 | http://www.pocketpcdn.com/articles/creatingsetup.html. | |
515 | @li Microsoft instructions are at | |
516 | http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnce30/html/appinstall30.asp?frame=true | |
517 | @li Troubleshooting WinCE application installations: | |
518 | http://support.microsoft.com/default.aspx?scid=KB;en-us;q181007 | |
519 | ||
520 | You may also check out <tt>demos/life/setup/wince</tt> which contains | |
521 | scripts to create a PocketPC installation for ARM-based | |
522 | devices. In particular, @c build.bat builds the distribution and | |
523 | copies it to a directory called @c Deliver. | |
524 | ||
525 | @subsubsection page_port_wxmsw_wince_filedlg wxFileDialog in PocketPC | |
526 | ||
527 | Allowing the user to access files on memory cards, or on arbitrary | |
528 | parts of the filesystem, is a pain; the standard file dialog only | |
529 | shows folders under My Documents or folders on memory cards | |
530 | (not the system or card root directory, for example). This is | |
531 | a known problem for PocketPC developers. | |
532 | ||
533 | If you need a file dialog that allows access to all folders, | |
534 | you can use wxGenericFileDialog instead. You will need to include | |
535 | @c wx/generic/filedlgg.h. | |
536 | ||
537 | @subsubsection page_port_wxmsw_wince_evc Embedded Visual C++ Issues | |
538 | ||
539 | <b>Run-time type information</b> | |
540 | ||
541 | If you wish to use runtime type information (RTTI) with eVC++ 4, you need to download | |
542 | an extra library, @c ccrtrtti.lib, and link with it. At the time of | |
543 | writing you can get it from here: | |
544 | ||
545 | @verbatim | |
546 | http://support.microsoft.com/kb/830482/en-us | |
547 | @endverbatim | |
548 | ||
549 | Otherwise you will get linker errors similar to this: | |
550 | ||
551 | @verbatim | |
552 | wxwince26d.lib(control.obj) : error LNK2001: unresolved external symbol "const type_info::`vftable'" (??_7type_info@@6B@) | |
553 | @endverbatim | |
554 | ||
555 | <b>Windows Mobile 5.0 emulator</b> | |
556 | ||
557 | Note that there is no separate emulator configuration for Windows Mobile 5.0: the | |
558 | emulator runs the ARM code directly. | |
559 | ||
560 | <b>Visual Studio 2005 project files</b> | |
561 | ||
562 | Unfortunately, Visual Studio 2005, required to build Windows Mobile 5.0 applications, | |
563 | doesn't do a perfect job of converting the project files from eVC++ format. | |
564 | ||
565 | When you have converted the wxWidgets workspace, edit the configuration properties | |
566 | for each configuration and in the Librarian, add a relative path ..\\..\\lib to | |
567 | each library path. For example: | |
568 | <tt>..\\$(PlatformName)\\$(ConfigurationName)\\wx_mono.lib</tt>. | |
569 | ||
570 | Then, for a sample you want to compile, edit the configuration properties | |
571 | and make sure | |
572 | <tt>..\\..\\lib\\$(PlatformName)\\$(ConfigurationName)</tt> | |
573 | is in the Linker/General/Additional Library Directories property. | |
574 | Also change the Linker/Input/Additional Dependencies property to something like | |
575 | <tt>coredll.lib wx_mono.lib wx_wxjpeg.lib wx_wxpng.lib wx_wxzlib.lib wx_wxexpat.lib | |
576 | commctrl.lib winsock.lib wininet.lib</tt> | |
577 | (since the library names in the wxWidgets workspace were changed by VS 2005). | |
578 | ||
7ecc54df | 579 | Alternately, you could edit all the names to be identical to the original eVC++ |
928f1a07 FM |
580 | names, but this will probably be more fiddly. |
581 | ||
582 | @subsubsection page_port_wxmsw_wince_issues Remaining issues | |
583 | ||
584 | These are some of the remaining problems to be sorted out, and features | |
585 | to be supported. | |
586 | ||
587 | @li <b>Windows Mobile 5 issues.</b> It is not possible to get the HMENU for | |
588 | the command bar on Mobile 5, so the menubar functions need to be rewritten | |
589 | to get the individual menus without use of a menubar handle. Also the | |
590 | new Mobile 5 convention of using only two menus (and no bitmap buttons) needs to be | |
591 | considered. | |
592 | @li <b>Sizer speed.</b> Particularly for dialogs containing notebooks, | |
593 | layout seems slow. Some analysis is required. | |
594 | @li <b>Notification boxes.</b> The balloon-like notification messages, and their | |
595 | icons, should be implemented. This will be quite straightforward. | |
596 | @li <b>SIP size.</b> We need to be able to get the area taken up by the SIP (input panel), | |
597 | and the remaining area, by calling SHSipInfo. We also may need to be able to show and hide | |
598 | the SIP programmatically, with SHSipPreference. See also the <em>Input Dialogs</em> topic in | |
599 | the <em>Programming Windows CE</em> guide for more on this, and how to have dialogs | |
3ed3a1c8 | 600 | show the SIP automatically using the @c WC_SIPREF control. |
928f1a07 FM |
601 | @li <b>wxStaticBitmap.</b> The About box in the "Life!" demo shows a bitmap that is |
602 | the correct size on the emulator, but too small on a VGA Pocket Loox device. | |
603 | @li <b>wxStaticLine.</b> Lines don't show up, and the documentation suggests that | |
3ed3a1c8 | 604 | missing styles are implemented with @c WM_PAINT. |
928f1a07 FM |
605 | @li <b>HTML control.</b> PocketPC has its own HTML control which can be used for showing |
606 | local pages or navigating the web. We should create a version of wxHtmlWindow that uses this | |
607 | control, or have a separately-named control (wxHtmlCtrl), with a syntax as close as possible | |
608 | to wxHtmlWindow. | |
609 | @li <b>Tooltip control.</b> PocketPC uses special TTBUTTON and TTSTATIC controls for adding | |
610 | tooltips, with the tooltip separated from the label with a double tilde. We need to support | |
611 | this using SetToolTip.(Unfortunately it does not seem possible to dynamically remove the tooltip, | |
612 | so an extra style may be required.) | |
613 | @li <b>Focus.</b> In the wxPropertySheetDialog demo on Smartphone, it's not possible to navigate | |
614 | between controls. The focus handling in wxWidgets needs investigation. See in particular | |
615 | src/common/containr.cpp, and note that the default OnActivate handler in src/msw/toplevel.cpp | |
616 | sets the focus to the first child of the dialog. | |
617 | @li <b>OK button.</b> We should allow the OK button on a dialog to be optional, perhaps | |
3ed3a1c8 | 618 | by using @c wxCLOSE_BOX to indicate when the OK button should be displayed. |
928f1a07 FM |
619 | @li <b>Dynamic adaptation.</b> We should probably be using run-time tests more |
620 | than preprocessor tests, so that the same WinCE application can run on different | |
621 | versions of the operating system. | |
622 | @li <b>Modeless dialogs.</b> When a modeless dialog is hidden with the OK button, it doesn't restore the | |
623 | frame's menubar. See for example the find dialog in the dialogs sample. However, the menubar is restored | |
624 | if pressing Cancel (the window is closed). This reflects the fact that modeless dialogs are | |
625 | not very useful on Windows CE; however, we could perhaps destroy/restore a modeless dialog's menubar | |
626 | on deactivation and activation. | |
627 | @li <b>Home screen plugins.</b> Figure out how to make home screen plugins for use with wxWidgets | |
628 | applications (see http://www.codeproject.com/ce/CTodayWindow.asp for inspiration). | |
629 | Although we can't use wxWidgets to create the plugin (too large), we could perhaps write | |
630 | a generic plugin that takes registry information from a given application, with | |
631 | options to display information in a particular way using icons and text from | |
632 | a specified location. | |
633 | @li <b>Further abstraction.</b> We should be able to abstract away more of the differences | |
634 | between desktop and mobile applications, in particular for sizer layout. | |
635 | @li <b>Dialog captions.</b> The blue, bold captions on dialogs - with optional help button - | |
636 | should be catered for, either by hard-wiring the capability into all dialogs and panels, | |
637 | or by providing a standard component and sizer. | |
638 | ||
639 | ||
640 | @section page_port_nativedocs Documentation for the native toolkits | |
641 | ||
642 | It's sometimes useful to interface directly with the underlying toolkit | |
643 | used by wxWidgets to e.g. use toolkit-specific features. | |
644 | In such case (or when you want to e.g. write a port-specific patch) it can be | |
645 | necessary to use the underlying toolkit API directly: | |
646 | ||
bce3699f FM |
647 | - wxMSW port uses win32 API: see MSDN docs at http://msdn2.microsoft.com/en-us/library/ms649779.aspx |
648 | - wxGTK port uses GTK+ and other lower-level libraries; see | |
649 | - GTK+ docs at http://library.gnome.org/devel/gtk/unstable/ | |
650 | - GDK docs at http://library.gnome.org/devel/gdk/unstable/ | |
651 | - GLib docs at http://library.gnome.org/devel/glib/unstable/ | |
652 | - GObject docs at http://library.gnome.org/devel/gobject/unstable/ | |
653 | - Pango docs at http://library.gnome.org/devel/pango/unstable/ | |
654 | - wxMac port uses the Carbon API: see Carbon docs at http://developer.apple.com/carbon | |
655 | - wxCocoa port uses the Cocoa API: see Cocoa docs at http://developer.apple.com/cocoa | |
4514447c FM |
656 | |
657 | */ |