PhRegion

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

# `PhRegion`

`PhRegion` -- An area of the interface.

## Synopsis

    class PhRegion
    {
        bro_behind;       // region ID
        bro_in_front;     // region ID
        child;            // region ID
        cursor_color;     // color
        cursor_type;      // unsigned short
        data_len;         // unsigned short
        events_opaque;    // unsigned long
        events_sense;     // unsigned long
        flags;            // unsigned long
        handle;           // long
        input_group;      // unsigned short
        origin;           // PhPoint
        owner;            // short
        parent;           // region ID
        rid;              // region ID
        state;            // unsigned short
    }

## Description

This class describes a region. Regions are abstract areas of the interface that may be sensitve to various events, such as keyboard input, mouse actions, or other window events.

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

## Instance Variables

bro_behind

  A region ID specifying the brother region immediately behind this region. A value of -1 indicates no brother region is behind.

bro_in_front

  A region ID specifying the brother region immediately in front of this region. A value of -1 indicates no brother region is in front.

child

  A region ID specifying the foremost child region of this region. A value of -1 indicates there is no child region.

cursor_color

  A number specifying the color for the cursor when in this region. Default is `0` (white).

cursor_type

  This instance variable specifies the appearance of the cursor when in this region, and may have one of the following values:

  Constant | Description
  --- | ---
  Ph_CURSOR_NO_INHERIT | Do not inherit the parent's cursor.
  Ph_CURSOR_MANUAL_CONTROL | Not implemented.
  Ph_CURSOR_NONE | Do not show a cursor.
  Ph_CURSOR_BITMAP | Not implemented.
  Ph_CURSOR_INHERIT | Inherit the parent's cursor.
  Ph_CURSOR_POINTER | Pointer
  Ph_CURSOR_BIG_POINTER | Big Pointer
  Ph_CURSOR_MOVE | Move
  Ph_CURSOR_CROSSHAIR | Crosshair
  Ph_CURSOR_CLOCK | Clock
  Ph_CURSOR_WAIT | Wait
  Ph_CURSOR_NOINPUT | No Input
  Ph_CURSOR_DONT | Don't
  Ph_CURSOR_FINGER | Finger
  Ph_CURSOR_INSERT | Insert
  Ph_CURSOR_DRAG_VERTICAL | Drag Vertical
  Ph_CURSOR_DRAG_TOP | Drag Top
  Ph_CURSOR_DRAG_BOTTOM | Drag Bottom
  Ph_CURSOR_DRAG_HORIZONTAL | Drag Horizontal
  Ph_CURSOR_DRAG_LEFT | Drag Left
  Ph_CURSOR_DRAG_RIGHT | Drag Right
  Ph_CURSOR_DRAG_BACKDIAG | Drag Backdiag
  Ph_CURSOR_DRAG_TL | Drag Top Left
  Ph_CURSOR_DRAG_BR | Drag Bottom Right
  Ph_CURSOR_DRAG_FOREDIAG | Drag Foreward Diagonal
  Ph_CURSOR_DRAG_TR | Drag Top Right
  Ph_CURSOR_DRAG_BL | Drag Bottom Left
  Ph_CURSOR_POINT_WAIT | Point Wait
  Ph_CURSOR_LONG_WAIT | Long Wait
  Ph_CURSOR_QUESTION_POINT | Question Point
  Ph_CURSOR_PASTE | Paste

data_len

  An integer specifying the length of data for this region.

events_opaque

  A number specifying the events that this region is opaque to. The region will clip out and ignore any part of such an event as it passes through.

events_sense

  A number specifying the events that this region is sensitive to. The region will respond to and pass on to the application any such event that passes through.

