Sanko Robinson

NAME

Fl::ValueInput - Displays a Numeric Value

Description

The Fl::ValueInput widget displays a floating point value.

The user can click in the text field and edit it - there is in fact a hidden Fl::Input widget with type(FL_FLOAT_INPUT) or type(FL_INT_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 non-zero and integral, then the range of numbers is limited to integers instead of floating point numbers. As well as displaying the value as an integer, typed input is also limited to integer values, even if the hidden Fl::Input widget is of type(FL_FLOAT_INPUT).

If step() is non-zero, the user can also drag the mouse across the object and thus slide the value. The left button moves one step() per pixel, the middle by 10 * step(), and the right button by 100 * step(). It is therefore impossible to select text by dragging across it, although clicking can still move the insertion cursor.

If step() is non-zero and integral, then the range of numbers are limited to integers instead of floating point values.

Methods

Fl::ValueInput inherits from Fl::Valuator and Fl::Widget. On top of that, it exposes the following methods...

new(...)

    my $val_a = Fl::ValueInput->new(0, 0, 250, 500, 'Important Stuff');
    my $val_b = Fl::ValueInput->new(0, 0, 250, 500);

The constructor creates a new widget using the given position, size, and label.

The default boxtype is FL_DOWN_BOX.

The destructor removes the widget.

cursor_color(...)

    my $color = $val_a->cursor_color();
    $val_b->cursor_color(Fl::FL_RED);

Gets or sets the color of the text cursor.

The text cursor is black by default.

shortcut(...)

    my $scut = $val_a->shortcut();
    $val_b->soft( Fl::FL_ALT | 'a' );

Sets or gets the current shortcut key.

Setting this overrides the use of '&' in the label(). The value is a bitwise OR of a key and a set of shift flags, for example FL_ALT | 'a' , FL_ALT | (FL_F + 10), or just 'a'. A value of 0 disables the shortcut.

The key can be any value returned by Fl::event_key(), but will usually be an ASCII letter. Use a lower-case letter unless you require the shift key to be held down.

The shift flags can be any set of values accepted by Fl::event_state(). If the bit is on that shift key must be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in the shift flags (zero for the other bits indicates a "don't care" setting).

soft(...)

    my $soft = $val_a->soft();
    $val_b->soft( 0 );

If "soft" is turned on, the user is allowed to drag the value outside the range.

If they drag the value to one of the ends, let go, then grab again and continue to drag, they can get to any value. Default is 1 (on).

textcolor(...)

Sets or gets the color of the text in the value box.

    my $color = $val_a->textcolor();
    $val_b->textcolor(Fl::FL_RED);

textfont(...)

Sets or gets the typeface of the text in the value box.

    my $font = $val_a->textfont();
    $val_b->textfont(Fl::FL_HELVETICA);

textsize( )

Gets the size of the text in the value box.

    my $size = $val_a->textsize();

LICENSE

Copyright (C) Sanko Robinson.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Sanko Robinson <sanko@cpan.org>