Museum

 XmWidgetGetBaselines(Xm)       6 January 1993       XmWidgetGetBaselines(Xm)


 Name

    XmWidgetGetBaselines - retrieves baseline information for a widget

 Syntax


    #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 mem-
    ory 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

    linecount
            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.

 See also

    XmWidgetGetDisplayRect(Xm)