PtRegion

A Photon region

Class hierarchy:

PtWidget --> PtBasic --> PtContainer --> PtRegion

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

PhAB icon:

None - must be instantiated with PtCreateWidget().

Public header:

<photon/PtRegion.h>

Description:

PtRegion is ideal for controlling a region without foregoing the convenience of the Photon widget library interface. With PtRegion, you can control a region without having to modify the standard main loop function.

For more information about the data associated with a region, see PhRegion_t in the Photon Library Reference. For changes to this widget's resource to take effect, you must set the corresponding bit in Pt_ARG_REGION_FIELDS.

New resources:

Pt_ARG_REGION_DATA

Defines the data to be attached to the region. For changes to this resource to take effect, you must set the corresponding bit in Pt_ARG_REGION_FIELDS.

Pt_ARG_REGION_FIELDS

Indicates which portions of the region should be modified, including its flags, sensitivity, opacity, origin, position, etc. You must set these bits in addition to setting the corresponding resource; otherwise the setting of the resource will be ignored.

The following bits can be used to define a field in a region change (PhRegionChange()) or open (PhRegionOpen()). For more information, see <PhT.h>.

The Ph_REGION_HANDLE, Ph_REGION_ORIGIN, and Ph_REGION_RECT bits are set up automatically when the widget is initialized.

Any time you change PtRegion's Pt_ARG_POS or Pt_ARG_AREA resource, the Ph_REGION_ORIGIN bit is changed automatically.

The Ph_REGION_BEHIND bit defines which region this region will be opened in front of. The specified region becomes the brother in behind. A value of 0 makes the region the rearmost child of its parent when created.

Any time you change PtRegion's Pt_ARG_AREA or Pt_ARG_DIM resource, the Ph_REGION_RECT bit is changed automatically.

Pt_ARG_REGION_FLAGS

Defines the region type and behavior:

• Ph_WINDOW_REGION
• Ph_WND_MGR_REGION
• Ph_GRAFX_REGION
• Ph_PTR_REGION
• Ph_KBD_REGION
• Ph_PRINT_REGION
• Ph_INPUTGROUP_REGION
• Ph_AUXPTR_REGION
• Ph_FORCE_FRONT
• Ph_FOLLOW_IG_SIZE
• Ph_FORCE_BOUNDARY
• Ph_NO_COMPRESSION
• Ph_CURSOR_SET

For changes to this resource to take effect, you must set the corresponding bit in Pt_ARG_REGION_FIELDS.

Pt_ARG_REGION_HANDLE

A widget pointer normally used by the widget library to determine which widget is associated with a region. This resource should either be set to 0 or left at its default. For changes to this resource to take effect, you must set the corresponding bit in Pt_ARG_REGION_FIELDS.

Pt_ARG_REGION_INFRONT

Defines which region (rid) this region will be opened behind. The specified region becomes the brother in front. A value of 0 makes the region the frontmost child of its parent when created. For changes to this resource to take effect, you must set the corresponding bit in Pt_ARG_REGION_FIELDS.

Pt_ARG_REGION_INPUT_GROUP

Associates the region with the specified input group. For changes to this resource to take effect, you must set the corresponding bit in Pt_ARG_REGION_FIELDS.

Pt_ARG_REGION_OPAQUE

Define which events this region is opaque to. For changes to this resources to take effect, you must set the corresponding bit(s) in Pt_ARG_REGION_FIELDS.

Pt_ARG_REGION_OWNER

Specifies the owner of the region. For changes to this resource to take effect, you must set the corresponding bit in Pt_ARG_REGION_FIELDS.

Pt_ARG_REGION_PARENT

Specifies the ID (rid) of the region that will be this region's parent. For changes to this resource to take effect, you must set the corresponding bit in Pt_ARG_REGION_FIELDS.

Pt_ARG_REGION_SENSE

Define which events this region is sensitive to. For changes to this resources to take effect, you must set the corresponding bit(s) in Pt_ARG_REGION_FIELDS.

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.