summaryrefslogtreecommitdiff
path: root/documentation/src/osissues.dox
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2018-01-31 17:46:48 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2018-01-31 17:46:48 +0000
commitcc595ce4edb86965b70e385e62d54efbb8ba5b8f (patch)
tree06c634ed3ef565ffe53d9c34d18a9949a2ebb247 /documentation/src/osissues.dox
parent12a2fc2a4d5cd40b2fbdeb7f6e5d949c793106bc (diff)
Replace FL/x.H with FL/platform.H - step 1.
This first step replaces FL/x.H with FL/platform.H but keeps a small FL/x.H that #include's FL/platform.H for backwards compatibility. Documentation sources in documentation/src/*.dox have been fixed, but references in other source files need to be fixed in another step. Dependencies have been adjusted. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12640 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/src/osissues.dox')
-rw-r--r--documentation/src/osissues.dox16
1 files changed, 11 insertions, 5 deletions
diff --git a/documentation/src/osissues.dox b/documentation/src/osissues.dox
index e8b6822fa..166c0a95d 100644
--- a/documentation/src/osissues.dox
+++ b/documentation/src/osissues.dox
@@ -14,14 +14,20 @@ All programs that need to access the operating system
specific interfaces must include the following header file:
\code
-#include <FL/x.H>
+#include <FL/platform.H>
\endcode
-Despite the name, this header file will define the
-appropriate interface for your environment. The pages that
-follow describe the functionality that is provided for each
+This header file will define the appropriate interface for your environment.
+The pages that follow describe the functionality that is provided for each
operating system.
+\note These definitions used to be in FL/x.H up to FLTK 1.3.x. Usage of
+ FL/x.H is deprecated since FLTK 1.4.0. You should replace all references
+ of FL/x.H with FL/platform.H if your target is FLTK 1.4 or later.
+ FL/x.H will be retained for backwards compatibility for some
+ releases but will be removed in a later (not yet specified)
+ FLTK release.
+
<CENTER>
<TABLE WIDTH="90%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc">
<TR>
@@ -801,7 +807,7 @@ is flipped to match
FLTK's coordinate system. The origin for all drawing is in the top
left corner of the enclosing Fl_Window. The global variable
\c fl_gc (of type \c CGContextRef) is the appropriate Quartz 2D drawing environment.
-Include FL/x.H to declare the \c fl_gc variable.
+Include FL/platform.H to declare the \c fl_gc variable.
\subsection osissues_localize Internationalization
All FLTK programs contain an application menu with, e.g., the About xxx, Hide xxx, and Quit xxx items.