From 46f509f7de8b069eccaa081bbb7112a532c33e51 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 14 Jan 1999 22:14:01 +0000 Subject: More image updates, minor typos, etc. git-svn-id: file:///fltk/svn/fltk/trunk@227 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Gl_Window.html | 21 +++++++++------------ documentation/Fl_Group.html | 6 ++---- documentation/Fl_Input.html | 8 ++++---- documentation/Fl_Menu_.html | 6 +++--- documentation/Fl_Menu_Bar.html | 4 ++-- documentation/Fl_Menu_Button.html | 8 ++++---- documentation/Fl_Positioner.html | 4 ++-- documentation/Fl_Scroll.html | 4 ++-- documentation/Fl_Single_Window.html | 5 +++-- documentation/Fl_Tabs.html | 4 ++-- documentation/Fl_Tile.html | 15 ++++++++------- documentation/Fl_Valuator.html | 8 ++++---- documentation/Fl_Value_Slider.html | 4 ++-- documentation/Fl_Widget.html | 19 +++++++++---------- documentation/Makefile | 8 ++++---- documentation/forms.html | 4 ++-- documentation/functions.html | 6 ++---- documentation/menu_button.gif | Bin 2874 -> 1632 bytes documentation/menubar.gif | Bin 4537 -> 3798 bytes documentation/value_slider.gif | Bin 3357 -> 8401 bytes 20 files changed, 64 insertions(+), 70 deletions(-) (limited to 'documentation') diff --git a/documentation/Fl_Gl_Window.html b/documentation/Fl_Gl_Window.html index 205d3225c..f4010f756 100644 --- a/documentation/Fl_Gl_Window.html +++ b/documentation/Fl_Gl_Window.html @@ -127,8 +127,7 @@ context for this window or when the window resizes, and is turned on afterdraw() is called. You can use this inside your draw() method to avoid unneccessarily initializing the OpenGL context. Just do this: - + +You can turn valid() on by calling valid(1). You should only do this after fixing the transformation inside a draw() - or after make_current(). This is done automatically after +or after make_current(). This is done automatically after draw() returns.

void Fl_Gl_Window::invalidate()

The invalidate() method turns off valid() and is @@ -215,4 +212,4 @@ Fl_Gl_Window::valid() and set the same transformation. If you don't your code may not work on other systems. Depending on the OS, and on whether overlays are real or simulated, the OpenGL context may be the same or different between the overlay and main window.

- \ No newline at end of file + diff --git a/documentation/Fl_Group.html b/documentation/Fl_Group.html index 16e8e4f58..e307d71b4 100644 --- a/documentation/Fl_Group.html +++ b/documentation/Fl_Group.html @@ -87,9 +87,7 @@ automatically called by the constructor for Fl_Group (and thus for Fl_Window as well). begin() does current(this).

Don't forget to end() the group or window!

Fl_Widget *Fl_Group::child(int n) const

- Returns child n, where 0 - -. + Returns child n, where 0 <= n < children().

int Fl_Group::children() const

Returns how many child widgets the group has.

static Fl_Group *Fl_Group::current() @@ -133,4 +131,4 @@ and distance from the top-left corner.

It is possible to achieve any type of resize behavior by using an invisible Fl_Box as the resizable and/or by using a hierarchy of child Fl_Group's.

- \ No newline at end of file + diff --git a/documentation/Fl_Input.html b/documentation/Fl_Input.html index 98614ffb9..8e4317022 100644 --- a/documentation/Fl_Input.html +++ b/documentation/Fl_Input.html @@ -27,8 +27,8 @@ will correctly display anything, using ^X notation for unprintable control characters and \nnn notation for unprintable characters with the high bit set. It assummes the font can draw any characters in the ISO8859-1 character set. - -
Mouse button 1Moves the cursor to this point. +
+ -
Mouse button 1Moves the cursor to this point. Drag selects characters. Double click selects words. Triple click selects all text. Shift+click extends the selection.
Mouse button 2Insert the current X selection at @@ -71,7 +71,7 @@ into a single "undo". Often this will undo a lot more than you expected.
Shift+moveMove the cursor but also extend the selection.
+

Methods

@@ -176,4 +176,4 @@ fields.

Fl_Color Fl_Input::cursor_color() const
void Fl_Input::cursor_color(Fl_Color)

- Get or set the color of the cursor. This is black by default. \ No newline at end of file + Get or set the color of the cursor. This is black by default. diff --git a/documentation/Fl_Menu_.html b/documentation/Fl_Menu_.html index 93fafc7e7..3120ccb76 100644 --- a/documentation/Fl_Menu_.html +++ b/documentation/Fl_Menu_.html @@ -96,9 +96,9 @@ focus when you type it. This is done by using Fl::add_handler(). This Fl_Menu_ widget does not have to be visible (ie the window it is in can be hidden, or it does not have to be put in a window at all). -

