PtGenTreeInput

Gamma/Photon: Using Gamma™ with the Photon microGUIŽ, Version 4.0
Prev |  | Next

# `PtGenTreeInput`

`PtGenTreeInput` -- input callback information.

## Synopsis

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

## Description

This class holds information from the `Pt_CB_GEN_TREE_INPUT` callback, which is generated for any mouse or key event on a `PtGenTree`.

Also see Pt_CB_GEN_TREE_INPUT in the PtGenTree 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:

  Constant | Description
  --- | ---
  `Pt_CONTINUE` | The default, it causes an event to be handled normally.
  `Pt_END` | Causes an event to be consumed.
  `Pt_HALT` | Passes an event to the parent widget.
  Any other value | causes 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

`PtGenTree`, `PtCallbackInfo`

Prev | Home | Next
`PtFileSelBkgdCallback` | Up | `PtHotkeyCallback`

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.