PtUpDown

Vertical or horizontal increment/decrement buttons

Class hierarchy:

PtWidget --> PtBasic --> PtContainer --> PtUpDown

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

PhAB icon:

Public header:

<photon/PtUpDown.h>

Description:

The PtUpDown widget creates vertical or horizontal increment/decrement buttons. It lets you increase or decrease a value.

A PtUpDown widget.

By default, the buttons display images of arrows, but you can use other images if necessary. You can also specify the armed data, the image displayed when the user presses one of the buttons.

The Pt_CB_ACTIVATE,Pt_CB_ARM, Pt_CB_DISARM, and Pt_CB_REPEAT callbacks for the buttons have a subtype that indicates which button was pressed.

New resources:

Pt_ARG_UPDOWN_ARM_DATA_BOTTOM, Pt_ARG_UPDOWN_ARM_DATA_LEFT, Pt_ARG_UPDOWN_ARM_DATA_RIGHT, Pt_ARG_UPDOWN_ARM_DATA_TOP

An image (of type PhImage_t - see the Photon Library Reference) to display for the buttons when they're pressed in.

Set the flags member of the PhImage_t structure to: Ph_RELEASE_IMAGE | Ph_RELEASE_PALETTE | Ph_RELEASE_TRANSPARENCY_MASK | Ph_RELEASE_GHOST_BITMAP before providing the image to the widget. If you do this, the memory used for the image is released when the widget is unrealized or destroyed.

Pt_ARG_UPDOWN_BOTTOM_BORDER_COLOR

The color of the outermost bottom and right borders.

Pt_ARG_UPDOWN_DATA_BOTTOM, Pt_ARG_UPDOWN_DATA_LEFT, Pt_ARG_UPDOWN_DATA_RIGHT, Pt_ARG_UPDOWN_DATA_TOP

Images (of type PhImage_t - see the Photon Library Reference) to display for the buttons. The default images are arrows.

Set the image's flags as described for Pt_ARG_UPDOWN_ARM_DATA_BOTTOM.

Pt_ARG_UPDOWN_FILL_COLOR

The background color.

Pt_ARG_UPDOWN_FLAGS

These flags specify the appearance of the outermost borders:

Pt_HIGHLIGHTED

Highlight the widget with a beveled or etched rectangle. The appearance of the rectangle depends on the Pt_ARG_BORDER_WIDTH, Pt_ARG_TOP_BORDER_COLOR, and Pt_ARG_BOT_BORDER_COLOR resources.

Pt_ETCH_HIGHLIGHT

Highlight the widget with an etched-line style (normally, a beveled rectangle is used).

Pt_CLIP_HIGHLIGHT

Clip the corners of the rectangle that highlights the widget.

Pt_BLOCKED

Prevent the widget and all its non-window-class children from interacting with Photon events.

Pt_MENUABLE

Make the widget respond to right-mouse-button clicks (i.e. enable PtBasic's Pt_CB_MENU callback.

Pt_GETS_FOCUS

Allow the widget to be granted focus when appropriate.

Use the Pt_ARG_FLAGS resource to change the appearance of the inner borders. Only the following flags are supported for this widget: Pt_HIGHLIGHTED Pt_ETCH_HIGHLIGHT Pt_CLIP_HIGHLIGHT

Pt_ARG_UPDOWN_HIGHLIGHT_ROUND

The roundness of the outermost borders.

Pt_ARG_UPDOWN_MARGIN_HEIGHT

The amount of vertical space between the outermost border and the inner images.

Pt_ARG_UPDOWN_MARGIN_WIDTH

The amount of horizontal space between the outermost border and the inner images.

Pt_ARG_UPDOWN_ORIENTATION

The direction the arrows are pointing:

• Pt_VERTICAL
• Pt_HORIZONTAL

Pt_ARG_UPDOWN_SPACING

The distance, in pixels, between the buttons.

Pt_ARG_UPDOWN_TOP_BORDER_COLOR

The color of the outermost top and left borders.

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_ARG_FLAGS

Only the following flags are supported for this widget:

• Pt_HIGHLIGHTED
• Pt_ETCH_HIGHLIGHT
• Pt_CLIP_HIGHLIGHT

Pt_CB_ACTIVATE
Pt_CB_ARM
Pt_CB_DISARM
Pt_CB_REPEAT

These callbacks are passed a PtCallbackInfo_t structure that contains at least the following members:

    ulong_t reason;
    ulong_t reason_subtype;
    PhEvent_t *event;
    void *cbdata;
    

The callbacks are similar to those for PtButton, except the reason_subtype indicates which button was pressed:

• UPDOWN_TOP
• UPDOWN_BOTTOM
• UPDOWN_LEFT
• UPDOWN_RIGHT