Currently there can be only one global()menu. Setting a new +

Currently there can be only one global()menu. Setting a new one will replace the old one. There is no way to remove the -global() setting (including destroying the menu).

+global() setting (including destroying the menu).

const char* Fl_Menu_::text() const
const char* Fl_Menu_::text(int i) const

Returns the title of the last item chosen, or of item i. @@ -160,4 +160,4 @@ Fl_Menu_ widget if it uses it's own array. This box type is used to surround the currently-selected items in the menus. If this is FL_NO_BOX then it acts like FL_THIN_UP_BOX and selection_color() acts like -FL_WHITE, for back compatability. \ No newline at end of file +FL_WHITE, for back compatability. diff --git a/documentation/Fl_Menu_Bar.html b/documentation/Fl_Menu_Bar.html index 38cfbe521..208d7fa36 100644 --- a/documentation/Fl_Menu_Bar.html +++ b/documentation/Fl_Menu_Bar.html @@ -27,7 +27,7 @@ single Fl_Menu_Item top level menu defines the items in the menubar, while the submenus define the pull-down menus. Sub-sub menus and lower pop up to the right of the submenus.

-

+

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.

@@ -60,4 +60,4 @@ put it outside the menubar.

virtual Fl_Menu_Bar::~Fl_Menu_Bar()

The destructor removes the Fl_Menu_Bar widget and all of its -menu items. \ No newline at end of file +menu items. diff --git a/documentation/Fl_Menu_Button.html b/documentation/Fl_Menu_Button.html index f3b7eaac0..b1df98060 100644 --- a/documentation/Fl_Menu_Button.html +++ b/documentation/Fl_Menu_Button.html @@ -20,7 +20,7 @@ This is a button that when pushed pops up a menu (or hierarchy of menus) defined by an array of Fl_Menu_Item objects. -

+

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() @@ -59,8 +59,8 @@ its menu items. shortcut key. The menu appears, it waits for the user to pick an item, and if they pick one it sets value() and does the callback or sets changed() as described above. The menu item is returned -or NULLif the user dismisses the menu. -

void Fl_Widget::type(uchar)

+or NULLif the user dismisses the menu. +

void Fl_Menu_Button::type(uchar)

If type() is zero a normal menu button is produced. If it is nonzero then this is a pop-up menu. The bits in type() indicate what mouse buttons pop up the menu. For convienece the @@ -76,4 +76,4 @@ widgets covering different areas for context-sensitive popup menus.

selected item. This is a feature. If you don't like it, do value(0) after the menu items are picked to forget the current item.

- \ No newline at end of file + diff --git a/documentation/Fl_Positioner.html b/documentation/Fl_Positioner.html index d714cc6b1..720b4b2e8 100644 --- a/documentation/Fl_Positioner.html +++ b/documentation/Fl_Positioner.html @@ -21,7 +21,7 @@ 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(). -

+

Methods

@@ -66,4 +66,4 @@ float *y) const Sets the stepping value for the Y axis.

float Fl_Positioner::yvalue(void) const
void Fl_Positioner::yvalue(float y)

- Gets or sets the Y axis coordinate. \ No newline at end of file + Gets or sets the Y axis coordinate. diff --git a/documentation/Fl_Scroll.html b/documentation/Fl_Scroll.html index 2140e93d1..cd5bef9b2 100644 --- a/documentation/Fl_Scroll.html +++ b/documentation/Fl_Scroll.html @@ -21,7 +21,7 @@ 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: -

+

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. @@ -96,4 +96,4 @@ the top. Gets the current vertical scrolling position.

void Fl_Scroll::position(int w, int h)

- Sets the upper-lefthand corner of the scrolling region. \ No newline at end of file + Sets the upper-lefthand corner of the scrolling region. diff --git a/documentation/Fl_Single_Window.html b/documentation/Fl_Single_Window.html index f0f628d0f..2c97cb467 100644 --- a/documentation/Fl_Single_Window.html +++ b/documentation/Fl_Single_Window.html @@ -17,7 +17,7 @@

Description

- This is the same as Fl_Window. However, it is possible that + This is the same as Fl_Window. However, it is possible that some implementations will provide double-buffered windows by default. This subclass can be used to force single-buffering. This may be useful for modifying existing programs that use incremental update, or @@ -34,4 +34,5 @@ char *label = 0) position, size, and label (title) string.

virtual Fl_Single_Window::~Fl_Single_Window()

