Developer

API Reference

IWIDGET_SetTitle()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
Description
Sets the title text to be displayed by the title widget. The caller may specify whether the memory containing the title text is to be owned and freed by the title widget.
This method is deprecated due the use of the currently mod1 incompatible IWIDGET_SetText. For more information, please see that method. Although no replacement is currently provided, in future releases a mod1 compatible function under the name IWidget_SetTitle will be available.
Parameters
  • piw
    []:
    Pointer to the IWidget object.
  • pwText
    []:
    Pointer to the text that is to be displayed in the widget. This pointer will be stored in the value model.
  • bFree
    []:
    Indicates whether or not the value model of the title widget should free the memory of the text that is being set. When TRUE, the value model will free the memory pointed to by 'pwText' when the model is released. When FALSE, the model will leave memory management to the calling application.
Interface
IWIDGET
Prototype
   int IWidget_SetTitle(IWidget *piw, const AECHAR *pwText, boolean bFree);
   
Return
   
   AEE_SUCCESS - If the title widget is able to successfully set the text.
   AEE_EFAILED - If the text could not be set.


Side Effect
Calling IWIDGET_SetTitle() will change the value model and trigger a notify of any attached model listeners.
Comment
None
  • Follow