ResPluginBlockF_t

A function you must write to temporarily block input

Synopsis:

typedef void ResPluginBlockF_t (
  ResPluginHandle_t handle,
  int block )

Description:

This function is exported in the ResPluginFullEditor_t structure.

This function is called by PhAB to indicate that the plugin should temporary block input to the resource editor (when the block parameter is not 0) or that the plugin should restore the input to the full resource editor (when the block parameter is 0).

When PhAB requests that the resource editor be blocked, you should set the Pt_BLOCKED flag on the window that contains the editor. If the PhAB exported create_window() function was used to create the editor's window, then the PhAB exported set_state() function should be used with an argument equal to RESPLUGIN_STATE_BLOCKED to block the editor's window or with an argument equal to RES_PLUGIN_STATE_UNBLOCKED to unblock it.

Arguments:

handle

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

block

Indicates whether the plugin should block or unblock input. It can be:

• 0 — unblock input
• not 0 — block input

Examples:

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

static void plugin_full_block( ResPluginHandle_t handle, int block )
{
  PluginFullInstance_t *instance = ( PluginFullInstance_t * ) handle;
  instance->exp->set_state( instance->convenience_handle,
                                  block ?
                                  RESPLUGIN_STATE_BLOCKED :
                                  RESPLUGIN_STATE_UNBLOCKED );
}

Classification:

QNX Neutrino

See also:

create_window(), ResPluginFrugalCreateF_t, ResPluginFullEditor_t, ResPluginFullCreateF_t, set_state().