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.

[Note]

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:

ConstantDescription
Ph_CURSOR_NO_INHERITDo not inherit the parent's cursor.
Ph_CURSOR_MANUAL_CONTROLNot implemented.
Ph_CURSOR_NONEDo not show a cursor.
Ph_CURSOR_BITMAPNot implemented.
Ph_CURSOR_INHERITInherit the parent's cursor.
Ph_CURSOR_POINTERPointer
Ph_CURSOR_BIG_POINTERBig Pointer
Ph_CURSOR_MOVEMove
Ph_CURSOR_CROSSHAIRCrosshair
Ph_CURSOR_CLOCKClock
Ph_CURSOR_WAITWait
Ph_CURSOR_NOINPUTNo Input
Ph_CURSOR_DONTDon't
Ph_CURSOR_FINGERFinger
Ph_CURSOR_INSERTInsert
Ph_CURSOR_DRAG_VERTICALDrag Vertical
Ph_CURSOR_DRAG_TOPDrag Top
Ph_CURSOR_DRAG_BOTTOMDrag Bottom
Ph_CURSOR_DRAG_HORIZONTALDrag Horizontal
Ph_CURSOR_DRAG_LEFTDrag Left
Ph_CURSOR_DRAG_RIGHTDrag Right
Ph_CURSOR_DRAG_BACKDIAGDrag Backdiag
Ph_CURSOR_DRAG_TLDrag Top Left
Ph_CURSOR_DRAG_BRDrag Bottom Right
Ph_CURSOR_DRAG_FOREDIAGDrag Foreward Diagonal
Ph_CURSOR_DRAG_TRDrag Top Right
Ph_CURSOR_DRAG_BLDrag Bottom Left
Ph_CURSOR_POINT_WAITPoint Wait
Ph_CURSOR_LONG_WAITLong Wait
Ph_CURSOR_QUESTION_POINTQuestion Point
Ph_CURSOR_PASTEPaste

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:

ConstantDescription
Pt_HIGHLIGHTEDDraw a beveled border around the widget.
Pt_AUTOHIGHLIGHTAutomatically display/remove the highlight border as the cursor passes over the widget.
Pt_ETCH_HIGHLIGHTDraw a double bevel if Pt_HIGHLIGHTED is on.
Pt_SETMake the widget 'set'. This will invert the coloring on the bevel as well.
Pt_TOGGLEThe widget's SET flag will toggle on each mouse click instead of changing with mouse down/mouse up events.
Pt_SELECTABLEThe widget may be selected, causing Pt_CB_ARM/ACTIVATE/DISARM events.
Pt_GHOSTThe widget is displayed 'ghosted'. This does not affect its response to events.
Pt_BLOCKEDThe widget will be unresponsive to events.
Pt_REALIZEDThe widget is visible on the display.
Pt_CLIP_HIGHLIGHTThe corners of the highlight rectangle are clipped off.
Pt_OPAQUEMakes the widget opaque within its own extent and for everything behind it.
Pt_DELAY_REALIZEThe widget won't be realized except by a call to PtRealizeWidget().
Pt_GETS_FOCUSThe widget may get the keyboard focus.
Pt_MENU_BUTTONMakes the widget a menu item.
Pt_DESTROYEDMarks the widget for destruction.
Pt_DAMAGEDMarks the widget for repairs.
Pt_OBSCUREDThe widget is covered by another widget, or is outside its parent's canvas.
Pt_IN_FLUXA call to PtContainerHold has been made on the widget.
Pt_CLEARKeeps the widget's extent clear of any brothers in front of it.
Pt_DAMAGE_FAMILYThe widget and its children will be repaired.
Pt_SELECT_NOREDRAWThe widget will not redraw when it is selected.
Pt_WIDGET_REBUILDThe widget will be rebuilt once all resources have been changed.
Pt_WIDGET_RESIZEThe widget will be resized once all resources have been changed.
Pt_PROCREATEDThe widget is a procreated child of a compound widget.
Pt_ALL_BUTTONSThe widget treats events on any mouse button as a selection.
Pt_FOCUS_RENDERThe widget will attempt to indicate that it has the keyboard focus through some means.
Pt_CALLBACKS_ACTIVECallbacks for this widget will be called due to changes through code, not just due to user interactions.
Pt_MENUABLEThis widget will respond to the menu button with a Pt_CB_MENU event.
Pt_NOREDRAW_SETNoredraw Set
Pt_FREE_MEMORYFrees memory associated with widget pointers.
Pt_REGIONForce the widget to have a region ID.
Pt_REALIZINGThe 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:

ConstantDescription
Ph_WM_STATE_ISMASKInternal informational bit.
Ph_WM_STATE_ISHIDDENThe window opens normally, but is not displayed.
Ph_WM_STATE_ISMAXOpens the window to its maximum size.
Ph_WM_STATE_ISBACKDROPOpens the window as a workspace backdrop.
Ph_WM_STATE_ISTASKBARInternal informational bit.
Ph_WM_STATE_ISPDMInternal informational bit.
Ph_WM_STATE_ISICONIFIEDOpens the window and makes it an icon.
Ph_WM_STATE_ISICONInternal informational bit.
Ph_WM_STATE_ISFRONTOpens the window in front of all other applications.
Ph_WM_STATE_ISFOCUSOpens the window as the focus widget, if the WM cursor focus option is disabled.