From d272c1b43fc60f284591e7121f8813969374a7b3 Mon Sep 17 00:00:00 2001
From: Fabien Costantini \image html adjuster1.gif 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 int Fl_Widget::changed() const
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 \image html counter.gif \image html dial.gif
+ \image html dial.gif
+ \image latex dial.eps "Fl_Dial" width=4cm
Use type() to set the type of the dial to:
\image html Fl_File_Input.gif \image html Fl_File_Input.gif
+
\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 \endhtmlonly
+ \image html clock.gif
+ \htmlonly \endhtmlonly
+ \image html round_clock.gif
+ \htmlonly
+
\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.
\endhtmlonly
+ \image html clock.gif
+ \htmlonly \endhtmlonly
+ \image html round_clock.gif
+ \htmlonly
\image html resizebox1.gif \image html resizebox2.gif
+ \image latex resizebox1.eps "before resize" width=4cm + \image latex resizebox2.eps "after resize" width=4cmThe 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(). -
\image html Fl_Light_Button.gif
+\image html Fl_Light_Button.gif
+ \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.\image html menubar.gif
+ \image latex menubar.eps " menubar" width=12cmIf 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.
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.\image html menu_button.gif
+ \image latex menu_button.eps " menu_button" width=5cmNormally 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:
\image html menu.gif
- + \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. -\image html text.gif
+\image html text.gif
+ \image latex text.eps "Fl_Output" width=8cmThere is a single subclass, Fl_Multiline_Output, which allows you to display multiple lines of text.
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(). -\image html positioner.gif
+\image html positioner.gif
+ \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. -\image html Fl_Return_Button.gif +
\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. -
\image html Fl_Roller.gif +
\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(). -
\image html Fl_Round_Button.gif
+\image html Fl_Round_Button.gif
+ \image latex Fl_Round_Button.eps " Fl_Round_Button" width=4cmThe 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: -
\image html Fl_Scroll.gif
+\image html Fl_Scroll.gif
+ \image latex Fl_Scroll.eps "Fl_Scroll" width=4cmIf 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.
-\image html scrollbar.gif +
\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 -
\image html counter.gif
+\image html counter.gif
+ \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 @@\image html slider.gif +
\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. -
\image html tabs.gif
+\image html tabs.gif
+ \image latex tabs.eps "Fl_Tabs" width=8cmClicking 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: -
\image html Fl_Tile.gif
+\image html Fl_Tile.gif
+ \image latex Fl_Tile.eps "Fl_Tile" width=4cmFor 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.
There are probably more of these classes in FLTK than any others: -
\image html valuators.gif
+\image html valuators.gif
+ \image latex valuators.eps "Valuators derived from Fl_Valuators" width=10cmIn 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. -
\image html Fl_Value_Input.gif +
\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 @@
This is much lighter-weight than Fl_Value_Input because it contains no text editing code or character buffer.
-\image html Fl_Value_Output.gif +
\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. -
\image html value_slider.gif +
\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_;
diff --git a/documentation/src/FL.eps b/documentation/src/FL.eps
new file mode 100644
index 000000000..e69de29bb
diff --git a/documentation/src/Fl_Check_Button.eps b/documentation/src/Fl_Check_Button.eps
new file mode 100644
index 000000000..e69de29bb
diff --git a/documentation/src/Fl_File_Chooser.eps b/documentation/src/Fl_File_Chooser.eps
new file mode 100644
index 000000000..d0865bda2
--- /dev/null
+++ b/documentation/src/Fl_File_Chooser.eps
@@ -0,0 +1,537 @@
+%!PS-Adobe-3.0 EPSF-3.0
+%%BoundingBox: 0 0 498 408
+%%Title: (Fl_File_Chooser.eps)
+%%Creator: jpeg2eps.ps 1.20 http://rses.anu.edu.au/~andy/jpeg2eps/
+%%LanguageLevel: 2
+%%DocumentData: Clean7Bit
+%%EndComments
+498 408 scale
+/DeviceRGB setcolorspace
+<< % Fl_File_Chooser.eps
+ /ImageType 1 % 1: opaque, 4: make MaskColor color ranges transparent
+ /Decode [ 0 1 0 1 0 1 ] % change these values to alter brightness/contrast of each color
+% REMOVE % AT START OF NEXT LINE IF /ImageType 4
+% /MaskColor [ 245 255 245 255 245 255 ] % don't paint these color ranges if /ImageType 4
+ /Width 498
+ /Height 408
+ /ImageMatrix [ 498 0 0 -408 0 408 ]
+ /BitsPerComponent 8
+ /MultipleDataSources false
+ /Interpolate false
+ /DataSource currentfile
+ /ASCII85Decode filter
+ /DCTDecode filter
+>>
+image
+s4IA0!"_al8O`[\! tA-e+GQr9g;QPe:b%d@qBUn
+qO2l1T;eaRC&49IVOsicl79< me`DchZ)bE5
+I'"gheu>+WnVpJPWX2R ]7:r:d0SJ:GSQq.p$l,$Z/ \image html Fl_Help_Dialog.gif \image html Fl_Help_Dialog.gif +c2(7gT6R5nr
+.<:YTAD[GYdf0<.K5l:d1F%f9a,)%VOlAq%,^GP8aW=uKgZX>\X/qsle]=B0?9;\Zb$Rd&bdp+e
+(`+lqZm3AKj@JheGu?c'ntX?g)B&ae?.eQtkLjL-aMI4@;pXCQQC^;BC6Z]L4e)@4S,>F=r&pPI
+4e)@4bPXMmr&pPI4e)@4S,>F=r&pPI4e)@4S,>Fmr&pPI4j3adS,>F=r&pPI4e)@4S,>F=r&rg4
+q=&8b]9c\ci@@JY;UQdDBK"\F;0"'b?a7rr=@WZ.rX2ZHjJPT#8]%?0oYrP,21fP"_*i6p.DZ
+U/YXJ,XC*gC?S8k9%=RWaA:;W=VI=](iD=`Gr1V9KiDUDX
+F!GeqY0oa"L0P`1X*ogC!td04jHQJ"1m8\ppXD,srp:t9:fclQW1;:Me\BKmVPY2H+>@:
T+cIsL\T3ol$i^4%H@]4nfO@iTQJ1hS6,)Erf^(Y0olO]A?r.#LZ^
+Tr;>s)j4K%N\MQ4*e15_Yum@ <^h.o$edp_=&<#h3p
+).Fk`5`n`*l:lCHG[X:R-FK,%Io/Ma@pu[<6cE0nab]?JRX5Oj2W`.joHBYAZ.:'McN`B1OK:k+
+8eRkKV.;Nb#+$N5OY;Em`k6ku?g,WZQ!#N77*-)iiU6N2e:r1Dh2^L_I?o-5N:miD[Al@Zpao?6
+97I0q?%UDa\]d*)i(-8kQ7q4-bW88P84b`n2E`Tcof<$PN/WsdBLs.\NIF&6GZ6eG9PHU$!a%ck
+B7k2.VbpqK84*)r@c<+gA/:ue`DL%\&Ca5<\:58HgCr-?W)R\TB/Bk/u*kS
'UDUfO?r+IS>/4iR7;Kg#Gb[H
+N:_^5)rGT0;K`Y1.lS4g6+^&*K"hgWe)a6+nlB2n8A*Sf:>8gI,60Va@n^q2rrB*#cRDAA0sEf3GlIaW
+<\6q_0/\HW1qn`AF]a''J=jZ*7EmJep*'=An4WWirS)QM."g(KLjna(')og6G2