diff --git a/documentation/Fl_Adjuster.html b/documentation/Fl_Adjuster.html index bb51e26c1..e3336f8c5 100644 --- a/documentation/Fl_Adjuster.html +++ b/documentation/Fl_Adjuster.html @@ -17,14 +17,15 @@

Description

- The Fl_Adjuster widget was stolen from Prisms, and has proven -to be very useful for values that need a large dynamic range. 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 smallest button -by step(). Clicking on the buttons increments by 10 times the -amount dragging by a pixel does. Shift + click decrements by 10 times -the amount. +The Fl_Adjuster widget was stolen from Prisms, and has proven +to be very useful for values that need a large dynamic range. +

+

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 +smallest button by step(). Clicking on the buttons +increments by 10 times the amount dragging by a pixel does. Shift + +click decrements by 10 times the amount.

Methods

Description

- Buttons generate callbacks when they are clicked by the user. You +Buttons generate callbacks when they are clicked by the user. You control exactly when and how by changing the values for type() - and when(). +and when(). +

The Fl_Check_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_DIAMOND_DOWN_BOX. The color of the @@ -37,4 +38,4 @@ Fl_Check_Button::Fl_Check_Button(int x, int y, int w, int h, const char position, size, and label string.

Fl_Check_Button::~Fl_Check_Button()

- The destructor deletes the check button. \ No newline at end of file + The destructor deletes the check button. diff --git a/documentation/Fl_Input.html b/documentation/Fl_Input.html index 8e4317022..0c65dc962 100644 --- a/documentation/Fl_Input.html +++ b/documentation/Fl_Input.html @@ -58,7 +58,7 @@ only, otherwise it moves to the next input field). otherwise it moves to the previous input field). ^Q or
RightCtrl or -
ComposeStart a compose-character +
ComposeStart a compose-character sequence. The next one or two keys typed define the character to insert. This also can be used to "quote" control characters. ^UDelete everything. @@ -176,4 +176,6 @@ 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. + Get or set the color of the cursor. This is black by default. + + diff --git a/documentation/Fl_Int_Input.html b/documentation/Fl_Int_Input.html index 78382ebc2..9cdfaa650 100644 --- a/documentation/Fl_Int_Input.html +++ b/documentation/Fl_Int_Input.html @@ -5,7 +5,7 @@

Class Hierarchy

Description

- Buttons generate callbacks when they are clicked by the user. You +Buttons generate callbacks when they are clicked by the user. You control exactly when and how by changing the values for type() - and when(). +and when(). +

