PtRegion

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

# `PtRegion`

`PtRegion` -- A means to access and control regions of the interface.

## Synopsis

    class PtRegion PtContainer
    {
        region_fields;         // flag  (Pt_ARG_REGION_FIELDS)
        region_flags;          // flag  (Pt_ARG_REGION_FLAGS)
        region_handle;         // unsigned long  (Pt_ARG_REGION_HANDLE)
        region_infront;        // region ID  (Pt_ARG_REGION_INFRONT)
        region_input_group;    // unsigned short  (Pt_ARG_REGION_INPUT_GROUP)
        region_opaque;         // flag  (Pt_ARG_REGION_OPAQUE)
        region_owner;          // long  (Pt_ARG_REGION_OWNER)
        region_parent;         // region ID  (Pt_ARG_REGION_PARENT)
        region_sense;          // flag  (Pt_ARG_REGION_SENSE)
    }

## Base Classes

`PtWidget` <-- `PtBasic` <-- `PtContainer` <-- `PtRegion`

## Description

This is a widget representation of the `PhRegion` class, providing access and control of a region in the widget environment.

| For detailed information, please refer to PtRegion in the Photon documentation.

## Instance Variables

region_fields

  Most of these flags control access to instance variables. They must be set before any changes for that variable will take effect.

  This instance variable may be a combination of zero or more of the following flags:

  Constant | Description
  --- | ---
  Ph_REGION_BEHIND | Specifies the region behind this region when it is opened. 0 puts this region behind all brothers.
  Ph_REGION_DATA | Reserved for future implementation.
  Ph_REGION_EV_OPAQUE | Enables the `region_opaque` variable.
  Ph_REGION_EV_SENSE | Enables the `region_sense` variable.
  Ph_REGION_FLAGS | Enables the `region_flags` variable.
  Ph_REGION_HANDLE | Enables the `region_handle` variable.
  Ph_REGION_IN_FRONT | Enables the `region_in_front` variable.
  Ph_REGION_INPUT_GROUP | Enables the `region_input_group` variable.
  Ph_REGION_ORIGIN | Registers the region's origin point data.
  Ph_REGION_OWNER | Enables the `region_owner` variable.
  Ph_REGION_PARENT | Enables the `region_parent` variable.
  Ph_REGION_RECT | Registers the region's dimension and position data.
  Ph_REGION_STATE | Is read only--not to be modified.

region_flags

  This instance variable specifies region characteristics, and may be a combination of zero or more of the following flags:

  Constant | Description
  --- | ---
  Ph_WINDOW_REGION | Defines the region as a window.
  Ph_WND_MGR_REGION | Defines the region as a window manager.
  Ph_GRAFX_REGION | Defines the region as a graphics region.
  Ph_PTR_REGION | Defines the region as a pointer region.
  Ph_KBD_REGION | Defines the region as a keyboard.
  Ph_PRINT_REGION | Defines the region as a print region.
  Ph_INPUTGROUP_REGION | Defines the region as a input group.
  Ph_AUXPTR_REGION | Defines the region as a auxiliary pointer region.
  Ph_FORCE_FRONT | Forces the region to the front.
  Ph_FOLLOW_IG_SIZE | Makes the region follow the input group size.
  Ph_FORCE_BOUNDARY | Forces a boundary on the region.
  Ph_NO_COMPRESSION | Prevents compression of the region.
  Ph_CURSOR_SET | Cursor Set

region_handle

  A widget pointer that specifies the widget associated with the region. Set to 0 or leave the default. This variable's corresponding flag must be set in the `region_fields` variable.

region_infront

  A region ID number that specifies the region in front of this region when it is opened. 0 puts this region in front of all brothers. This variable's corresponding flag must be set in the `region_fields` variable.

region_input_group

  A number that specifies the region's input group. This variable's corresponding flag must be set in the `region_fields` variable.

region_opaque

  Flags that specify any events that the region is opaque to. This variable's corresponding flag must be set in the `region_fields` variable.

region_owner

  A number that specifies the owner of the region. This variable's corresponding flag must be set in the `region_fields` variable.

region_parent

  A region ID number that specifies the parent region for this region. This variable's corresponding flag must be set in the `region_fields` variable.

region_sense

  Flags that specify events the region is sensitive to. This variable's corresponding flag must be set in the `region_fields` variable.

Prev | Home | Next
`PtRect` | Up | `PtScale`

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