summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
Diffstat (limited to 'FL')
-rw-r--r--FL/Enumerations.H2
-rw-r--r--FL/Fl_Adjuster.H3
-rw-r--r--FL/Fl_Chart.H4
-rw-r--r--FL/Fl_Check_Button.H2
-rw-r--r--FL/Fl_Choice.H2
-rw-r--r--FL/Fl_Clock.H27
-rw-r--r--FL/Fl_Color_Chooser.H1
-rw-r--r--FL/Fl_Counter.H1
-rw-r--r--FL/Fl_Dial.H3
-rw-r--r--FL/Fl_File_Input.H3
-rw-r--r--FL/Fl_Group.H2
-rw-r--r--FL/Fl_Light_Button.H3
-rw-r--r--FL/Fl_Menu_Bar.H1
-rw-r--r--FL/Fl_Menu_Button.H1
-rw-r--r--FL/Fl_Menu_Item.H2
-rw-r--r--FL/Fl_Output.H3
-rw-r--r--FL/Fl_Positioner.H3
-rw-r--r--FL/Fl_Return_Button.H3
-rw-r--r--FL/Fl_Roller.H3
-rw-r--r--FL/Fl_Round_Button.H3
-rw-r--r--FL/Fl_Scroll.H3
-rw-r--r--FL/Fl_Scrollbar.H3
-rw-r--r--FL/Fl_Simple_Counter.H3
-rw-r--r--FL/Fl_Slider.H3
-rw-r--r--FL/Fl_Tabs.H3
-rw-r--r--FL/Fl_Tile.H3
-rw-r--r--FL/Fl_Valuator.H3
-rw-r--r--FL/Fl_Value_Input.H3
-rw-r--r--FL/Fl_Value_Output.H3
-rw-r--r--FL/Fl_Value_Slider.H3
30 files changed, 70 insertions, 32 deletions
diff --git a/FL/Enumerations.H b/FL/Enumerations.H
index 0e7d7b596..d591d3336 100644
--- a/FL/Enumerations.H
+++ b/FL/Enumerations.H
@@ -426,7 +426,7 @@ enum Fl_When { // Fl_Widget::when():
is the area that is not drawn by the frame types.
\image html boxtypes.gif "Figure 1: FLTK standard box types"
-
+ \image latex boxtypes.eps "FLTK standard box types" width=10cm
\todo Description of boxtypes is incomplete.
See below for the defined enum Fl_Boxtype.
\see src/Fl_get_system_colors.cxx
diff --git a/FL/Fl_Adjuster.H b/FL/Fl_Adjuster.H
index 7112cce73..3334d93d6 100644
--- a/FL/Fl_Adjuster.H
+++ b/FL/Fl_Adjuster.H
@@ -40,7 +40,8 @@
/**
The Fl_Adjuster widget was stolen from Prisms, and has proven
to be very useful for values that need a large dynamic range.
- <P ALIGN=CENTER>\image html adjuster1.gif</P>
+ \image html adjuster1.gif
+ \image latex adjuster1.eps "Fl_Adjuster" width=4cm
<P>When you press a button and drag to the right the value increases.
When you drag to the left it decreases. The largest button adjusts by
100 * step(), the next by 10 * step() and that
diff --git a/FL/Fl_Chart.H b/FL/Fl_Chart.H
index 1d004e660..55993de9a 100644
--- a/FL/Fl_Chart.H
+++ b/FL/Fl_Chart.H
@@ -61,8 +61,8 @@ struct FL_CHART_ENTRY {
\brief Fl_Chart displays simple charts.
It is provided for Forms compatibility.
- \image html charts.gif
-
+ \image html charts.gif
+ \image latex charts.eps "Fl_Chart" width=10cm
\todo Refactor Fl_Chart::type() information.
The type of an Fl_Chart object can be set using type(uchar t) to:
diff --git a/FL/Fl_Check_Button.H b/FL/Fl_Check_Button.H
index bab2f72a5..a0e505c0b 100644
--- a/FL/Fl_Check_Button.H
+++ b/FL/Fl_Check_Button.H
@@ -38,7 +38,7 @@
\brief A button with an "checkmark" to show its status.
\image html Fl_Check_Button.gif
-
+ \image latex Fl_Check_Button.eps "Fl_Check_Button" width=4cm
Buttons generate callbacks when they are clicked by the user. You control
exactly when and how by changing the values for type() and when().
diff --git a/FL/Fl_Choice.H b/FL/Fl_Choice.H
index 46543c37c..f0cdd1bad 100644
--- a/FL/Fl_Choice.H
+++ b/FL/Fl_Choice.H
@@ -65,7 +65,7 @@
only looked at when the menu is popped up, however.
\image html choice.gif
-
+ \image latex choice.eps "Fl_Choice" width=4cm
\todo Refactor the doxygen comments for Fl_Choice changed() documentation.
\li <tt>int Fl_Widget::changed() const</tt>
diff --git a/FL/Fl_Clock.H b/FL/Fl_Clock.H
index 2d21e1f14..9a1306592 100644
--- a/FL/Fl_Clock.H
+++ b/FL/Fl_Clock.H
@@ -41,6 +41,9 @@
#define FL_ANALOG_CLOCK FL_SQUARE_CLOCK /**< An analog clock is square */
#define FL_DIGITAL_CLOCK FL_SQUARE_CLOCK /**< Not yet implemented */
+// fabien: Please keep the horizontal formatting of both images in class desc,
+// don't loose vert. space for nothing!
+
/**
\class Fl_Clock_Output
\brief This widget can be used to display a program-supplied time.
@@ -48,9 +51,14 @@
The time shown on the clock is not updated. To display the current time,
use Fl_Clock instead.
- \image html clock.gif
-
- \image html round_clock.gif
+ \htmlonly <BR> <table align=CENTER border=1 cellpadding=5 >
+ <caption align=bottom>type() FL_SQUARE_CLOCK and FL_ROUND_CLOCK </caption> <TR><TD> \endhtmlonly
+ \image html clock.gif
+ \htmlonly </TD> <TD> \endhtmlonly
+ \image html round_clock.gif
+ \htmlonly </TD> </TR> </table> \endhtmlonly
+ \image latex clock.eps "FL_SQUARE_CLOCK type" width=4cm
+ \image latex round_clock.eps "FL_ROUND_CLOCK type" width=4cm
*/
class FL_EXPORT Fl_Clock_Output : public Fl_Widget {
int hour_, minute_, second_;
@@ -101,10 +109,15 @@ public:
Fl_Clock is provided for Forms compatibility.
It installs a 1-second timeout callback using Fl::add_timeout().
-
- \image html clock.gif
-
- \image html round_clock.gif
+ You can choose the rounded or square type of the the clock with type(), see below.
+ \htmlonly <BR> <table align=CENTER border=1 cellpadding=5 >
+ <caption align=bottom>type() FL_SQUARE_CLOCK and FL_ROUND_CLOCK </caption> <TR><TD> \endhtmlonly
+ \image html clock.gif
+ \htmlonly </TD> <TD> \endhtmlonly
+ \image html round_clock.gif
+ \htmlonly </TD> </TR> </table> \endhtmlonly
+ \image latex clock.eps "FL_SQUARE_CLOCK type" width=4cm
+ \image latex round_clock.eps "FL_ROUND_CLOCK type" width=4cm
*/
class FL_EXPORT Fl_Clock : public Fl_Clock_Output {
public:
diff --git a/FL/Fl_Color_Chooser.H b/FL/Fl_Color_Chooser.H
index c6fabbc3c..6a5270274 100644
--- a/FL/Fl_Color_Chooser.H
+++ b/FL/Fl_Color_Chooser.H
@@ -84,6 +84,7 @@ public:
\brief The Fl_Color_Chooser widget provides a standard RGB color chooser.
\image html fl_color_chooser.jpg
+ \image latex fl_color_chooser.eps "fl_color_chooser()" width=5cm
You can place any number of the widgets into a panel of your own design.
The diagram shows the widget as part of a color chooser dialog created by
diff --git a/FL/Fl_Counter.H b/FL/Fl_Counter.H
index acdaa2e81..3b4baf6f6 100644
--- a/FL/Fl_Counter.H
+++ b/FL/Fl_Counter.H
@@ -46,6 +46,7 @@
Double arrows buttons achieve larger steps than simple arrows.
\see Fl_Spinner for value input with vertical step arrows.
<P align=center>\image html counter.gif</P>
+ \image latex counter.eps "Fl_Counter" width=4cm
\todo Refactor the doxygen comments for Fl_Counter type() documentation.
diff --git a/FL/Fl_Dial.H b/FL/Fl_Dial.H
index adfaf8005..dbe6d84fe 100644
--- a/FL/Fl_Dial.H
+++ b/FL/Fl_Dial.H
@@ -43,7 +43,8 @@
/**
The Fl_Dial widget provides a circular dial to control a
single floating point value.
- <P ALIGN=CENTER>\image html dial.gif
+ <P ALIGN=CENTER>\image html dial.gif
+ \image latex dial.eps "Fl_Dial" width=4cm
Use type() to set the type of the dial to:
<UL>
<LI>FL_NORMAL_DIAL - Draws a normal dial with a knob. </LI>
diff --git a/FL/Fl_File_Input.H b/FL/Fl_File_Input.H
index fcf3fdaf8..f289eac0a 100644
--- a/FL/Fl_File_Input.H
+++ b/FL/Fl_File_Input.H
@@ -44,7 +44,8 @@
and also FL_WHEN_RELEASE for button release when changing to parent dir.
FL_WHEN_RELEASE callback won't be called if the directory clicked
is the same that the current one.
- <P align=CENTER> \image html Fl_File_Input.gif </P>
+ <P align=CENTER> \image html Fl_File_Input.gif </P>
+ \image latex Fl_File_Input.eps "Fl_File_Input" width=6cm
\note As all Fl_Input derived objects, Fl_File_Input may call its callback
when loosing focus (see FL_UNFOCUS) to update its state like its cursor shape.
One resulting side effect is that you should call clear_changed() early in your callback
diff --git a/FL/Fl_Group.H b/FL/Fl_Group.H
index 9155fb521..4bda8d28e 100644
--- a/FL/Fl_Group.H
+++ b/FL/Fl_Group.H
@@ -145,6 +145,8 @@ public:
<BR></P>
<P align=center>\image html resizebox1.gif&nbsp;&nbsp;
\image html resizebox2.gif</P>
+ \image latex resizebox1.eps "before resize" width=4cm
+ \image latex resizebox2.eps "after resize" width=4cm
<P>The resizable may be set to the group itself (this is the default
value for an Fl_Group, although NULL is the default
for Fl_Window and Fl_Pack), in which case all the
diff --git a/FL/Fl_Light_Button.H b/FL/Fl_Light_Button.H
index e9600fe3d..71af0aa04 100644
--- a/FL/Fl_Light_Button.H
+++ b/FL/Fl_Light_Button.H
@@ -41,7 +41,8 @@
Buttons generate callbacks when they are clicked by the user. You
control exactly when and how by changing the values for type() and when().
- <P ALIGN=CENTER>\image html Fl_Light_Button.gif</P>
+ <P ALIGN=CENTER>\image html Fl_Light_Button.gif</P>
+ \image latex Fl_Light_Button.eps "Fl_Light_Button" width=4cm
*/
class FL_EXPORT Fl_Light_Button : public Fl_Button {
protected:
diff --git a/FL/Fl_Menu_Bar.H b/FL/Fl_Menu_Bar.H
index 96d02af57..595a5d5f5 100644
--- a/FL/Fl_Menu_Bar.H
+++ b/FL/Fl_Menu_Bar.H
@@ -45,6 +45,7 @@
define the pull-down menus. Sub-sub menus and lower pop up to the right
of the submenus. </P>
<P ALIGN=CENTER>\image html menubar.gif</P>
+ \image latex menubar.eps " menubar" width=12cm
<P>If there is an item in the top menu that is not a title of a
submenu, then it acts like a "button" in the menubar. Clicking on it
will pick it. </P>
diff --git a/FL/Fl_Menu_Button.H b/FL/Fl_Menu_Button.H
index 7f08d5a68..d2a5a3812 100644
--- a/FL/Fl_Menu_Button.H
+++ b/FL/Fl_Menu_Button.H
@@ -38,6 +38,7 @@
menus) defined by an array of
Fl_Menu_Item objects.
<P ALIGN=CENTER>\image html menu_button.gif</P>
+ \image latex menu_button.eps " menu_button" width=5cm
<P>Normally any mouse button will pop up a menu and it is lined up
below the button as shown in the picture. However an Fl_Menu_Button
may also control a pop-up menu. This is done by setting the type()
diff --git a/FL/Fl_Menu_Item.H b/FL/Fl_Menu_Item.H
index b0aeb3b69..353c6e22e 100644
--- a/FL/Fl_Menu_Item.H
+++ b/FL/Fl_Menu_Item.H
@@ -102,7 +102,7 @@ class Fl_Menu_;
\endcode
produces:
<P ALIGN=CENTER>\image html menu.gif </P>
-
+ \image latex menu.eps "menu" width=10cm
A submenu title is identified by the bit FL_SUBMENU in the
flags field, and ends with a label() that is NULL.
You can nest menus to any depth. A pointer to the first item in the
diff --git a/FL/Fl_Output.H b/FL/Fl_Output.H
index 8e8bfeebd..5c2aeb45e 100644
--- a/FL/Fl_Output.H
+++ b/FL/Fl_Output.H
@@ -38,7 +38,8 @@
which is useful for program-generated values. The user may select
portions of the text using the mouse and paste the contents into other
fields or programs.
- <P align=CENTER>\image html text.gif</P>
+ <P align=CENTER>\image html text.gif</P>
+ \image latex text.eps "Fl_Output" width=8cm
<P>There is a single subclass,
Fl_Multiline_Output, which allows you to display multiple lines of
text. </P>
diff --git a/FL/Fl_Positioner.H b/FL/Fl_Positioner.H
index f7cc1aa88..6f8b8f917 100644
--- a/FL/Fl_Positioner.H
+++ b/FL/Fl_Positioner.H
@@ -40,7 +40,8 @@
It would be useful if this could be put atop another widget so that the
crosshairs are on top, but this is not implemented. The color of the
crosshairs is selection_color().
- <P ALIGN=CENTER>\image html positioner.gif </P>
+ <P ALIGN=CENTER>\image html positioner.gif </P>
+ \image latex positioner.eps " Fl_Positioner" width=4cm
*/
class FL_EXPORT Fl_Positioner : public Fl_Widget {
diff --git a/FL/Fl_Return_Button.H b/FL/Fl_Return_Button.H
index c7e9813d9..eeef66697 100644
--- a/FL/Fl_Return_Button.H
+++ b/FL/Fl_Return_Button.H
@@ -36,7 +36,8 @@
The Fl_Return_Button is a subclass of Fl_Button that
generates a callback when it is pressed or when the user presses the
Enter key. A carriage-return symbol is drawn next to the button label.
- <P ALIGN=CENTER>\image html Fl_Return_Button.gif
+ <P ALIGN=CENTER>\image html Fl_Return_Button.gif
+ \image latex Fl_Return_Button.eps "Fl_Return_Button" width=4cm
*/
class FL_EXPORT Fl_Return_Button : public Fl_Button {
protected:
diff --git a/FL/Fl_Roller.H b/FL/Fl_Roller.H
index 71f26a4b1..10973bc37 100644
--- a/FL/Fl_Roller.H
+++ b/FL/Fl_Roller.H
@@ -38,7 +38,8 @@
/**
The Fl_Roller widget is a "dolly" control commonly used to
move 3D objects.
- <P ALIGN=CENTER>\image html Fl_Roller.gif
+ <P ALIGN=CENTER>\image html Fl_Roller.gif
+ \image latex Fl_Roller.eps "Fl_Roller" width=4cm
*/
class FL_EXPORT Fl_Roller : public Fl_Valuator {
protected:
diff --git a/FL/Fl_Round_Button.H b/FL/Fl_Round_Button.H
index 03e179c31..675eabd9f 100644
--- a/FL/Fl_Round_Button.H
+++ b/FL/Fl_Round_Button.H
@@ -37,7 +37,8 @@
Buttons generate callbacks when they are clicked by the user. You
control exactly when and how by changing the values for type()
and when().
- <P ALIGN=CENTER>\image html Fl_Round_Button.gif</P>
+ <P ALIGN=CENTER>\image html Fl_Round_Button.gif</P>
+ \image latex Fl_Round_Button.eps " Fl_Round_Button" width=4cm
<P>The Fl_Round_Button subclass display the "on" state by
turning on a light, rather than drawing pushed in. The shape of the
"light" is initially set to FL_ROUND_DOWN_BOX. The color of the light
diff --git a/FL/Fl_Scroll.H b/FL/Fl_Scroll.H
index 5f0bc555e..55054b283 100644
--- a/FL/Fl_Scroll.H
+++ b/FL/Fl_Scroll.H
@@ -39,7 +39,8 @@
larger than your window. If the child widgets are larger than the size
of this object then scrollbars will appear so that you can scroll over
to them:
- <P ALIGN=CENTER>\image html Fl_Scroll.gif </P>
+ <P ALIGN=CENTER>\image html Fl_Scroll.gif </P>
+ \image latex Fl_Scroll.eps "Fl_Scroll" width=4cm
<P>If all of the child widgets are packed together into a solid
rectangle then you want to set box() to FL_NO_BOX or
one of the _FRAME types. This will result in the best output.
diff --git a/FL/Fl_Scrollbar.H b/FL/Fl_Scrollbar.H
index 5a5dd0e89..6fb3b6826 100644
--- a/FL/Fl_Scrollbar.H
+++ b/FL/Fl_Scrollbar.H
@@ -44,7 +44,8 @@
integers). If desired you can set the step() to non-integer
values. You will then have to use casts to get at the floating-point
versions of value() from Fl_Slider. </P>
- <P ALIGN=CENTER>\image html scrollbar.gif
+ <P ALIGN=CENTER>\image html scrollbar.gif
+ \image latex scrollbar.eps "Fl_Scrollbar" width=4cm
*/
class FL_EXPORT Fl_Scrollbar : public Fl_Slider {
diff --git a/FL/Fl_Simple_Counter.H b/FL/Fl_Simple_Counter.H
index 3cf559fae..0289bd161 100644
--- a/FL/Fl_Simple_Counter.H
+++ b/FL/Fl_Simple_Counter.H
@@ -34,7 +34,8 @@
#include "Fl_Counter.H"
/**
This widget creates a counter with only 2 arrow buttons
- <P align=center>\image html counter.gif</P>
+ <P align=center>\image html counter.gif</P>
+ \image latex counter.eps "Fl_Simple_Counter" width=4cm
*/
class Fl_Simple_Counter : public Fl_Counter {
public:
diff --git a/FL/Fl_Slider.H b/FL/Fl_Slider.H
index 1a54e9afe..df504522e 100644
--- a/FL/Fl_Slider.H
+++ b/FL/Fl_Slider.H
@@ -65,7 +65,8 @@
<LI>FL_HOR_NICE_SLIDER - Draws a horizontal slider with a
nice looking control knob. </LI>
</UL>
- <P ALIGN=CENTER>\image html slider.gif
+ <P ALIGN=CENTER>\image html slider.gif
+ \image latex slider.eps "Fl_Slider" width=4cm
*/
class FL_EXPORT Fl_Slider : public Fl_Valuator {
diff --git a/FL/Fl_Tabs.H b/FL/Fl_Tabs.H
index a2e3d958c..f8df1cd7c 100644
--- a/FL/Fl_Tabs.H
+++ b/FL/Fl_Tabs.H
@@ -38,7 +38,8 @@
interface that allows you to put lots and lots of buttons and
switches in a panel, as popularized by many toolkits.
- <P ALIGN=CENTER>\image html tabs.gif </P>
+ <P ALIGN=CENTER>\image html tabs.gif </P>
+ \image latex tabs.eps "Fl_Tabs" width=8cm
<P>Clicking the tab makes a child visible() by calling
show() on it, and all other children are made invisible
diff --git a/FL/Fl_Tile.H b/FL/Fl_Tile.H
index 73aa4bdf8..a47b07b41 100644
--- a/FL/Fl_Tile.H
+++ b/FL/Fl_Tile.H
@@ -37,7 +37,8 @@
The Fl_Tile class lets you resize the children by dragging
the border between them:
- <P ALIGN=CENTER>\image html Fl_Tile.gif </P>
+ <P ALIGN=CENTER>\image html Fl_Tile.gif </P>
+ \image latex Fl_Tile.eps "Fl_Tile" width=4cm
<P>For the tiling to work correctly, the children of an
Fl_Tile must cover the entire area of the widget, but not
diff --git a/FL/Fl_Valuator.H b/FL/Fl_Valuator.H
index 89dce8503..4adfe1e73 100644
--- a/FL/Fl_Valuator.H
+++ b/FL/Fl_Valuator.H
@@ -44,7 +44,8 @@
and provides a consistent interface to set the value, range, and step,
and insures that callbacks are done the same for every object.
<P>There are probably more of these classes in FLTK than any others:
- <P ALIGN=CENTER>\image html valuators.gif</P>
+ <P ALIGN=CENTER>\image html valuators.gif</P>
+ \image latex valuators.eps "Valuators derived from Fl_Valuators" width=10cm
<P>In the above diagram each box surrounds an actual subclass. These
are further differentiated by setting the type() of the widget t
o the symbolic value labeling the widget.
diff --git a/FL/Fl_Value_Input.H b/FL/Fl_Value_Input.H
index f17adcd06..1134d3ce3 100644
--- a/FL/Fl_Value_Input.H
+++ b/FL/Fl_Value_Input.H
@@ -59,7 +59,8 @@
of numbers are limited to integers instead of floating point
values.
- <P ALIGN="CENTER">\image html Fl_Value_Input.gif
+ <P ALIGN="CENTER">\image html Fl_Value_Input.gif
+ \image latex Fl_Value_Input.eps "Fl_Value_Input" width=8cm
*/
class FL_EXPORT Fl_Value_Input : public Fl_Valuator {
public:
diff --git a/FL/Fl_Value_Output.H b/FL/Fl_Value_Output.H
index 266c08bd5..200e66446 100644
--- a/FL/Fl_Value_Output.H
+++ b/FL/Fl_Value_Output.H
@@ -44,7 +44,8 @@
<P>This is much lighter-weight than
Fl_Value_Input because it contains no text editing code or
character buffer. </P>
- <P ALIGN=CENTER>\image html Fl_Value_Output.gif
+ <P ALIGN=CENTER>\image html Fl_Value_Output.gif
+ \image latex Fl_Value_Output.eps "Fl_Value_Output" width=8cm
*/
class FL_EXPORT Fl_Value_Output : public Fl_Valuator {
Fl_Font textfont_;
diff --git a/FL/Fl_Value_Slider.H b/FL/Fl_Value_Slider.H
index cc2300350..e2b941f48 100644
--- a/FL/Fl_Value_Slider.H
+++ b/FL/Fl_Value_Slider.H
@@ -36,7 +36,8 @@
/**
The Fl_Value_Slider widget is a Fl_Slider widget
with a box displaying the current value.
- <P ALIGN=CENTER>\image html value_slider.gif
+ <P ALIGN=CENTER>\image html value_slider.gif
+ \image latex value_slider.eps "Fl_Value_Slider" width=4cm
*/
class FL_EXPORT Fl_Value_Slider : public Fl_Slider {
Fl_Font textfont_;