flags

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

  Constant | Description
  --- | ---
  `Pt_HIGHLIGHTED` | Draw a beveled border around the widget.
  `Pt_AUTOHIGHLIGHT` | Automatically display/remove the highlight border as the cursor passes over the widget.
  `Pt_ETCH_HIGHLIGHT` | Draw a double bevel if `Pt_HIGHLIGHTED` is on.
  `Pt_SET` | Make the widget 'set'. This will invert the coloring on the bevel as well.
  `Pt_TOGGLE` | The widget's SET flag will toggle on each mouse click instead of changing with mouse down/mouse up events.
  `Pt_SELECTABLE` | The widget may be selected, causing `Pt_CB_ARM/ACTIVATE/DISARM` events.
  `Pt_GHOST` | The widget is displayed 'ghosted'. This does not affect its response to events.
  `Pt_BLOCKED` | The widget will be unresponsive to events.
  `Pt_REALIZED` | The widget is visible on the display.
  `Pt_CLIP_HIGHLIGHT` | The corners of the highlight rectangle are clipped off.
  `Pt_OPAQUE` | Makes the widget opaque within its own extent and for everything behind it.
  `Pt_DELAY_REALIZE` | The widget won't be realized except by a call to PtRealizeWidget().
  `Pt_GETS_FOCUS` | The widget may get the keyboard focus.
  `Pt_MENU_BUTTON` | Makes the widget a menu item.
  `Pt_DESTROYED` | Marks the widget for destruction.
  `Pt_DAMAGED` | Marks the widget for repairs.
  `Pt_OBSCURED` | The widget is covered by another widget, or is outside its parent's canvas.
  `Pt_IN_FLUX` | A call to `PtContainerHold` has been made on the widget.
  `Pt_CLEAR` | Keeps the widget's extent clear of any brothers in front of it.
  `Pt_DAMAGE_FAMILY` | The widget and its children will be repaired.
  `Pt_SELECT_NOREDRAW` | The widget will not redraw when it is selected.
  `Pt_WIDGET_REBUILD` | The widget will be rebuilt once all resources have been changed.
  `Pt_WIDGET_RESIZE` | The widget will be resized once all resources have been changed.
  `Pt_PROCREATED` | The widget is a procreated child of a compound widget.
  `Pt_ALL_BUTTONS` | The widget treats events on any mouse button as a selection.
  `Pt_FOCUS_RENDER` | The widget will attempt to indicate that it has the keyboard focus through some means.
  `Pt_CALLBACKS_ACTIVE` | Callbacks for this widget will be called due to changes through code, not just due to user interactions.
  `Pt_MENUABLE` | This widget will respond to the menu button with a `Pt_CB_MENU` event.
  `Pt_NOREDRAW_SET` | Noredraw Set
  `Pt_FREE_MEMORY` | Frees memory associated with widget pointers.
  `Pt_REGION` | Force the widget to have a region ID.
  `Pt_REALIZING` | The widget is being realized.

handle

  A user-defined number for passing small amounts of information along with events.

input_group

  A number specifying the input group. If this region is not an input group, 0.

origin

  A `PhPoint` specifying the region's origin, with respect to the origin of it's parent. This is the reference point for all other coordinates in this region.

owner

  A number indicating the owner of this region.

parent

  The region ID of the parent of this region.

rid

  The ID number of this region, which is assigned when the region is opened.

state

  This instance variable controls the state of the region, and may have one of the following values:

  Constant | Description
  --- | ---
  Ph_WM_STATE_ISMASK | Internal informational bit.
  Ph_WM_STATE_ISHIDDEN | The window opens normally, but is not displayed.
  Ph_WM_STATE_ISMAX | Opens the window to its maximum size.
  Ph_WM_STATE_ISBACKDROP | Opens the window as a workspace backdrop.
  Ph_WM_STATE_ISTASKBAR | Internal informational bit.
  Ph_WM_STATE_ISPDM | Internal informational bit.
  Ph_WM_STATE_ISICONIFIED | Opens the window and makes it an icon.
  Ph_WM_STATE_ISICON | Internal informational bit.
  Ph_WM_STATE_ISFRONT | Opens the window in front of all other applications.
  Ph_WM_STATE_ISFOCUS | Opens the window as the focus widget, if the WM cursor focus option is disabled.

Prev | Home | Next
`PhRect` | Up | `PhWindowEvent`

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