The Fl_Light_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_DOWN_BOX. The color of the light when @@ -37,4 +38,4 @@ Fl_Light_Button::Fl_Light_Button(int x, int y, int w, int h, const char position, size, and label string.

Fl_Light_Button::~Fl_Light_Button()

- The destructor deletes the check button. \ No newline at end of file + The destructor deletes the check button. diff --git a/documentation/Fl_Return_Button.html b/documentation/Fl_Return_Button.html index a6a740ea9..7d5653480 100644 --- a/documentation/Fl_Return_Button.html +++ b/documentation/Fl_Return_Button.html @@ -14,9 +14,10 @@ 
#include <FL/Fl_Return_Button.H>

Description

- The Fl_Return_Button is a subclass of Fl_Button that +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. +

Methods

Description

- Buttons generate callbacks when they are clicked by the user. You +Buttons generate callbacks when they are clicked by the user. You control exactly when and how by changing the values for type() - and when(). +and when(). +

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 @@ -37,4 +38,4 @@ Fl_Round_Button::Fl_Round_Button(int x, int y, int w, int h, const char position, size, and label string.

Fl_Round_Button::~Fl_Round_Button()

- The destructor deletes the check button. \ No newline at end of file + The destructor deletes the check button. diff --git a/documentation/Fl_Value_Input.html b/documentation/Fl_Value_Input.html index 9dfd5d9df..00b24c7f6 100644 --- a/documentation/Fl_Value_Input.html +++ b/documentation/Fl_Value_Input.html @@ -19,7 +19,7 @@

Description

The Fl_Value_Input widget displays a floating point value. The user can click in the text field and edit it (there is in fact a -hidden Fl_Value_Input widget with +hidden Fl_Input widget with type(FL_FLOAT_INPUT) in there), and when they hit return or tab the value updates to what they typed and the callback is done.

If step() is not zero, the user can also drag the mouse @@ -68,4 +68,4 @@ const

uchar Fl_Value_Input::textsize() const
void Fl_Value_Input::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 708b061a5..63c534fe6 100644 --- a/documentation/Fl_Widget.html +++ b/documentation/Fl_Widget.html @@ -21,7 +21,7 @@

Description

Fl_Widget is the base class for all widgets in FLTK. You can't create one of these because the constructor is not public. However you -can subclass it. +can subclass it.

All "property" accessing methods, such as color(), parent(), or argument() are implemented as trivial inline functions and thus are as fast and small as accessing fields in a @@ -38,14 +38,15 @@ to call redraw() after these.

  • ~Fl_Widget
  • activate
  • active
    • +
  • active_r
  • activevisible
  • align
  • argument
  • box
    • -
  • callback
    •

    Setting the Size and Position of Widgets

    - The size and position of widgets is usually set when you create them. - You can change this at any time using the position, -resize(), and size methods: +The size and position of widgets is usually set when you create them. +You can access them with the x(), y(), w(), +and h() methods. +

    You can change the size and position by using the position(), +resize(), and size() methods:

    - Changing the size or position of a widget will cause a redraw of that -widget and its children. +If you change a widget's size or position after it is displayed you +will have to call redraw() on the widget's parent.

    Colors

    - FLTK manages a virtual color palette of "standard" colors. The -standard colors are: +FLTK stores the colors of widgets as an 8-bit number that is an index +into a color palette of 256 colors. This is not the X or WIN32 +colormap, but instead is an internal table with fixed contents. +

    There are symbols for naming some of the more common colors:

    The widget color can be set using the color() method: -

    Fl::event_key() Values

    +

    Fl::event_key() Values

    The following constants define the non-ASCII keys on the keyboard for FL_KEYBOARD and FL_SHORTCUT events: - \ No newline at end of file + +

    FLTK Compose-Character Sequences

    + +The Fl_Input widget lets you type all the +characters in the standard ISO-8859-1 character set. Most fonts will +display these characters correctly. + +

    To insert them, type the [compose] key and then one or two +characters. The two characters can be in either order. The [compose] +key is any of: Ctrl+Q, the righthand control key, or any key your X server +calls XK_Multi_key. + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    spnbsp*°A`ÀD-Ða`àd-ð
    !¡+-±A'ÁN~Ña'án~ñ
    %¢2²A^ÂO`Òa^âo`ò
    #£3³A~ÃO'Óa~ão'ó
    $¤'´A:ÄO^Ôa:äo^ô
    y=¥uµA*ÅO~Õa*åo~õ
    |¦pAEÆO:Öaeæo:ö
    &§.·C,Çx×c,ç-:÷
    :¨,¸E`ÈO/Øe`èo/ø
    c©1¹E'ÉU`Ùe'éu`ù
    aªoºE^ÊU'Úe^êu'ú
    <<«>>»E:ËU^Ûe:ëu^û
    ~¬14¼I`ÌU:Üi`ìu:ü
    -­12½I'ÍY'Ýi'íy'ý
    r®34¾I^ÎDDÞi^îddþ
    _¯?¿I:Ïssßi:ïy:ÿ
    +
    + +For instance, to type "á" type [compose][a]['] or [compose]['][a]. + +

    The character "nbsp" (non-breaking space) is typed by using +[compose][space]. + +

    The single-character sequences may be followed by a space if +necessary to remove ambiguity. For instance, if you really want to +type "ª~" rather than "ã" you must type [compose][a][space][~]. + +

    If you wish to use the compose function in your own code, your +widget's handle() method must call fl_compose() +in response to FL_KEYPRESS events: + +

    int fl_compose(int state, char c, int &del, char *buffer, int &ins)

    + +Starts or adds a single ASCII character to a compose sequence. This +will return the number of old bytes to delete and a set of new bytes to +insert, and a new state value. If this returns zero you can +ignore the result (which just says to insert the character unchanged) +and handle the keystroke yourself. + +

    state must either be the return value of the last call to +fl_compose() or zero to start a new compose sequence. Be sure to reset +to zero if the user ever moves the cursor. + +

    c is the ASCII character that the user typed. + +

    del is set to the number of bytes to delete backwards. This +will always be less or equal to the ins from the last call to +fl_compose(), and will be zero if state is zero. + +

    buffer will have the first ins bytes set to the data +to insert and display (it is not nul-terminated). + +

    ins will be the number of characters to insert. + + diff --git a/documentation/preface.html b/documentation/preface.html index 63781160d..8726c158c 100644 --- a/documentation/preface.html +++ b/documentation/preface.html @@ -55,7 +55,7 @@ Reference

    Copyrights and Trademarks

    FLTK is Copyright 1998-1999 by Bill Spitzak and others. Use and distribution of FLTK is governed by the GNU Library General Public -License, located in Appendix D. +License, located in Appendix G.

    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.

    diff --git a/documentation/subclassing.html b/documentation/subclassing.html index d15f691e2..5951f0305 100644 --- a/documentation/subclassing.html +++ b/documentation/subclassing.html @@ -74,20 +74,19 @@ flags(ACTIVE|VISIBLE);

    void Fl_Widget::damage(uchar mask)
    void Fl_Widget::damage(uchar mask, int x, int y, int w, int h)
    uchar Fl_Widget::damage()

    - The first form indicates that a partial update of the object is +The first form indicates that a partial update of the object is needed. The bits in mask are OR'd into damage(). Your -draw() routine can examine these bits to limit what it is drawing. - The public method Fl_Widget::redraw() simply does -Fl_Widget::damage(FL_DAMAGE_ALL). +draw()     routine can examine these bits to limit what it is +drawing. The public method Fl_Widget::redraw() simply does + Fl_Widget::damage(FL_DAMAGE_ALL), but the implementation of +your widget can call the private damage(n).

    The second form indicates that a region is damaged. If only these calls are done in a window (no calls to damage(n)) then FLTK will clip to the union of all these calls before drawing anything. This can greatly speed up incremental displays. The mask bits are or'd into damage() unless this is a Fl_Window widget.

    The third form returns the bitwise-OR of all damage(n) - calls done since the last draw(). The public method -redraw() does damage(FL_DAMAGE_ALL), but the -implementation of your widget can call the private damage(n).

    +calls done since the last draw().

    void Fl_Widget::draw_box() const
    void Fl_Widget::draw_box(Fl_Boxtype b, ulong c) const

    The first form draws this widget's box(), using the @@ -110,7 +109,7 @@ the passed bounding box. This is designed for parent groups to draw labels with.

    void Fl_Widget::set_flag(SHORTCUT_LABEL)

    If your constructor calls this it modifies draw_label() so -that ''characters cause an underscore to be printed under the next +that '&' characters cause an underscore to be printed under the next letter.

    void Fl_Widget::set_visible()
    void Fl_Widget::clear_visible()

    @@ -121,10 +120,10 @@ FL_SHOW events to the widget.
    static int Fl_Widget::test_shortcut(const char *s) The first version tests Fl_Widget::label() against the current event (which should be a FL_SHORTCUT event). If the -label contains a ''character and the character after it matches the key +label contains a '&' character and the character after it matches the key press, this returns true. This returns false if the SHORTCUT_LABEL - flag is off, if the label is NULL or does not have a -''character in it, or if the keypress does not match the character. +flag is off, if the label is NULL or does not have a +'&' character in it, or if the keypress does not match the character.

    The second version lets you do this test against an arbitrary string.

    uchar Fl_Widget::type() const @@ -140,11 +139,10 @@ standard everywhere.

    If you don't have RTTI you can use the clumsy FLTK mechanisim, by having type() have a unique value. These unique values must be greater than the symbol FL_RESERVED_TYPE (which is 100). - Look through the header files for FL_RESERVED_TYPE to find an -unused number. If you make a subclass of Fl_Group you must -use FL_GROUP + n, and if you make a subclass of Fl_Window -you must use FL_WINDOW + n (in both cases n is in the -range 1 to 7).

    +Look through the header files for FL_RESERVED_TYPE to find an +unused number. If you make a subclass of Fl_Window +you must use FL_WINDOW + n (n must be in the +range 1 to 7).

    Handling Events

    The virtual method int Fl_Widget::handle(int event) is called to handle each event passed to the widget. It can: @@ -216,8 +214,8 @@ be called from non-drawing code.

    damage() contains the bitwise-OR of all the damage(n) calls to this widget since it was last drawn. This can be used for minimal update, by only redrawing the parts whose bits are set. FLTK -will turn all the bits on if it thinks the entire widget must be -redrawn (for instance due to an expose event).

    +will turn on the FL_DAMAGE_ALL bit if it thinks the entire widget +must be redrawn (for instance due to an expose event).

    Expose events (and the above damage(b,x,y,w,h)) will cause draw() to be called with FLTK's clipping turned on. You can greatly speed up redrawing in some @@ -285,8 +283,8 @@ void MyClass::slider_cb() { // normal method If you make the handle() method, you can quickly pass all the events to the children using the Fl_Group::handle() method. -Note that you don't need to override handle() if your -composite widget does nothing other than pass events to the children: +You don't need to override handle() if your composite widget +does nothing other than pass events to the children: