Developer

API Reference

IForm_SetResTitleImage()

Brew Release
Brew MP 1.0.2
See Also
IForm Widget Events
Description
This function will set the image to be displayed in the title area of a form, identifying the image as a resource stored in a BREW resource file, and storing a pointer to this image in the form's FID_TITLEIMAGE property. The form framework will load the specified image resource and assign a pointer to this image as the title image property on the form. For example, an application that wishes to display a picture of a sleek sports car in the title area of a form could store this picture as an image resource in a particular resource file. The application could then set the title image of a form to be this image by calling IForm_SetResTitleImage(), identifying the resource file name and ID of the image to be assigned to the form's FID_TITLEIMAGE property. The form framework will comply by loading the image, assigning a pointer to this image as the form's title image property, then notifying all listening objects that the title area has changed.
Parameters
  • po
    []:
    [in] Pointer to the IForm interface object.
  • resFile
    []:
    [in] Identifies the name of the resource file that contains the resource that contains the title image.
  • resid
    []:
    [in] Identifies the resource that contains the image to be displayed in the form's title widget.
Interface
Prototype
   int IForm_SetResTitleImage(IForm *po, const char *resFile, uint16 resid); 
Return
AEE_SUCCESS : If the form is able to set the title image. Note, however, that this does NOT mean that BREW was able to successfully retrieve the image from the resource file. Applications should be certain that 'resfile' is a valid BREW resource file and that resource 'resid' actually exists. AEE_EFAILED : If the title image could not be set.
Side Effect
Calling IForm_SetResTitleImage() will send an EVT_WDG_SETPROPERTY event to the form, requesting that the FID_TITLEIMAGE property be set.
Comment
Applications should exercise care in calling IForm_SetResTitleImage(), making sure that the specified resource file and resource actually exist.
  • Follow