PtNumericInteger

Integer numeric widget

Class hierarchy:

PtWidget → PtBasic → PtContainer → PtCompound → PtNumeric → PtNumericInteger

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

PhAB icon:

Public header:

<photon/PtNumericInteger.h>

Description:

The PtNumericInteger class lets you specify integer values between given minimum and maximum values.

A PtNumericInteger widget.

A PtScrollbar widget is included to let you increase or decrease the value by a set amount. You can use the resources defined by PtNumeric to add prefix and suffix strings, and use comma separators (e.g. 1,000).

If you want the value to be displayed as a hexadecimal value, set Pt_NUMERIC_HEXADECIMAL in Pt_ARG_NUMERIC_FLAGS.

New resources:

Pt_ARG_NUMERIC_INCREMENT

The amount 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_VALUE

The current value of the widget.

Pt_CB_NUMERIC_CHANGED

A list of PtCallback_t structures that define the callbacks invoked when the widget's value changes.

If the widget has the Pt_CALLBACKS_ACTIVE bit set in its Pt_ARG_FLAGS resource, these callbacks are also invoked when your application changes the Pt_ARG_NUMERIC_VALUE with a call to PtSetResource() or PtSetResources(), or if the Pt_ARG_NUMERIC_VALUE is changed indirectly by a change to Pt_ARG_NUMERIC_MIN or Pt_ARG_NUMERIC_MAX.

Each callback is passed a PtCallbackInfo_t structure that contains at least the following members:

reason

Pt_CB_NUMERIC_CHANGED

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_SET — PtSetResource() or PtSetResources() was called to change the current value.
• 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.

event

A pointer to a PhEvent_t structure that describes the event that caused the callback to be invoked, or NULL if there isn't an event.

cbdata

A pointer to a PtNumericIntegerCallback_t structure that contains at least:

• int numeric_value — the current value of the widget.

These callbacks should return Pt_CONTINUE.

Exported subordinate children:

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

The PtNumericInteger class “inherits” all the resources of its exported subordinate child. Where PtNumericInteger and its exported subordinate child both define resources having the same name, the resource defined in PtNumericInteger 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 you changed the value and pressed Enter while in PtNumericInteger's text field.