C4 Engine
C4 Engine API Documentation

Widget::SetBalloon

Defined in:  C4Widgets.h
Sets the balloon type and string for a widget.
Prototype

void SetBalloon(BalloonType type, const char *string = "");

Parameters
type The balloon type. See below for possible values.
string The balloon string. The default empty string should only be used if the type parameter is kBalloonNone.
Description
The SetBalloon function sets the balloon type and string for a widget. The balloon type specified by the type parameter can be one of the following constants.
kBalloonNone The widget does not have a balloon.
kBalloonText The balloon string contains the text to be displayed.
kBalloonResource The balloon string contains the name of the panel resource to be loaded.
If a widget has a balloon, then it is displayed after the cursor has hovered over the widget for a short period of time. Balloons are not displayed for widgets that are disabled.

The meaning of the balloon string specified by the string parameter depends on the balloon type. If the balloon type is kBalloonText, then the balloon string itself is shown in the balloon. If the balloon type is kBalloonResource, then the balloon string names a panel resource that is loaded and displayed inside the balloon.
See Also

Widget::GetBalloonType

Widget::GetBalloonString