From 0f6c9085a50548c48d49874ff64c4928ba053c0c Mon Sep 17 00:00:00 2001 From: Kevin Ollivier Date: Sun, 15 Mar 2009 01:19:09 +0000 Subject: [PATCH] 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 --- docs/doxygen/mainpages/platdetails.h | 27 +++++++++++++++------------ interface/wx/app.h | 10 +++++----- interface/wx/dnd.h | 4 ++-- interface/wx/icon.h | 2 +- interface/wx/imaglist.h | 4 ++-- interface/wx/menuitem.h | 2 +- interface/wx/pen.h | 2 +- 7 files changed, 27 insertions(+), 24 deletions(-) diff --git a/docs/doxygen/mainpages/platdetails.h b/docs/doxygen/mainpages/platdetails.h index 55b6d741d3..7a25cd4c10 100644 --- a/docs/doxygen/mainpages/platdetails.h +++ b/docs/doxygen/mainpages/platdetails.h @@ -19,8 +19,7 @@ requires. This chapter collects notes about differences among supported platform and ports. @li @ref page_port_wxgtk -@li @ref page_port_wxosx_carbon -@li @ref page_port_wxosx_cocoa +@li @ref page_port_wxosx @li @ref page_port_wxos2 @li @ref page_port_wxmgl @li @ref page_port_wxx11 @@ -71,15 +70,15 @@ For further information, please see the files in @c docs/gtk in the distribution. - - -@section page_port_wxosx_carbon wxOSX/Carbon +@section page_port_wxosx wxOSX @htmlonly @endhtmlonly +@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 @@ -90,17 +89,16 @@ 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. +@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_wxosx_cocoa wxOSX/Cocoa - -@htmlonly - -@endhtmlonly +@subsection page_port_wxosx_cocoa wxOSX/Cocoa wxOSX/Cocoa is another port of wxWidgets for the Macintosh OS 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 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 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 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. diff --git a/interface/wx/app.h b/interface/wx/app.h index 7bc9844834..4053532457 100644 --- a/interface/wx/app.h +++ b/interface/wx/app.h @@ -212,7 +212,7 @@ public: Called in response of an "open-application" Apple event. Override this to create a new document in your app. - @onlyfor{wxmac} + @onlyfor{wxosx} */ virtual void MacNewFile(); @@ -223,28 +223,28 @@ public: user double clicked on it or if the document file was dropped on either the running application or the application icon in Finder. - @onlyfor{wxmac} + @onlyfor{wxosx} */ virtual void MacOpenFile(const wxString& fileName); /** Called in response of a "get-url" Apple event. - @onlyfor{wxmac} + @onlyfor{wxosx} */ virtual void MacOpenURL(const wxString& url); /** Called in response of a "print-document" Apple event. - @onlyfor{wxmac} + @onlyfor{wxosx} */ virtual void MacPrintFile(const wxString& fileName); /** Called in response of a "reopen-application" Apple event. - @onlyfor{wxmac} + @onlyfor{wxosx} */ virtual void MacReopenApp(); diff --git a/interface/wx/dnd.h b/interface/wx/dnd.h index 0855d6872a..6c2ed5394f 100644 --- a/interface/wx/dnd.h +++ b/interface/wx/dnd.h @@ -192,7 +192,7 @@ public: icons for GTK. You should use the macro wxDROP_ICON() in portable programs instead of directly using either of these types. - @onlyfor{wxmsw,wxmac} + @onlyfor{wxmsw,wxosx} @param win 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 programs instead of directly using either of these types. - @onlyfor{wxmsw,wxmac} + @onlyfor{wxmsw,wxosx} @param data The data associated with the drop source. diff --git a/interface/wx/icon.h b/interface/wx/icon.h index bab04d6e6d..5a055a7168 100644 --- a/interface/wx/icon.h +++ b/interface/wx/icon.h @@ -94,7 +94,7 @@ public: @param height The height of the image. - @onlyfor{wxmsw,wxmac} + @onlyfor{wxmsw,wxosx} */ wxIcon(const char bits[], int width, int height); diff --git a/interface/wx/imaglist.h b/interface/wx/imaglist.h index e0b8a2d4fe..f5a4dc3203 100644 --- a/interface/wx/imaglist.h +++ b/interface/wx/imaglist.h @@ -101,7 +101,7 @@ public: matching the dimensions of the image list. This does not apply when adding icons. - @onlyfor{wxmsw,wxmac} + @onlyfor{wxmsw,wxosx} */ int Add(const wxIcon& icon); @@ -209,7 +209,7 @@ public: @remarks The original bitmap or icon is not affected by the Replace() operation, and can be deleted afterwards. - @onlyfor{wxmsw,wxmac} + @onlyfor{wxmsw,wxosx} */ bool Replace(int index, const wxIcon& icon); }; diff --git a/interface/wx/menuitem.h b/interface/wx/menuitem.h index 8d5553c92e..8566896a96 100644 --- a/interface/wx/menuitem.h +++ b/interface/wx/menuitem.h @@ -276,7 +276,7 @@ public: Sets the bitmap for the menu item. It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap). - @onlyfor{wxmsw,wxmac,wxgtk} + @onlyfor{wxmsw,wxosx,wxgtk} */ virtual void SetBitmap(const wxBitmap& bmp); diff --git a/interface/wx/pen.h b/interface/wx/pen.h index 0bcddb1248..0b617945d8 100644 --- a/interface/wx/pen.h +++ b/interface/wx/pen.h @@ -182,7 +182,7 @@ public: @param stipple A stipple bitmap. - @onlyfor{wxmsw,wxmac} + @onlyfor{wxmsw,wxosx} @see SetWidth(), SetStipple() */ -- 2.45.2