PtEnableSurface(), PtEnableSurfaceById()

Enable a control surface

Synopsis:

void PtEnableSurface( PtWidget_t *widget,
                      PtSurface_t *surface,
                      ulong_t flags );

void PtEnableSurfaceById( PtWidget_t *widget,
                          uchar_t surface_id,
                          ulong_t flags );

Library:

ph

Description:

These functions enable a control surface, restoring it from a disabled state. The widget argument specifies the widget owning the surface. The functions differ in the way they identify the control surface:

PtEnableSurface()

Uses the surface argument, which points to a PtSurface_t structure that describes the control surface. This pointer must not be NULL.

PtEnableSurfaceById()

Searches the control surfaces belonging to the widget for the one with an ID of surface_id.

The flags argument specifies additional action to take, and may include the following values:

Pt_DAMAGE_SURFACE

Damage the surface if its state changes. This is useful if a surface draws differently depending on its enabled/disabled state.

Classification:

Photon

See also:

PtDisableSurface(), PtDisableSurfaceByAction(), PtDisableSurfaceById(), PtEnableSurfaceByAction(), PtSurfaceIsDisabled(), PtSurfaceIsEnabled()

Control Surfaces chapter of the Photon Programmer's Guide