PtNumericFloat

Floating-point numeric widget

Class hierarchy:

PtWidget --> PtBasic --> PtContainer --> PtCompound --> PtNumeric --> PtNumericFloat

For more information, see the diagram of the widget hierarchy.

PhAB icon:

Public header:

<photon/PtNumericFloat.h>

Description:

The PtNumericFloat class is a numeric widget that allows you to enter floating-point values between given minimum and maximum values.

A PtNumericFloat widget.

A PtUpDown widget is also shown to let you increase or decrease the value by a set amount. The widget allows a prefix and a suffix string to be optionally added along with the ability to use comma separators and set the precision of the number (i.e. the number of decimal places, for example, 1,000.00).

New resources:

Pt_ARG_NUMERIC_INCREMENT

The value by which to increase or decrease the value when the up/down buttons are pressed.

Pt_ARG_NUMERIC_MAX

The maximum value for the widget.

Pt_ARG_NUMERIC_MIN

The minimum value for the widget.

Pt_ARG_NUMERIC_PRECISION

The precision or number of displayed decimal places of the widget's current value.

Pt_ARG_NUMERIC_VALUE

The current value of the widget.

Pt_CB_NUMERIC_CHANGED

A list of callbacks invoked when the widget's value changes. Each callback is passed a PtCallbackInfo_t structure that contains at least the following members:

reason

The name of the callback resource (Pt_CB_NUMERIC_CHANGED) that caused this callback to be invoked.

reason_subtype

A subtype that indicates why the callback was invoked:

• Pt_NUMERIC_CHANGED - the text in the numeric's text field has been changed
• Pt_NUMERIC_UPDOWN_ACTIVATE - a button was pressed to change the current value
• Pt_NUMERIC_UPDOWN_REPEAT - a button was held down to change the current value

cbdata

A pointer to a PtNumericFloatCallback_t structure that contains at least:

• double numeric_value - the current value of the widget

These callbacks should return Pt_CONTINUE.

Exported subordinate children:

Unless the resources are already defined in PtNumericFloat, the PtNumericFloat class uses the resources of its exported subordinate child, PtUpDown.

The PtNumericFloat class "inherits" all the resources of its exported subordinate child. Where PtNumericFloat and its exported subordinate child both define resources having the same name, the resource defined in PtNumericFloat takes precedence.

Inherited resources:

If the widget modifies an inherited resource, the "Default override" column indicates the new value. This modification affects any subclasses of the widget.

Pt_CB_ACTIVATE

If cbinfo->reason_subtype is Pt_NUMERIC_ACTIVATE, the callback was invoked because the user changed the value and pressed Enter while in PtNumericFloat's text field.