summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2008-04-08 00:09:16 +0000
committerMatthias Melcher <fltk@matthiasm.com>2008-04-08 00:09:16 +0000
commit97b806e5800da62734ba2913881d96a353e3e313 (patch)
treef6bb73185bdbfa63ff151f99782e9396ca3a6e68 /documentation
parent7d013249f7456d4568a39679c3cad948e1000353 (diff)
Added two UTF-8 support headers which can not be used just yet. Added sample implementation of Doxygen documentation, including a Doxygen config file, two copied doc pages documentation/index.do and documentation/preface.dox, and sample headers fro Fl_Preferences and Fl_Clock.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6089 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation')
-rw-r--r--documentation/FL200.gifbin0 -> 2722 bytes
-rw-r--r--documentation/index.dox101
-rw-r--r--documentation/preface.dox108
3 files changed, 209 insertions, 0 deletions
diff --git a/documentation/FL200.gif b/documentation/FL200.gif
new file mode 100644
index 000000000..9df861dc7
--- /dev/null
+++ b/documentation/FL200.gif
Binary files differ
diff --git a/documentation/index.dox b/documentation/index.dox
new file mode 100644
index 000000000..528bf3b0e
--- /dev/null
+++ b/documentation/index.dox
@@ -0,0 +1,101 @@
+/**
+
+\mainpage FLTK Programming Manual
+
+<TABLE BGCOLOR="#9f9f9f" CELLPADDING="8" CELLSPACING="0" SUMMARY="TITLE BAR" WIDTH="700">
+<TR>
+ <TD VALIGN="MIDDLE">
+ \image html FL200.gif
+ <TD ALIGN="CENTER" VALIGN="MIDDLE">
+ <H1>FLTK 1.3.0 Programming Manual</H1>
+ <P>Revision 8 by Michael Sweet, Craig P. Earls,<br>Matthias Melcher, and Bill Spitzak<BR>
+ Copyright 1998-2008 by Bill Spitzak and others.</P>
+ </TD>
+</TR>
+<TR>
+ <TH COLSPAN=2>This software and manual are provided under the terms of the GNU Library General Public License. Permission is granted to reproduce this manual or any portion for any purpose, provided this copyright and permission notice are preserved.</TH>
+</TR>
+</TABLE>
+
+<TABLE BGCOLOR="#9f9fef" CELLPADDING="8" CELLSPACING="0" SUMMARY="Table of Contents" WIDTH="700">
+<TR>
+ <TD ALIGN="LEFT" VALIGN="TOP"><B>
+ \subpage preface
+ </B>
+ <BR>
+ <BR>
+ <B><A HREF="intro.html#intro">1 - Introduction to FLTK</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="basics.html#basics">2 - FLTK Basics</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="common.html#common">3 - Common Widgets and Attributes</A></B>
+ <UL>
+ <LI><A HREF="drawing.html#colors">Colors</A></LI>
+ <LI><A HREF="common.html#boxtypes">Box Types</A></LI>
+ <LI><A HREF="common.html#labels">Labels and Label Types</A></LI>
+ <LI><A HREF="drawing.html#images">Images</A></LI>
+ <LI><A HREF="Fl_Pixmap.html#Fl_Pixmap">class Fl_Pixmap</A></LI>
+ </UL>
+ <B><A HREF="editor.html#editor">4 - Designing a Simple Text Editor</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="drawing.html#drawing">5 - Drawing Things in FLTK</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="events.html#events">6 - Handling Events</A></B>
+ <UL>
+ <LI><A HREF="events.html#event_xxx">Fl::event_*() methods</A></LI>
+ <LI><A HREF="events.html#propagation">Event Propagation</A></LI>
+ </UL>
+ <B><A HREF="subclassing.html#subclassing">7 - Adding and Extending
+ Widgets</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="opengl.html#opengl">8 - Using OpenGL</A></B>
+ </TD>
+ <TD ALIGN=LEFT VALIGN=TOP>
+ <B><A HREF="fluid.html#FLUID">9 - Programming with FLUID</A></B>
+ <UL>
+ <LI><A HREF="fluid.html#widget_attributes">Widget Attributes</A></LI>
+ <LI><A HREF="fluid.html#widget_attributes">Selecting Moving Widgets</A></LI>
+ <LI><A HREF="fluid.html#images">Image Labels</A></LI>
+ </UL>
+ <B><A HREF="advanced.html#advanced">10 - Advanced FLTK</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="classes.html">A - Class Reference</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="globals_func.html">B - Function Reference</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="enumerations.html#Enumerations">C - FLTK Enumerations.H</A>
+ </B>
+ <BR>
+ <BR>
+ <B><A HREF="glut.html#glut">D - GLUT Compatibility</A></B>
+ <UL>
+ <LI><A HREF="glut.html#Fl_Glut_Window">class Fl_Glut_Window</A></LI>
+ </UL>
+ <B><A HREF="forms.html#forms">E - Forms Compatibility</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="osissues.html#osissues">F - Operating System Issues</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="migration.html">G - Migrating Code from FLTK 1.0.x</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="license.html#license">H - Software License</A></B>
+ <BR>
+ <BR>
+ <B><A HREF="examples.html#examples">I - Example Source Code</A></B>
+ </TD>
+</TR>
+</TABLE>
+
+*/
+
+
diff --git a/documentation/preface.dox b/documentation/preface.dox
new file mode 100644
index 000000000..4c004ba44
--- /dev/null
+++ b/documentation/preface.dox
@@ -0,0 +1,108 @@
+/**
+
+ \page preface Preface
+
+<P>This manual describes the Fast Light Tool Kit (&quot;FLTK&quot;)
+version 1.1.8, a C++ Graphical User Interface
+(&quot;GUI&quot;) toolkit for UNIX, Microsoft Windows and MacOS. 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.</P>
+
+<P><B>This manual may be printed, modified, and/or used under
+the terms of the FLTK license provided in <A
+HREF="license.html">Appendix A</A>.</B>
+
+<H2>Organization</H2>
+
+<P>This manual is organized into the following chapters and appendices:</P>
+
+<UL>
+
+ <LI><A HREF="intro.html#intro">Chapter 1 - Introduction to FLTK</A></LI>
+
+ <LI><A HREF="basics.html#basics">Chapter 2 - FLTK Basics</A></LI>
+
+ <LI><A HREF="common.html#common">Chapter 3 - Common Widgets and Attributes</A></LI>
+
+ <LI><A HREF="editor.html#editor">Chapter 4 - Designing a Simple Text
+ Editor</A></LI>
+
+ <LI><A HREF="drawing.html#drawing">Chapter 5 - Drawing Things in FLTK</A></LI>
+
+ <LI><A HREF="events.html#events">Chapter 6 - Handling Events</A></LI>
+
+ <LI><A HREF="subclassing.html#subclassing">Chapter 7 - Extending and
+ Adding Widgets</A></LI>
+
+ <LI><A HREF="opengl.html#opengl">Chapter 8 - Using OpenGL</A></LI>
+
+ <LI><A HREF="fluid.html#FLUID">Chapter 9 - Programming With FLUID</A></LI>
+
+ <LI><A HREF="widgets.html#widgets">Appendix A - Class Reference</A></LI>
+
+ <LI><A HREF="functions.html#functions">Appendix B - Function Reference</A></LI>
+
+ <LI><A HREF="enumerations.html#Enumerations">Appendix C - Enumeration
+ Reference</A></LI>
+
+ <LI><A HREF="glut.html#glut">Appendix D - GLUT Compatibility</A></LI>
+
+ <LI><A HREF="forms.html#forms">Appendix E - Forms Compatibility</A></LI>
+
+ <LI><A HREF="osissues.html#osissues">Appendix F - Operating System Issues</A></LI>
+
+ <LI><A HREF="migration.html">Appendix G - Migrating from FLTK 1.0.x to FLTK 1.1.x</A></LI>
+
+ <LI><A HREF="license.html#license">Appendix H - Software License</A></LI>
+
+ <LI><A HREF="examples.html#examples">Appendix I - Example Source Code</A></LI>
+
+</UL>
+
+<H2>Conventions</H2>
+
+<P>The following typeface conventions are used in this manual:</P>
+
+<UL>
+ <LI>Function and constant names are shown in <B><TT>bold courier type</TT></B></LI>
+
+ <LI>Code samples and commands are shown in <TT>regular courier type</TT></LI>
+
+</UL>
+
+<H2>Abbreviations</H2>
+
+<P>The following abbreviations are used in this manual:</P>
+
+<DL>
+
+ <DT>X11</DT>
+ <DD>The X Window System version 11.</DD>
+
+ <DT>Xlib</DT>
+ <DD>The X Window System interface library.</DD>
+
+ <DT>WIN32</DT>
+ <DD>The Microsoft Windows 32-bit Application Programmer's Interface.</DD>
+
+ <DT>MacOS</DT>
+ <DD>The Apple Macintosh OS 8.6 and later, including OS X.</DD>
+
+</DL>
+
+<H2>Copyrights and Trademarks</H2>
+
+<P>FLTK is Copyright 1998-2006 by Bill Spitzak and others. Use and
+distribution of FLTK is governed by the GNU Library General Public
+License, located in <A HREF="license.html#license">Appendix H</A>.</P>
+
+<P>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, and Mac OS X are
+registered trademarks of Apple Computer, Inc.</P>
+
+*/
+