mirror of
https://github.com/fltk/fltk.git
synced 2026-05-24 16:36:37 +08:00
more html to doxygen conversion for {osissues,migration*,development}.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6410 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
engelsman
@@ -2,8 +2,7 @@
|
||||
|
||||
\page development I - Developer Information
|
||||
|
||||
<P>This chapter describes FLTK development and documentation.
|
||||
</P>
|
||||
This chapter describes FLTK development and documentation.
|
||||
|
||||
\note documentation with doxygen will be described here.
|
||||
|
||||
@@ -247,6 +246,7 @@ The following section is
|
||||
\section development_links Creating Links
|
||||
\endcode
|
||||
|
||||
|
||||
\section development_links Creating Links
|
||||
|
||||
Links to other documents and external links can be embedded with
|
||||
@@ -341,6 +341,68 @@ becomes:
|
||||
|
||||
\endcode
|
||||
|
||||
|
||||
\section development_paragraphs Paragraph Layout
|
||||
|
||||
There is no real need to use HTML \<P\> and \</P\> tags within the text
|
||||
to tell doxygen to start or stop a paragraph. In most cases, when doxygen
|
||||
encounters a blank line or some, but not all, \b \\commands in the text it
|
||||
knows that it as reached the start or end of a paragraph. Doxygen also
|
||||
offers the \b \\par command for special paragraph handling. It can be used
|
||||
to provide a paragraph title and also to indent a paragraph. Unfortunately
|
||||
\b \\par won't do what you expect if you want to have doxygen links and
|
||||
sometimes html tags don't work either.
|
||||
|
||||
<!-- use verbatim rather than code to avoid links to code reference -->
|
||||
\verbatim
|
||||
\par Normal Paragraph with title
|
||||
|
||||
This paragraph will have a title, but because there is a blank line
|
||||
between the \par and the text, it will have the normal layout.
|
||||
|
||||
\par Indented Paragraph with title
|
||||
This paragraph will also have a title, but because there is no blank
|
||||
line between the \par and the text, it will be indented.
|
||||
|
||||
\par
|
||||
It is also possible to have an indented paragraph without title.
|
||||
This is how you indent subsequent paragraphs.
|
||||
|
||||
\par No link to Fl_Widget::draw()
|
||||
Note that the paragraph title is treated as plain text.
|
||||
Doxygen type links will not work.
|
||||
HTML characters and tags may or may not work.
|
||||
|
||||
Fl_Widget::draw() links and "html" tags work<br>
|
||||
\par
|
||||
Use a single line ending with <br> for complicated paragraph titles.
|
||||
\endverbatim
|
||||
|
||||
The above code produces the following paragraphs:
|
||||
|
||||
\par Normal Paragraph with title
|
||||
|
||||
This paragraph will have a title, but because there is a blank line
|
||||
between the \\par and the text, it will have the normal layout.
|
||||
|
||||
\par Indented Paragraph with title
|
||||
This paragraph will also have a title, but because there is no blank
|
||||
line between the \\par and the text, it will be indented.
|
||||
|
||||
\par
|
||||
It is also possible to have an indented paragraph without title.
|
||||
This is how you indent subsequent paragraphs.
|
||||
|
||||
\par No link to Fl_Widget::draw()
|
||||
Note that the paragraph title is treated as plain text.
|
||||
Doxygen type links will not work.
|
||||
HTML characters and tags may or may not work.
|
||||
|
||||
Fl_Widget::draw() links and "html" tags work<br>
|
||||
\par
|
||||
Use a single line ending with \<br\> for complicated paragraph titles.
|
||||
|
||||
|
||||
\section development_html_footer Hack for missing "tiny.gif" file
|
||||
|
||||
\todo
|
||||
|
||||
@@ -2,51 +2,52 @@
|
||||
|
||||
\page migration_1_1 G - Migrating Code from FLTK 1.0 to 1.1
|
||||
|
||||
<P>This appendix describes the differences between the FLTK
|
||||
1.0.x and FLTK 1.1.x functions and classes.</P>
|
||||
|
||||
<H2>Color Values</H2>
|
||||
This appendix describes the differences between the FLTK
|
||||
1.0.x and FLTK 1.1.x functions and classes.
|
||||
|
||||
<P>Color values are now stored in a 32-bit unsigned integer
|
||||
\section migration_1_1_color Color Values
|
||||
|
||||
Color values are now stored in a 32-bit unsigned integer
|
||||
instead of the unsigned character in 1.0.x. This allows for the
|
||||
specification of 24-bit RGB values or 8-bit FLTK color indices.
|
||||
|
||||
<P><TT>FL_BLACK</TT> and <TT>FL_WHITE</TT> now remain black and
|
||||
<tt>FL_BLACK</tt> and <tt>FL_WHITE</tt> now remain black and
|
||||
white, even if the base color of the gray ramp is changed using
|
||||
<A HREF="Fl.html#Fl.background"><TT>Fl::background()</TT></A>.
|
||||
<TT>FL_DARK3</TT> and <TT>FL_LIGHT3</TT> can be used instead to
|
||||
draw a very dark or a very bright background hue.</P>
|
||||
<A HREF="Fl.html#Fl.background"><tt>Fl::background()</tt></A>.
|
||||
<tt>FL_DARK3</tt> and <tt>FL_LIGHT3</tt> can be used instead to
|
||||
draw a very dark or a very bright background hue.
|
||||
|
||||
<P>Widgets use the new color symbols <TT>FL_FORGROUND_COLOR</TT>,
|
||||
<TT>FL_BACKGROUND_COLOR</TT>, <TT>FL_BACKGROUND2_COLOR</TT>,
|
||||
<TT>FL_INACTIVE_COLOR</TT>, and <TT>FL_SELECTION_COLOR</TT>.
|
||||
Widgets use the new color symbols <tt>FL_FORGROUND_COLOR</tt>,
|
||||
<tt>FL_BACKGROUND_COLOR</tt>, <tt>FL_BACKGROUND2_COLOR</tt>,
|
||||
<tt>FL_INACTIVE_COLOR</tt>, and <tt>FL_SELECTION_COLOR</tt>.
|
||||
More details can be found in the chapter
|
||||
<A HREF="enumerations.html#colors">Enumerations</A>.</P>
|
||||
<A HREF="enumerations.html#colors">Enumerations</A>.
|
||||
|
||||
<H2>Cut and Paste Support</H2>
|
||||
\section migration_1_1_cutnpaste Cut and Paste Support
|
||||
|
||||
<P>The FLTK clipboard is now broken into two parts - a local
|
||||
The FLTK clipboard is now broken into two parts - a local
|
||||
selection value and a cut-and-paste value. This allows FLTK to
|
||||
support things like highlighting and replacing text that was
|
||||
previously cut or copied, which makes FLTK applications behave
|
||||
like traditional GUI applications.
|
||||
|
||||
<H2>File Chooser</H2>
|
||||
\section migration_1_1_file_chooser File Chooser
|
||||
|
||||
<P>The file chooser in FLTK 1.1.x is significantly different
|
||||
The file chooser in FLTK 1.1.x is significantly different
|
||||
than the one supplied with FLTK 1.0.x. Any code that directly
|
||||
references the old <TT>FCB</TT> class or members will need
|
||||
to be ported to the new <A
|
||||
HREF="Fl_File_Chooser.html"><TT>Fl_File_Chooser</TT></A>
|
||||
class.</P>
|
||||
references the old <tt>FCB</tt> class or members will need
|
||||
to be ported to the new
|
||||
<A HREF="Fl_File_Chooser.html"><tt>Fl_File_Chooser</tt></A>
|
||||
class.
|
||||
|
||||
<H2>Function Names</H2>
|
||||
\section migration_1_1_functions Function Names
|
||||
|
||||
<P>Some function names have changed from FLTK 1.0.x to 1.1.x in
|
||||
Some function names have changed from FLTK 1.0.x to 1.1.x in
|
||||
order to avoid name space collisions. You can still use the old
|
||||
function names by defining the <TT>FLTK_1_0_COMPAT</TT>
|
||||
function names by defining the <tt>FLTK_1_0_COMPAT</tt>
|
||||
symbol on the command-line when you compile
|
||||
(<TT>-DFLTK_1_0_COMPAT</TT>) or in your source, e.g.:
|
||||
(<tt>-DFLTK_1_0_COMPAT</tt>) or in your source, e.g.:
|
||||
|
||||
\code
|
||||
#define FLTK_1_0_COMPAT
|
||||
@@ -55,9 +56,10 @@ symbol on the command-line when you compile
|
||||
#include <FL/filename.H>
|
||||
\endcode
|
||||
|
||||
<P>The following table shows the old and new function names:</P>
|
||||
The following table shows the old and new function names:
|
||||
|
||||
<CENTER><TABLE WIDTH="80%" BORDER="1">
|
||||
<CENTER>
|
||||
<TABLE WIDTH="80%" BORDER="1">
|
||||
<TR>
|
||||
<TH>Old 1.0.x Name</TH>
|
||||
<TH>New 1.1.x Name</TH>
|
||||
@@ -118,37 +120,40 @@ symbol on the command-line when you compile
|
||||
<TD>numericsort()</TD>
|
||||
<TD>fl_numericsort()</TD>
|
||||
</TR>
|
||||
</TABLE></CENTER>
|
||||
</TABLE>
|
||||
</CENTER>
|
||||
|
||||
<H2>Image Support</H2>
|
||||
\section migration_1_1_images Image Support
|
||||
|
||||
<P>Image support in FLTK has been significantly revamped in
|
||||
1.1.x. The <A HREF="Fl_Image.html"><TT>Fl_Image</TT></A> class
|
||||
Image support in FLTK has been significantly revamped in
|
||||
1.1.x. The <A HREF="Fl_Image.html"><tt>Fl_Image</tt></A> class
|
||||
is now a proper base class, with the core image drawing
|
||||
functionality in the <A
|
||||
HREF="Fl_Bitmap.html"><TT>Fl_Bitmap</TT></A>, <A
|
||||
HREF="Fl_Pixmap.html"><TT>Fl_Pixmap</TT></A>, and <A
|
||||
HREF="Fl_RGB_Image.html"><TT>Fl_RGB_Image</TT></A> classes.
|
||||
functionality in the
|
||||
<A HREF="Fl_Bitmap.html"><tt>Fl_Bitmap</tt></A>,
|
||||
<A HREF="Fl_Pixmap.html"><tt>Fl_Pixmap</tt></A>,
|
||||
and
|
||||
<A HREF="Fl_RGB_Image.html"><tt>Fl_RGB_Image</tt></A>
|
||||
classes.
|
||||
|
||||
<P>BMP, GIF, JPEG, PNG, XBM, and XPM image files can now be
|
||||
loaded using the appropriate image classes, and the <A
|
||||
HREF="Fl_Shared_Image.html"><TT>Fl_Shared_Image</TT></A> class
|
||||
can be used to cache images in memory.
|
||||
BMP, GIF, JPEG, PNG, XBM, and XPM image files can now be
|
||||
loaded using the appropriate image classes, and the
|
||||
<A HREF="Fl_Shared_Image.html"><tt>Fl_Shared_Image</tt></A>
|
||||
class can be used to cache images in memory.
|
||||
|
||||
<P>Image labels are no longer provided as an add-on label type.
|
||||
If you use the old <TT>label()</TT> methods on an image, the
|
||||
widget's <TT>image()</TT> method is called to set the image
|
||||
Image labels are no longer provided as an add-on label type.
|
||||
If you use the old <tt>label()</tt> methods on an image, the
|
||||
widget's <tt>image()</tt> method is called to set the image
|
||||
as the label.
|
||||
|
||||
<P>Image labels in menu items must still use the old labeltype
|
||||
Image labels in menu items must still use the old labeltype
|
||||
mechanism to preserve source compatibility.
|
||||
|
||||
<H2>Keyboard Navigation</H2>
|
||||
\section migration_1_1_keyboard Keyboard Navigation
|
||||
|
||||
<P>FLTK 1.1.x now supports keyboard navigation and control with
|
||||
FLTK 1.1.x now supports keyboard navigation and control with
|
||||
all widgets. To restore the old FLTK 1.0.x behavior so that only
|
||||
text widgets get keyboard focus, call the <A
|
||||
HREF="Fl.html#Fl.visible_focus"><CODE>Fl::visible_focus()</CODE></A>
|
||||
text widgets get keyboard focus, call the
|
||||
<A HREF="Fl.html#Fl.visible_focus"><CODE>Fl::visible_focus()</CODE></A>
|
||||
method to disable it:
|
||||
|
||||
\code
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
|
||||
\page migration_1_3 H - Migrating Code from FLTK 1.1 to 1.3
|
||||
|
||||
<P>This appendix describes the differences between the FLTK
|
||||
1.1.x and FLTK 1.3.x functions and classes.</P>
|
||||
This appendix describes the differences between the FLTK
|
||||
1.1.x and FLTK 1.3.x functions and classes.
|
||||
|
||||
If you want to migrate your code from FLTK 1.0 to FLTK 1.3,
|
||||
then you should also consult Appendix \ref migration_1_1.
|
||||
|
||||
+310
-294
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user