ResPluginGetAreaF_t

A function you must write to retrieve the area occupied by the full resource editor window

Synopsis:

typedef void ResPluginGetAreaF_t (
  ResPluginHandle_t handle,
  PhArea_t *area )

Description:

This function is exported in the ResPluginFullEditor_t structure

This function is called by PhAB to find out the current area of the full resource editor. The plugin should fill in the area pointer with the editor's current area.

Arguments:

handle

The ResPluginHandle_t handle returned when the instance of the editor is created with ResPluginFullCreateF_t.

area

A pointer to a PhArea_t structure you fill in to define the current area of the resource editor.

Examples:

This sample ResPluginGetAreaF_t function for a full editor is from the complete plugin example at the end of this chapter.

static void plugin_full_get_area( ResPluginHandle_t handle, PhArea_t *area )
{
  PluginFullInstance_t *instance = ( PluginFullInstance_t * ) handle;
  instance->exp->get_area( instance->convenience_handle, area );
}

Classification:

QNX Neutrino

See also:

ResPluginFullCreateF_t, ResPluginFullEditor_t, PhArea_t.