- Destroys the window and all child widgets. \ No newline at end of file + Destroys the window and all child widgets. + diff --git a/documentation/Fl_Tabs.html b/documentation/Fl_Tabs.html index e0f7196f1..88b37a249 100644 --- a/documentation/Fl_Tabs.html +++ b/documentation/Fl_Tabs.html @@ -20,7 +20,7 @@ The Fl_Tabs widget is the "file card tabs" interface that allows you to put lots and lots of buttons and switches in a panel, as popularized by many toolkits. -

+

Clicking the tab makes a child visible() (by calling show() on it) and all other children are invisible (by calling hide() on them). Usually the children are @@ -61,4 +61,4 @@ variables, but you must declare the Fl_Tabfirst, so that it is destroyed last.

Fl_Widget* Fl_Tabs::value() const
int Fl_Tabs::value(Fl_Widget*)

- Gets or sets the currently visible widget/tab. \ No newline at end of file + Gets or sets the currently visible widget/tab. diff --git a/documentation/Fl_Tile.html b/documentation/Fl_Tile.html index abbd8fc5f..fb837d70b 100644 --- a/documentation/Fl_Tile.html +++ b/documentation/Fl_Tile.html @@ -21,7 +21,7 @@

Description

The Fl_Tile class lets you resize the children by dragging the border between them: -

+

Fl_Tile allows objects to be resized to zero dimensions. To prevent this you can use the resizable() to limit where corners can be dragged to.

@@ -30,10 +30,10 @@ initially have non-zero sizes so the Fl_Tile can figure out their layout. If desired, call position() after creating the children but before displaying the window to set the borders where you want.

-

The "borders" are part of the children, an Fl_Tiledoes not +

The "borders" are part of the children, an Fl_Tiledoes not draw any graphics of it's own. In the above example all the final children have FL_DOWN_BOX types, and the "ridges" you see are -two adjacent FL_DOWN_BOX's drawn next to each other.

+two adjacent FL_DOWN_BOX's drawn next to each other.

Methods

  • Fl_Tile
    • @@ -56,10 +56,11 @@ that it is destroyed last. to_x, to_y) Drag the intersection at from_x,from_y to to_x,to_y. This redraws all the necessary children. -

    void Fl_Tile::resizable(Fl_Widget The -"resizable" child widget (which should be invisible) limits where the +

    void Fl_Tile::resizable(Fl_Widget &w)
    +void Fl_Tile::resizable(Fl_Widget *w)

    +The "resizable" child widget (which should be invisible) limits where the border can be dragged to. If you don't set it, it will be possible to drag the borders right to the edge, and thus resize objects on the edge to zero width or height. The resizable() widget is not -resized by dragging any borders.

    - \ No newline at end of file +resized by dragging any borders. + diff --git a/documentation/Fl_Valuator.html b/documentation/Fl_Valuator.html index ea0c8ca36..b192d8f62 100644 --- a/documentation/Fl_Valuator.html +++ b/documentation/Fl_Valuator.html @@ -24,13 +24,13 @@ 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:

    -

    +

    In the above diagram each box surrounds an actual subclass. These are further differentiated by setting the type() of the widget to the symbolic value labeling the widget. The ones labelled "0" are the default versions with a -type(0). For consistency the symbol FL_VERTICAL is -defined as zero.

    +type(0). For consistency the symbol FL_VERTICAL is +defined as zero.

    Methods

@@ -133,4 +133,4 @@ turn it back on if desired).

Sets the changed() flag.

void Fl_Widget::clear_changed()

- Clears the changed() flag. \ No newline at end of file + Clears the changed() flag. diff --git a/documentation/Fl_Value_Slider.html b/documentation/Fl_Value_Slider.html index 847330b3e..a2b8ce518 100644 --- a/documentation/Fl_Value_Slider.html +++ b/documentation/Fl_Value_Slider.html @@ -19,7 +19,7 @@

Description

The Fl_Value_Slider widget is a Fl_Slider widget with a box displaying the current value. -

+

