// Purpose: Platform details page of the Doxygen manual
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
and ports.
@li @ref page_port_wxgtk
-@li @ref page_port_wxmac
-@li @ref page_port_wxcocoa
+@li @ref page_port_wxosx
@li @ref page_port_wxos2
@li @ref page_port_wxmgl
@li @ref page_port_wxx11
+@li @ref page_port_wxmotif
@li @ref page_port_wxmsw
@li @ref page_port_nativedocs
@section page_port_wxgtk wxGTK
@htmlonly
-<img src="gtk_logo.png" alt="GTK logo" title="GTK logo" class="logo">
+<img src="logo_gtk.png" alt="GTK logo" title="GTK logo" class="logo">
@endhtmlonly
wxGTK is a port of wxWidgets using the GTK+ library.
http://www.gtk.org
The newer version of GTK+ you use, the more native widgets and
-features will be utilized. We have gone to a great extent to
-allow compiling wxWidgets applications with a latest version of
+features will be utilized. We have gone to great lengths to
+allow compiling wxWidgets applications with the latest version of
GTK+, with the resulting binary working on systems even with a
-much lower version of GTK+. You will have to ensure that the
+much earlier version of GTK+. You will have to ensure that the
application is launched with lazy symbol binding for that.
In order to configure wxWidgets to compile wxGTK you will
GTK+ 1.2 can still be used, albeit discouraged. For that you can
pass @c --with-gtk=1 to the @c configure script.
-For further information, please see the files in docs/gtk
+For further information, please see the files in @c docs/gtk
in the distribution.
-
-
-@section page_port_wxmac wxMac
+@section page_port_wxosx wxOSX
@htmlonly
-<img src="osxleopard_logo.png" alt="Mac OS X (Leopard) logo"
+<img src="logo_osxleopard.png" alt="Mac OS X (Leopard) logo"
title="Mac OS X (Leopard) logo" class="logo">
@endhtmlonly
-wxMac is a port of wxWidgets for the Macintosh OS platform.
-Currently MacOS X 10.4 or higher are supported. wxMac can
+@subsection page_port_wxosx_carbon wxOSX/Carbon
+
+wxOSX/Carbon is a port of wxWidgets for the Macintosh OS platform.
+Currently MacOS X 10.4 or higher are supported. wxOSX/Carbon can
be compiled both using Apple's command line developer tools
-as well as Apple's XCode IDE. wxMac supports both the Intel
+as well as Apple's Xcode IDE. wxOSX/Carbon supports both the Intel
and PowerPC architectures and can be used to produce
"universal binaries" in order create application which can run
-both architecture. Unfortunately, wxMac does not support any
+both architecture. Unfortunately, wxOSX/Carbon does not support any
64-bit architecture since Apple decided not to port its Carbon
API entirely to 64-bit.
-For further information, please see the files in docs/mac
-in the distribution.
+@note Carbon has been deprecated by Apple as of OS X 10.5 and will likely
+be removed entirely in a future OS version. It's recommended you look into
+switching your app over to wxOSX/Cocoa as soon as possible.
+For further information, please see the files in @c docs/osx
+in the distribution.
-@section page_port_wxmac wxCocoa
-@htmlonly
-<img src="osxleopard_logo.png" alt="Mac OS X (Leopard) logo"
- title="Mac OS X (Leopard) logo" class="logo">
-@endhtmlonly
+@subsection page_port_wxosx_cocoa wxOSX/Cocoa
-wxCocoa is another port of wxWidgets for the Macintosh OS
-platform. But in contrat to wxMac, it uses the Cocoa API.
-Much work has gone into this port and many controls are
-functional, but the port has not reached the maturity
-of the wxMac port yet. It should be possible to use wxCocoa
+wxOSX/Cocoa is another port of wxWidgets for the Macintosh OS
+platform. In contrast to wxOSX/Carbon, it uses the Cocoa API
+in place of Carbon. Much work has gone into this port and many
+controls are functional, but the port has not reached the maturity
+of the wxOSX/Carbon port yet. It is possible to use wxOSX/Cocoa
on 64-bit architectures.
+In order to configure wxWidgets to compile wxOSX/Cocoa you will
+need to type:
+
+@verbatim configure --with-osx_cocoa @endverbatim
+
+For further information, please see the files in @c docs/osx
+in the distribution.
+
+@note There was a previous effort towards a Cocoa port called
+wxCocoa, which was implemented totally with Cocoa API unlike the OSX/Cocoa port
+which uses OS X C APIs to share code, and while it is no longer being actively
+developed, docs for it are available in @c docs/cocoa in the distribution.
+
+
@section page_port_wxmgl wxMGL
Under DOS, wxMGL uses a dmake based make system.
-For further information, please see the files in docs/mgl
+For further information, please see the files in @c docs/mgl
in the distribution.
wxOS2 is a port of wxWidgets for the IBM OS/2 Warp3 and Warp4 platforms.
This port is currently under construction and in beta phase.
+For further information, please see the files in @c docs/os2
+in the distribution.
+
@section page_port_wxx11 wxX11
@htmlonly
-<img src="x11_logo.png" alt="X.org logo" title="X.org logo" class="logo">
+<img src="logo_x11.png" alt="X.org logo" title="X.org logo" class="logo">
@endhtmlonly
wxX11 is a port of wxWidgets using X11 (The X Window System)
using the wxUniversal widget set which is now part of wxWidgets.
wxX11 is well-suited for a number of special applications such
as those running on systems with few resources (PDAs) or for
-applications which need to use a special themed look.
+applications which need to use a special themed look.
In order to configure wxWidgets to compile wxX11 you will
need to type:
@verbatim configure --with-x11 --with-universal @endverbatim
-For further information, please see the files in docs/x11
+For further information, please see the files in @c docs/x11
in the distribution. There is also a page on the use of
wxWidgets for embedded applications on the wxWidgets web site.
+@section page_port_wxmotif wxMotif
+
+@htmlonly
+<img src="logo_motif.png" alt="Motif logo" title="Motif logo" class="logo">
+@endhtmlonly
+
+wxMotif is a port of wxWidgets for X11 systems using Motif libraries.
+Motif libraries provide a clean and fast user interface at the expense
+of the beauty and candy of newer interfaces like GTK.
+
+For further information, please see the files in @c docs/motif
+in the distribution.
+
+
@section page_port_wxmsw wxMSW
@htmlonly
-<img src="win_logo.png" alt="Windows logo" title="Windows logo" class="logo">
+<img src="logo_win.png" alt="Windows logo" title="Windows logo" class="logo">
@endhtmlonly
-wxMSW is a port of wxWidgets for the Windows platforms
-including Windows 95, 98, ME, 2000, NT, XP in ANSI and
-Unicode mode (for Windows 95 through the MSLU extension
-library). wxMSW ensures native look and feel for XP
-as well when using wxWidgets version 2.3.3 or higher.
-wxMSW can be compile with a great variety of compilers
-including MS VC++, Borland 5.5, MinGW32, Cygwin and
-Watcom as well as cross-compilation with a Linux hosted
+wxMSW is a port of wxWidgets for the Windows platforms including Windows 95,
+98, ME, 2000, NT, XP and Vista in ANSI and Unicode modes (for Windows 9x and
+ME through the MSLU extension library). wxMSW ensures native look and feel for
+XP when using wxWidgets version 2.3.3 or higher.wxMSW can be compiled with a
+great variety of compilers including Microsoft Studio VC++, Borland 5.5,
+MinGW32, Cygwin and Watcom as well as cross-compilation with a Linux-hosted
MinGW32 tool chain.
For further information, please see the files in docs/msw
@subsection page_port_wxmsw_themedborders Themed borders on Windows
-Starting with wxWidgets 2.8.5, you can specify the wxBORDER_THEME style to have wxWidgets
+Starting with wxWidgets 2.8.5, you can specify the @c wxBORDER_THEME style to have wxWidgets
use a themed border. Using the default XP theme, this is a thin 1-pixel blue border,
with an extra 1-pixel border in the window client background colour (usually white) to
separate the client area's scrollbars from the border.
If you don't specify a border style for a wxTextCtrl in rich edit mode, wxWidgets now gives
the control themed borders automatically, where previously they would take the Windows 95-style
-sunken border. Other native controls such as wxTextCtrl in non-rich edit mode, and wxComboBox,
+sunken border. Other native controls such as wxTextCtrl in non-rich edit mode, and wxComboBox
already paint themed borders where appropriate. To use themed borders on other windows, such
-as wxPanel, pass the wxBORDER_THEME style, or (apart from wxPanel) pass no border style.
+as wxPanel, pass the @c wxBORDER_THEME style, or (apart from wxPanel) pass no border style.
-In general, specifying wxBORDER_THEME will cause a border of some kind to be used, chosen by the platform
-and control class. To leave the border decision entirely to wxWidgets, pass wxBORDER_DEFAULT.
-This is not to be confused with specifying wxBORDER_NONE, which says that there should
+In general, specifying @c wxBORDER_THEME will cause a border of some kind to be used, chosen by the platform
+and control class. To leave the border decision entirely to wxWidgets, pass @c wxBORDER_DEFAULT.
+This is not to be confused with specifying @c wxBORDER_NONE, which says that there should
definitely be @e no border.
@subsubsection page_port_wxmsw_themedborders_details More detail on border implementation
the amount of spacing used by sizers, for which you can
use a macro such as this:
-@verbatim
+@code
#if defined(__WXWINCE__)
#define wxLARGESMALL(large,small) small
#else
// Usage
topsizer->Add( CreateTextSizer( message ), 0, wxALL, wxLARGESMALL(10,0) );
-@endverbatim
+@endcode
There is only ever one instance of a Windows CE application running,
and wxWidgets will take care of showing the current instance and
so no further action needs to be taken (unless you want to change the layout
according to the orientation, which you could detect in idle time, for example).
When input panel (SIP) is shown, top level windows (frames and dialogs) resize
-accordingly (see wxTopLevelWindow::HandleSettingChange).
+accordingly (see wxTopLevelWindow::HandleSettingChange()).
@subsubsection page_port_wxmsw_wince_toplevel Closing top-level windows in wxWinCE
@subsubsection page_port_wxmsw_wince_hibernation Hibernation in wxWinCE
-Smartphone and PocketPC will send a wxEVT_HIBERNATE to the application object in low
+Smartphone and PocketPC will send a @c wxEVT_HIBERNATE to the application object in low
memory conditions. Your application should release memory and close dialogs,
-and wake up again when the next wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP message is received.
-(wxEVT_ACTIVATE_APP is generated whenever a wxEVT_ACTIVATE event is received
-in Smartphone and PocketPC, since these platforms do not support WM_ACTIVATEAPP.)
+and wake up again when the next @c wxEVT_ACTIVATE or @c wxEVT_ACTIVATE_APP message is received.
+(@c wxEVT_ACTIVATE_APP is generated whenever a @c wxEVT_ACTIVATE event is received
+in Smartphone and PocketPC, since these platforms do not support @c WM_ACTIVATEAPP.)
@subsubsection page_port_wxmsw_wince_hwbutt Hardware buttons in wxWinCE
-Special hardware buttons are sent to a window via the wxEVT_HOTKEY event
+Special hardware buttons are sent to a window via the @c wxEVT_HOTKEY event
under Smartphone and PocketPC. You should first register each required button with
-wxWindow::RegisterHotKey, and unregister the button when you're done with it. For example:
+wxWindow::RegisterHotKey(), and unregister the button when you're done with it. For example:
-@verbatim
+@code
win->RegisterHotKey(0, wxMOD_WIN, WXK_SPECIAL1);
win->UnregisterHotKey(0);
-@endverbatim
+@endcode
-You may have to register the buttons in a wxEVT_ACTIVATE event handler
+You may have to register the buttons in a @c wxEVT_ACTIVATE event handler
since other applications will grab the buttons.
There is currently no method of finding out the names of the special
not repeat an OK button on the dialog. You can add a Cancel button if necessary, but some dialogs
simply don't offer you the choice (the guidelines recommend you offer an Undo facility
to make up for it). When the user clicks on the OK button, your dialog will receive
-a wxID_OK event by default. If you wish to change this, call wxDialog::SetAffirmativeId
-with the required identifier to be used. Or, override wxDialog::DoOK (return @false to
+a @c wxID_OK event by default. If you wish to change this, call wxDialog::SetAffirmativeId()
+with the required identifier to be used. Or, override wxDialog::DoOK() (return @false to
have wxWidgets simply call Close to dismiss the dialog).
Smartphone dialogs do @e not have an OK button on the caption, and are closed
using one of the two menu buttons. You need to assign these using wxTopLevelWindow::SetLeftMenu
-and wxTopLevelWindow::SetRightMenu, for example:
+and wxTopLevelWindow::SetRightMenu(), for example:
-@verbatim
+@code
#ifdef __SMARTPHONE__
SetLeftMenu(wxID_OK);
SetRightMenu(wxID_CANCEL, _("Cancel"));
#else
topsizer->Add( CreateButtonSizer( wxOK|wxCANCEL ), 0, wxEXPAND | wxALL, 10 );
#endif
-@endverbatim
+@endcode
-For implementing property sheets (flat tabs), use a wxNotebook with wxNB_FLAT|wxNB_BOTTOM
+For implementing property sheets (flat tabs), use a wxNotebook with @c wxNB_FLAT|wxNB_BOTTOM
and have the notebook left, top and right sides overlap the dialog by about 3 pixels
to eliminate spurious borders. You can do this by using a negative spacing in your
sizer Add() call. The cross-platform property sheet dialog wxPropertySheetDialog is
but you can use essentially the usual wxWidgets API; wxWidgets will combine the menubar
and toolbar. However, there are some restrictions:
-@li You must create the frame's primary toolbar with wxFrame::CreateToolBar,
+@li You must create the frame's primary toolbar with wxFrame::CreateToolBar(),
because this uses the special wxToolMenuBar class (derived from wxToolBar)
to implement the combined toolbar and menubar. Otherwise, you can create and manage toolbars
using the wxToolBar class as usual, for example to implement an optional
@li Adding controls to wxToolMenuBar is not supported. However, wxToolBar supports
controls.
-Unlike in all other ports, a wxDialog has a wxToolBar, automatically created
-for you. You may either leave it blank, or access it with wxDialog::GetToolBar
-and add buttons, then calling wxToolBar::Realize. You cannot set or recreate
+Unlike in all other ports, a wxDialog has a wxToolBar automatically created
+for you. You may either leave it blank, or access it with wxDialog::GetToolBar()
+and add buttons, then calling wxToolBar::Realize(). You cannot set or recreate
the toolbar.
@subsubsection page_port_wxmsw_wince_smart Menubars and toolbars in Smartphone
@subsubsection page_port_wxmsw_wince_ctx Context menus in wxWinCE
-To enable context menus in PocketPC, you currently need to call wxWindow::EnableContextMenu,
+To enable context menus in PocketPC, you currently need to call wxWindow::EnableContextMenu(),
a wxWinCE-only function. Otherwise the context menu event (wxContextMenuEvent) will
never be sent. This API is subject to change.
These controls and styles are specific to wxWinCE:
-@li wxTextCtrl The wxTE_CAPITALIZE style causes a CAPEDIT control to
+@li wxTextCtrl The @c wxTE_CAPITALIZE style causes a CAPEDIT control to
be created, which capitalizes the first letter.
These controls are missing from wxWinCE:
tooltip support.
Control borders on PocketPC and Smartphone should normally be specified with
-wxBORDER_SIMPLE instead of wxBORDER_SUNKEN. Controls will usually adapt
+@c wxBORDER_SIMPLE instead of @c wxBORDER_SUNKEN. Controls will usually adapt
appropriately by virtue of their GetDefaultBorder() function, but if you
-wish to specify a style explicitly you can use wxDEFAULT_CONTROL_BORDER
+wish to specify a style explicitly you can use @c wxDEFAULT_CONTROL_BORDER
which will give a simple border on PocketPC and Smartphone, and the sunken border on
other platforms.
commctrl.lib winsock.lib wininet.lib</tt>
(since the library names in the wxWidgets workspace were changed by VS 2005).
-Alternately, you could could edit all the names to be identical to the original eVC++
+Alternately, you could edit all the names to be identical to the original eVC++
names, but this will probably be more fiddly.
@subsubsection page_port_wxmsw_wince_issues Remaining issues
and the remaining area, by calling SHSipInfo. We also may need to be able to show and hide
the SIP programmatically, with SHSipPreference. See also the <em>Input Dialogs</em> topic in
the <em>Programming Windows CE</em> guide for more on this, and how to have dialogs
-show the SIP automatically using the WC_SIPREF control.
+show the SIP automatically using the @c WC_SIPREF control.
@li <b>wxStaticBitmap.</b> The About box in the "Life!" demo shows a bitmap that is
the correct size on the emulator, but too small on a VGA Pocket Loox device.
@li <b>wxStaticLine.</b> Lines don't show up, and the documentation suggests that
-missing styles are implemented with WM_PAINT.
+missing styles are implemented with @c WM_PAINT.
@li <b>HTML control.</b> PocketPC has its own HTML control which can be used for showing
local pages or navigating the web. We should create a version of wxHtmlWindow that uses this
control, or have a separately-named control (wxHtmlCtrl), with a syntax as close as possible
src/common/containr.cpp, and note that the default OnActivate handler in src/msw/toplevel.cpp
sets the focus to the first child of the dialog.
@li <b>OK button.</b> We should allow the OK button on a dialog to be optional, perhaps
-by using wxCLOSE_BOX to indicate when the OK button should be displayed.
+by using @c wxCLOSE_BOX to indicate when the OK button should be displayed.
@li <b>Dynamic adaptation.</b> We should probably be using run-time tests more
than preprocessor tests, so that the same WinCE application can run on different
versions of the operating system.
In such case (or when you want to e.g. write a port-specific patch) it can be
necessary to use the underlying toolkit API directly:
-@li wxMSW port uses win32 API: see MSDN docs at http://msdn2.microsoft.com/en-us/library/ms649779.aspx
-@li wxGTK port uses GTK+: see GTK+ 2.x docs at http://developer.gnome.org/doc/API/2.0/gtk/index.html
-@li wxMac port uses the Carbon API: see Carbon docs at http://developer.apple.com/carbon
-@li wxCocoa port uses the Cocoa API: see Cocoa docs at http://developer.apple.com/carbon
+- wxMSW port uses win32 API: see MSDN docs at http://msdn2.microsoft.com/en-us/library/ms649779.aspx
+- wxGTK port uses GTK+ and other lower-level libraries; see
+ - GTK+ docs at http://library.gnome.org/devel/gtk/unstable/
+ - GDK docs at http://library.gnome.org/devel/gdk/unstable/
+ - GLib docs at http://library.gnome.org/devel/glib/unstable/
+ - GObject docs at http://library.gnome.org/devel/gobject/unstable/
+ - Pango docs at http://library.gnome.org/devel/pango/unstable/
+- wxMac port uses the Carbon API: see Carbon docs at http://developer.apple.com/carbon
+- wxCocoa port uses the Cocoa API: see Cocoa docs at http://developer.apple.com/cocoa
*/
projects / wxWidgets.git / blobdiff