PtListInput

PtListInput — text input callback information.

Synopsis

class PtListInput
{
    consumed;    // integer
    item;        // string
    index;       // unsigned short
    pos;         // PhPoint
}
		

Description

This class holds information from the Pt_CB_LIST_INPUT callback, which is generated for any mouse of key event on a PtList.

Also see Pt_CB_LIST_INPUT in the PtList section of the Photon documentation.

Instance Variables

consumed

An integer used to suppress event handling, except mouse events, which are always consumed. Possible values include:

ConstantDescription
Pt_CONTINUEThe default, it causes an event to be handled normally.
Pt_ENDCauses an event to be consumed.
Pt_HALTPasses an event to the parent widget.
Any other valuecauses the event to be consumed, and suppresses further processing.
item

A string indicating the item that the mouse is pointing to, or the future current item after the widget processes an event.

index

The item index number.

pos

A PhPoint indicating the relative position of the pointer to the item.

Associated Classes

PtList, PtListCallback, PtCallbackInfo