NAME

FLTK::Flags - Unified flags set for FLTK

Description

Type returned by Widget::flags() and passed to Box and many other drawing functions.

These flags control the appearance of boxes and widgets. This same value is used to:

1. store state and other information in a widget or menu item
2. provide hints to boxes, labeltypes, and images for how to draw
3. provide structural information to an array of menu items

These are shared because various parts of the code, especially drawing, want all of this information at once, and providing it as a single word is the easiest way.

The Flags

This is the complete list of flags. You may import them with the flags tag or individually.

NO_FLAGS

ALIGN_TOP

Label is centered above widget

ALIGN_BOTTOM

Label is centered below widget

ALIGN_LEFT

Label is to left of widget

ALIGN_RIGHT

Label is to right of widget

ALIGN_CENTER

The label is centered inside widget

ALIGN_INSIDE

Label is inside widget, image centered

ALIGN_CLIP

The label is clipped to the widget

ALIGN_WRAP

The label is word-wrapped

ALIGN_MASK

Used to split align() from flags()

ALIGN_POSITIONMASK

Used to split align() from flags() =item ALIGN_TOPLEFT

Label is left-justified above widget

ALIGN_BOTTOMLEFT

Label is left-justified below widget

ALIGN_TOPRIGHT

Label is right-justified above widget

ALIGN_BOTTOMRIGHT

Label is right-justified below widget

ALIGN_CENTERLEFT

Label is centered in space left of widget

ALIGN_CENTERRIGHT

Label is centered in space left of widget

ALIGN_INSIDE_TOP

Label is inside widget at top

ALIGN_INSIDE_BOTTOM

Label is inside widget at bottom

ALIGN_INSIDE_LEFT

Label is inside widget at left

ALIGN_INSIDE_TOPLEFT

Label is inside widget at top left

ALIGN_INSIDE_BOTTOMLEFT

Label is inside widget at bottom left

ALIGN_INSIDE_RIGHT

Label is inside widget at right

ALIGN_INSIDE_TOPRIGHT

Label is inside widget at top right

ALIGN_INSIDE_BOTTOMRIGHT

Label is inside widget bottom right

ALIGN_MENU

Label is inside widget bottom right

ALIGN_BROWSER

Label is inside widget bottom right

INACTIVE

!active()

OUTPUT

does not get events, draw text colors

STATE

state(), value() for buttons

SELECTED

chosen in browser/menu, draw selected colors

INVISIBLE

!visible(), draw_frame()

HIGHLIGHT

draw highlighted

CHANGED

value changed since last callback

COPIED_LABEL

copy_label() was called

RAW_LABEL

don't interpret & or @ in label

LAYOUT_VERTICAL

fltk::Pack puts this widget vertical

TAB_TO_FOCUS

Widget::tab_to_focus();

CLICK_TO_FOCUS

Widget::click_to_focus()

INACTIVE_R

draw it grayed-out

FOCUSED

draw with keyboard focus

PUSHED

draw pushed-in

RESIZE_NONE

default behavior

RESIZE_FIT

proportionnaly resize img in widget

RESIZE_FILL

resize img to fill the widget

OPENED

opened browser hierarchy parent

Author

Sanko Robinson <sanko@cpan.org> - http://sankorobinson.com/

License and Legal

This program is free software; you can redistribute it and/or modify it under the terms of The Artistic License 2.0. See the LICENSE file included with this distribution or notes on the Artistic License 2.0 for clarification.

When separated from the distribution, all original POD documentation is covered by the Creative Commons Attribution-Share Alike 3.0 License. See the clarification of the CCA-SA3.0.