[Contents] [Index] [Next] [Previous]

XmWidgetGetBaselines


NAME

XmWidgetGetBaselines - Retrieves baseline information for a widget

SYNOPSIS

#include <Xm/Xm.h>
Boolean XmWidgetGetBaselines (widget, baselines, line_count)
      Widget     widget;
      Dimension  **baselines;
      int        *line_count;

DESCRIPTION

XmWidgetGetBaselines returns an array that contains one or more baseline values associated with the specified widget. The baseline of any given line of text is a vertical offset in pixels from the origin of the widget's bounding box to the given baseline. This routine allocates memory for the returned data. The application must free this memory using XtFree.

widget
Specifies the ID of the widget for which baseline values are requested
baselines
Returns an array that contains the value of each baseline of text in the widget
line_count
Returns the number of lines in the widget

RETURN VALUE

Returns a Boolean value that indicates whether the widget contains a baseline. If True, the function returns a value for each baseline of text. If False, the function was unable to return a baseline value.

RELATED INFORMATION

XmWidgetGetDisplayRect(3X).