PtHotkeyCallback

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

# `PtHotkeyCallback`

`PtHotkeyCallback` -- hotkey callback information.

## Synopsis

    class PtHotkeyCallback
    {
        data;          // string
        event_f;       // string
        flags;         // flag
        key_mods;      // unsigned long
        key_sym_cap;   // unsigned short
        widget;        // PtWidget
    }

## Description

This class holds information from the `Pt_CB_HOTKEY` callback, which is generated when a "hot key" assigned to the widget is pressed.

Also see Pt_CB_HOTKEY in the PtWidget section of the Photon documentation.

## Instance Variables

data

  User-defined data associated with the callback.

event_f

  A string identifying the assigned function to call. If no function has been assigned, the value here will be nil, and the `Pt_CB_ACTIVATE callback` is generated.

flags

  This instance variable may have one or more of the following values:

  Constant | Description
  --- | ---
  `Pt_HOTKEY_SYM` | Causes the `key_cap_sym` variable to be interpreted as a key sym, rather than a key cap.
  `Pt_HOTKEY_IGNORE_MODS` | Causes the `key_mods` variable to be ignored, allowing upper- and lowercase letters to be accepted as hot keys.

key_mods

  The active key modifiers for this keystroke.

key_sym_cap

  The key cap for this keystroke.

widget

  The `PtWidget` that attached the callback.

## Associated Classes

`PtWidget`, `PtCallbackInfo`

Prev | Home | Next
`PtGenTreeInput` | Up | `PtHtmlCallback`

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