PhWindowOpen()

Create a window region

Synopsis:

PhRid_t PhWindowOpen(
             unsigned fields,
             const PhRegion_t *region,
             const PhRect_t *rect,
             const PhWindowInfo_t *win_info );

Arguments:

fields

A bitmap that indicates which members of the PhRegion_t structure specified by region to use. For more information, see PhRegionOpen() in the Photon Library Reference.

If you don't specify a field, PhWindowOpen() sets the corresponding member of the new region to its default value.

region

A pointer to a PhRegion_t structure that's used as a template when opening the new region. You must set the parent member of region; Photon fills in the other family members.

rect

A pointer to a PhRect_t structure (see the Photon Library Reference) that defines the rectangle associated with the region.

win_info

A pointer to a description of the window's attributes, as specified in the PhWindowInfo_t structure (see PhWm.h).

Library:

ph

Description:

This function creates a window region that will be managed by the Window Manager in the Photon event space. The Window Manager will provide a region to act as a frame in addition to the region created by the calling application.

---

Don't use this function in an application that uses widgets.

---

Returns:

The region ID of the new window's interior (not the RID of the frame).

If an error occurred, this function returns:

-1

The function couldn't communicate with Photon.

0

The region couldn't be created (e.g. the system is out of memory).

Classification:

Photon

See also:

PhWindowChange(), PhWindowClose()

PhRect_t, PhRegion_t, PhRegionChange(), PhRegionOpen() in the Photon Library Reference

See PhWm.h for a description of PhWindowInfo_t.