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