Consider wxOSX the port name, and have wxOSX/Carbon and wxOSX/Cocoa as variations, so that linkages from function docs are left intact. Also, do a little cleanup and elaborate more in the docs for OS X Cocoa and OS X Carbon.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59545 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Kevin Ollivier
2009-03-15 01:19:09 +00:00
parent 1729acd85b
commit 0f6c9085a5
7 changed files with 27 additions and 24 deletions

View File

@@ -19,8 +19,7 @@ requires. This chapter collects notes about differences among supported platform
and ports. and ports.
@li @ref page_port_wxgtk @li @ref page_port_wxgtk
@li @ref page_port_wxosx_carbon @li @ref page_port_wxosx
@li @ref page_port_wxosx_cocoa
@li @ref page_port_wxos2 @li @ref page_port_wxos2
@li @ref page_port_wxmgl @li @ref page_port_wxmgl
@li @ref page_port_wxx11 @li @ref page_port_wxx11
@@ -71,15 +70,15 @@ For further information, please see the files in @c docs/gtk
in the distribution. in the distribution.
@section page_port_wxosx wxOSX
@section page_port_wxosx_carbon wxOSX/Carbon
@htmlonly @htmlonly
<img src="logo_osxleopard.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"> title="Mac OS X (Leopard) logo" class="logo">
@endhtmlonly @endhtmlonly
@subsection page_port_wxosx_carbon wxOSX/Carbon
wxOSX/Carbon is a port of wxWidgets for the Macintosh OS platform. wxOSX/Carbon is a port of wxWidgets for the Macintosh OS platform.
Currently MacOS X 10.4 or higher are supported. wxOSX/Carbon can Currently MacOS X 10.4 or higher are supported. wxOSX/Carbon can
be compiled both using Apple's command line developer tools be compiled both using Apple's command line developer tools
@@ -90,17 +89,16 @@ both architecture. Unfortunately, wxOSX/Carbon does not support any
64-bit architecture since Apple decided not to port its Carbon 64-bit architecture since Apple decided not to port its Carbon
API entirely to 64-bit. API entirely to 64-bit.
@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 For further information, please see the files in @c docs/osx
in the distribution. in the distribution.
@section page_port_wxosx_cocoa wxOSX/Cocoa @subsection page_port_wxosx_cocoa wxOSX/Cocoa
@htmlonly
<img src="logo_osxleopard.png" alt="Mac OS X (Leopard) logo"
title="Mac OS X (Leopard) logo" class="logo">
@endhtmlonly
wxOSX/Cocoa is another port of wxWidgets for the Macintosh OS wxOSX/Cocoa is another port of wxWidgets for the Macintosh OS
platform. In contrast to wxOSX/Carbon, it uses the Cocoa API platform. In contrast to wxOSX/Carbon, it uses the Cocoa API
@@ -109,10 +107,15 @@ controls are functional, but the port has not reached the maturity
of the wxOSX/Carbon port yet. It is possible to use wxOSX/Cocoa of the wxOSX/Carbon port yet. It is possible to use wxOSX/Cocoa
on 64-bit architectures. 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 For further information, please see the files in @c docs/osx
in the distribution. in the distribution.
Note that there was a previous effort towards a Cocoa port called @note There was a previous effort towards a Cocoa port called
wxCocoa, which was implemented totally with Cocoa API unlike the OSX/Cocoa port 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 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. developed, docs for it are available in @c docs/cocoa in the distribution.

View File

@@ -212,7 +212,7 @@ public:
Called in response of an "open-application" Apple event. Called in response of an "open-application" Apple event.
Override this to create a new document in your app. Override this to create a new document in your app.
@onlyfor{wxmac} @onlyfor{wxosx}
*/ */
virtual void MacNewFile(); virtual void MacNewFile();
@@ -223,28 +223,28 @@ public:
user double clicked on it or if the document file was dropped on either the user double clicked on it or if the document file was dropped on either the
running application or the application icon in Finder. running application or the application icon in Finder.
@onlyfor{wxmac} @onlyfor{wxosx}
*/ */
virtual void MacOpenFile(const wxString& fileName); virtual void MacOpenFile(const wxString& fileName);
/** /**
Called in response of a "get-url" Apple event. Called in response of a "get-url" Apple event.
@onlyfor{wxmac} @onlyfor{wxosx}
*/ */
virtual void MacOpenURL(const wxString& url); virtual void MacOpenURL(const wxString& url);
/** /**
Called in response of a "print-document" Apple event. Called in response of a "print-document" Apple event.
@onlyfor{wxmac} @onlyfor{wxosx}
*/ */
virtual void MacPrintFile(const wxString& fileName); virtual void MacPrintFile(const wxString& fileName);
/** /**
Called in response of a "reopen-application" Apple event. Called in response of a "reopen-application" Apple event.
@onlyfor{wxmac} @onlyfor{wxosx}
*/ */
virtual void MacReopenApp(); virtual void MacReopenApp();

View File

@@ -192,7 +192,7 @@ public:
icons for GTK. You should use the macro wxDROP_ICON() in portable icons for GTK. You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types. programs instead of directly using either of these types.
@onlyfor{wxmsw,wxmac} @onlyfor{wxmsw,wxosx}
@param win @param win
The window which initiates the drag and drop operation. The window which initiates the drag and drop operation.
@@ -216,7 +216,7 @@ public:
icons for GTK. You should use the macro wxDROP_ICON() in portable icons for GTK. You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types. programs instead of directly using either of these types.
@onlyfor{wxmsw,wxmac} @onlyfor{wxmsw,wxosx}
@param data @param data
The data associated with the drop source. The data associated with the drop source.

View File

@@ -94,7 +94,7 @@ public:
@param height @param height
The height of the image. The height of the image.
@onlyfor{wxmsw,wxmac} @onlyfor{wxmsw,wxosx}
*/ */
wxIcon(const char bits[], int width, int height); wxIcon(const char bits[], int width, int height);

View File

@@ -101,7 +101,7 @@ public:
matching the dimensions of the image list. matching the dimensions of the image list.
This does not apply when adding icons. This does not apply when adding icons.
@onlyfor{wxmsw,wxmac} @onlyfor{wxmsw,wxosx}
*/ */
int Add(const wxIcon& icon); int Add(const wxIcon& icon);
@@ -209,7 +209,7 @@ public:
@remarks The original bitmap or icon is not affected by the Replace() @remarks The original bitmap or icon is not affected by the Replace()
operation, and can be deleted afterwards. operation, and can be deleted afterwards.
@onlyfor{wxmsw,wxmac} @onlyfor{wxmsw,wxosx}
*/ */
bool Replace(int index, const wxIcon& icon); bool Replace(int index, const wxIcon& icon);
}; };

View File

@@ -276,7 +276,7 @@ public:
Sets the bitmap for the menu item. Sets the bitmap for the menu item.
It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap). It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap).
@onlyfor{wxmsw,wxmac,wxgtk} @onlyfor{wxmsw,wxosx,wxgtk}
*/ */
virtual void SetBitmap(const wxBitmap& bmp); virtual void SetBitmap(const wxBitmap& bmp);

View File

@@ -182,7 +182,7 @@ public:
@param stipple @param stipple
A stipple bitmap. A stipple bitmap.
@onlyfor{wxmsw,wxmac} @onlyfor{wxmsw,wxosx}
@see SetWidth(), SetStipple() @see SetWidth(), SetStipple()
*/ */