Methods

  • Fl_Value_Slider
    • @@ -49,4 +49,4 @@ Fl_Value_Slider::textfont() const

    uchar Fl_Value_Slider::textsize() const
    void Fl_Value_Slider::textsize(uchar)

    - Gets or sets the size of the text in the value box. \ No newline at end of file + Gets or sets the size of the text in the value box. diff --git a/documentation/Fl_Widget.html b/documentation/Fl_Widget.html index 4b619127d..708b061a5 100644 --- a/documentation/Fl_Widget.html +++ b/documentation/Fl_Widget.html @@ -167,18 +167,17 @@ the label as text.
    void Fl_Widget::align(Fl_Align) How the label is printed next to or inside the widget. The default value is FL_ALIGN_CENTER, which centers the label. The value -can be any of these constants or'd together: +can be any of these constants or'd together:
      -
    • FL_ALIGN_CENTER
      • -
    • FL_ALIGN_TOP
      • -
    • FL_ALIGN_BOTTOM
      • -
    • FL_ALIGN_LEFT
      • -
    • FL_ALIGN_RIGHT
      • -
    • FL_ALIGN_INSIDE
      • -
    • FL_ALIGN_CLIP
      • -
    • FL_ALIGN_WRAP
      • +
    • FL_ALIGN_CENTER
      • +
    • FL_ALIGN_TOP
      • +
    • FL_ALIGN_BOTTOM
      • +
    • FL_ALIGN_LEFT
      • +
    • FL_ALIGN_RIGHT
      • +
    • FL_ALIGN_INSIDE
      • +
    • FL_ALIGN_CLIP
      • +
    • FL_ALIGN_WRAP
    -

    Fl_Color Fl_Widget::labelcolor() const
    void Fl_Widget::labelcolor(Fl_Color)

    This color is passed to the labeltype routine, and is typically the diff --git a/documentation/Makefile b/documentation/Makefile index 26f93432e..03878659c 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -1,5 +1,5 @@ # -# "$Id: Makefile,v 1.5 1999/01/13 16:25:15 mike Exp $" +# "$Id: Makefile,v 1.6 1999/01/14 22:14:00 mike Exp $" # # Documentation makefile for the Fast Light Tool Kit (FLTK). # @@ -115,7 +115,7 @@ HTMLFILES = \ osissues.html \ license.html -all: fltk.ps fltk.pdf +all: fltk.ps fltk.pdf fltk.d/index.html clean: rm -rf fltk.d @@ -130,7 +130,7 @@ fltk.d/index.html: $(HTMLFILES) @echo "Generating HTML documentation..." @-mkdir fltk.d @-rm -f fltk.d/* - @$(HTMLDOC) -d fltk.d -t html --verbose --toclevels 2 --title FL.gif $(HTMLFILES) + @$(HTMLDOC) -d fltk.d -t html --verbose --toclevels 2 --bodycolor white --title FL.gif $(HTMLFILES) fltk.ps: $(HTMLFILES) @echo "Generating PostScript documentation..." @@ -142,5 +142,5 @@ fltk.pdf: $(HTMLFILES) @$(HTMLDOC) -f fltk.pdf --compression=9 --jpeg=90 --duplex --verbose --toclevels 2 --title FL.gif $(HTMLFILES) # -# End of "$Id: Makefile,v 1.5 1999/01/13 16:25:15 mike Exp $". +# End of "$Id: Makefile,v 1.6 1999/01/14 22:14:00 mike Exp $". # diff --git a/documentation/forms.html b/documentation/forms.html index bf4202b5f..f08952a94 100644 --- a/documentation/forms.html +++ b/documentation/forms.html @@ -166,7 +166,7 @@ have to rewrite things a lot.

    You Cannot Use <device.h>

    If you have written your own "free" widgets you will probably get a lot of errors about "getvaluator". You should substitute: -
+
@@ -177,7 +177,7 @@ lot of errors about "getvaluator". You should substitute: -
FormsFLTK
MOUSE_XFl::event_x_root()
MOUSE_YFl::event_y_root()
MOUSE1,RIGHTMOUSEFl::event_state()
MOUSE2,MIDDLEMOUSEFl::event_state()
MOUSE3,LEFTMOUSEFl::event_state()
+
 Anything else in getvaluator and you are on your own...

Font Numbers Are Different

The "style" numbers have been changed because I wanted to insert diff --git a/documentation/functions.html b/documentation/functions.html index 964bcea84..96ddc536b 100644 --- a/documentation/functions.html +++ b/documentation/functions.html @@ -559,11 +559,9 @@ other programs). The window does not have to be shown() all event handling and allows you to map and unmap a complex set of windows (under both X and WIN32 some window must be mapped because the system interface needs a window id). -

Fl::event_x() and Fl::event_y() - - are undefined if the +

Fl::event_x() and Fl::event_y() are undefined if the passed widget is not a mapped Fl_Window. Use -Fl::event_x_root() and Fl::event_y_root() instead.

+Fl::event_x_root() and Fl::event_y_root() instead.

Be careful that your program does not enter an infinite loop while grab() is on. On X this will lock up your screen!

The second function returns the current grab window, or NULL diff --git a/documentation/menu_button.gif b/documentation/menu_button.gif index 5ee9b58ec..9fc5df0dd 100644 Binary files a/documentation/menu_button.gif and b/documentation/menu_button.gif differ diff --git a/documentation/menubar.gif b/documentation/menubar.gif index 955b81a35..383598d0f 100644 Binary files a/documentation/menubar.gif and b/documentation/menubar.gif differ diff --git a/documentation/value_slider.gif b/documentation/value_slider.gif index 668bd79fc..ab1c00197 100644 Binary files a/documentation/value_slider.gif and b/documentation/value_slider.gif differ -- cgit v1.2.3