NAME

Prima::Widget::Header - multi-column header widget

DESCRIPTION

The widget class provides functionality of several button-like caption tabs, that can be moved and resized by the user. The class was implemented to serve as a table header for list and grid widgets.

API

Events

Click INDEX

Called when the user clicks on the tab positioned at INDEX.

DrawItem CANVAS, INDEX, X1, Y1, X2, Y2, TEXT_BASELINE

A callback to draw the tabs. CANVAS is the output object; INDEX is the index of a tab. X1,Y2,X2,Y2 are the coordinates of the boundaries of the tab rectangle; TEXT_BASELINE is a pre-calculated vertical position for eventual centered text output.

MeasureItem INDEX, RESULT

Stores in scalar referenced by RESULT the width or height ( depending on the vertical property value ) of the INDEXth tab, in pixels.

MoveItem OLD_INDEX, NEW_INDEX

Called when the user moves a tab from its old location, specified by OLD_INDEX, to the NEW_INDEX position. By the time of the call, all internal structures are updated.

SizeItem INDEX, OLD_EXTENT, NEW_EXTENT

Called when the user resizes a tab in the INDEXth position. OLD_EXTENT and NEW_EXTENT are either the width or height of the tab, depending on the vertical property value.

SizeItems

Called when more than one tab changes its extent. This might happen as a result of both user and programmatic actions.

Properties

clickable BOOLEAN

Selects if the user is allowed to click the tabs.

Default value: 1

draggable BOOLEAN

Selects if the user is allowed to move the tabs.

Default value: 1

gridColor COLOR

Sets the color of the divisor lines

Default value: cl::Black

items ARRAY

An array of scalars representing the internal data of the tabs. By default, the scalars are treated as text strings.

minTabWidth INTEGER

A minimal extent in pixels a tab must occupy.

Default value: 2

offset INTEGER

An offset on the major axis ( depends on the vertical property value ) that the widget is drawn with. Used for the conjunction with list widgets ( see Prima::DetailedList ), when the list is horizontally or vertically scrolled.

Default value: 0

pressed INTEGER

Contains the index of the currently pressed tab. A -1 value is selected when no tabs are pressed.

Default value: -1

scalable BOOLEAN

Selects if the user is allowed to resize the tabs.

Default value: 1

vertical BOOLEAN

If 1, the tabs are aligned vertically; the offset, widths property, and extent parameters of the callback notification assume the heights of the tabs.

If 0, the tabs are aligned horizontally, and the extent properties and parameters assume tab widths.

widths ARRAY

Array of integer values, corresponding to the extents of the tabs. The extents are widths ( vertical is 0 ) or heights ( vertical is 1 ).

Methods

tab2offset INDEX

Returns the offset of the INDEXth tab ( without regard to the offset property value ).

tab2rect INDEX

Returns four integers representing the rectangle area occupied by the INDEXth tab ( without regard to the offset property value ).

AUTHOR

Dmitry Karasik, <dmitry@karasik.eu.org>.

SEE ALSO

Prima, Prima::Widget, Prima::DetailedList, examples/sheet.pl.