117 lines
3.3 KiB
Plaintext
117 lines
3.3 KiB
Plaintext
/**
|
|
|
|
\page preface Preface
|
|
|
|
This manual describes the Fast Light Tool Kit ("FLTK")
|
|
version 1.4.0, a C++ Graphical User Interface
|
|
("GUI") toolkit for UNIX, Microsoft Windows and Apple macOS.
|
|
|
|
Version 1.4.0 introduces support for a new windowing system under
|
|
Linux/Unix: Wayland. FLTK applications under Linux/Unix run unchanged
|
|
as Wayland or X11 clients depending on availability at run-time.
|
|
|
|
Each of the chapters in this manual is designed as a tutorial for
|
|
using FLTK, while the appendices provide a convenient reference
|
|
for all FLTK widgets, functions, and operating system interfaces.
|
|
|
|
<B>This manual may be printed, modified, and/or used under
|
|
the terms of the FLTK license provided in: \ref license.</B>
|
|
|
|
\section preface_organisation Organization
|
|
|
|
This manual is organized into the following chapters and appendices:
|
|
|
|
\li \ref intro
|
|
\li \ref basics
|
|
\li \ref common
|
|
\li \ref editor
|
|
\li \ref drawing
|
|
\li \ref events
|
|
\li \ref subclassing
|
|
\li \ref opengl
|
|
\li \ref fltk-options
|
|
\li \ref advanced
|
|
\li \ref unicode
|
|
\li \ref enumerations
|
|
\li \ref glut
|
|
\li \ref forms
|
|
\li \ref osissues
|
|
\li \ref migration_1_4
|
|
\li \ref development
|
|
\li \ref license
|
|
\li \ref examples
|
|
|
|
\section preface_conventions Conventions
|
|
|
|
This manual was generated using Doxygen
|
|
(see https://www.doxygen.org/)
|
|
to process the source code itself, special comments in the code,
|
|
and additional documentation files.
|
|
In general, Doxygen recognizes and denotes the following entities as shown:
|
|
- classes, such as Fl_Widget,
|
|
- methods, such as Fl_Widget::callback(Fl_Callback* cb, void* p),
|
|
- functions, such as fl_draw(const char *str, int x, int y),
|
|
- internal links, such as \ref preface_conventions,
|
|
- external links, such as https://www.fltk.org/.
|
|
|
|
Other code samples and commands are shown in <tt>regular courier type</tt>.
|
|
|
|
\section preface_abbreviations Abbreviations
|
|
|
|
The following abbreviations are used in this manual:
|
|
|
|
\par X11
|
|
The X Window System version 11.
|
|
|
|
\par Xlib
|
|
The X Window System interface library.
|
|
|
|
\par Windows, <tt>WIN32</tt>
|
|
The Microsoft Windows Application Programmer's Interface for Windows 2000,
|
|
Windows XP, Windows Vista, Windows 7 and later Windows versions.
|
|
FLTK uses the preprocessor definition <tt>_WIN32</tt> for the 32 bit
|
|
and 64 bit Windows API.
|
|
|
|
\par macOS (aka Mac OS X), <tt>__APPLE__</tt>
|
|
The Apple desktop operating sytem macOS 10.0 and later. MacOS 8 and 9 support
|
|
was dropped after FLTK 1.0.10. FLTK uses the preprocessor definition
|
|
<tt>\__APPLE__</tt> for macOS.
|
|
|
|
\section preface_copyrights Copyrights and Trademarks
|
|
|
|
FLTK is \include{doc} copyright.dox
|
|
Use and distribution of FLTK is governed by the GNU Library General Public
|
|
License with 4 exceptions, located in \ref license.
|
|
|
|
UNIX is a registered trademark of the X Open Group, Inc.
|
|
Microsoft and Windows are registered trademarks of Microsoft
|
|
Corporation. OpenGL is a registered trademark of Silicon
|
|
Graphics, Inc. Apple, Macintosh, MacOS, macOS, and Mac OS X are
|
|
registered trademarks of Apple Computer, Inc.
|
|
|
|
|
|
\htmlonly
|
|
<hr>
|
|
<table summary="navigation bar" width="100%" border="0">
|
|
<tr>
|
|
<td width="45%" align="LEFT">
|
|
<a class="el" href="index.html">
|
|
[Prev]
|
|
Main Page
|
|
</a>
|
|
</td>
|
|
<td width="10%" align="CENTER">
|
|
<a class="el" href="index.html">[Index]</a>
|
|
</td>
|
|
<td width="45%" align="RIGHT">
|
|
<a class="el" href="intro.html">
|
|
Introduction to FLTK
|
|
[Next]
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
\endhtmlonly
|
|
|
|
*/
|