PhABResExportFull_t.create_window()

A function exported by PhAB to create a resource editor window

Synopsis:

PhabResWindowHandle_t create_window (
  PhArea_t *area,
  char *caption,
  unsigned int flags,
  PtWidget_t **container,
  ResPluginActionNotifyF_t *notify,
  void *notify_data )

Arguments:

area

The area of the window, represented by a PhArea_t.

caption

The window's caption string, related to the resource being currently edited.

flags

Additional information about how the window should look. Set to RESPLUGIN_FIXED_SIZE to make the resulting window non-resizeable.

container

Filled by the create_window() function with a pointer to a container widget. You should use this widget pointer as the parent for whatever widgets are needed to render the full resource editor.

notify

A pointer to a callback that notifies the resource editor of changes to the window. This callback has the following synopsis:

typedef void ResPluginActionNotifyF_t ( ResPluginAction_t action, void *notify_data );

Action is returned as one of:

• RESPLUGIN_ACTION_DEFAULT -- the resource editor user has requested the default action.
• RESPLUGIN_ACTION_CLOSE -- the resource editor user has requested to close the plugin's window.
• RESPLUGIN_ACTION_APPLY -- the resource editor user has requested the apply action.

notify_data

A pointer to data that you want to pass as the second argument to the notify function.

Description:

This function is exported from PhAB in the PhABResExportFull_t structure.

This convenience function should be called from within the full editor's create function to create a typical resource editor window. The function creates the window with all the necessary callbacks already attached and will notify the plugin about various actions using the notify function and notify_data.

Returns:

A PhabResWindowHandle_t which has to be used in the related windowing functions

success

NULL

error

Classification:

Photon

See also:

destroy(), get_area(), get_res(), PhABResExportFull_t, set_state(), to_front().