Legend Class

Legend Object Class

Overview

A Chart Object creates a Legend object when Chart resource XmNshowLegend is set to True. The following section describes the resources of the Legend object that you can use to customize its appearance. The labels used to annotate the legend correspond to the name of each series data object.

Inherited Behavior and Resources

The Legend object class inherits behavior and resources from the Xt Object and Graphic object classes.

The class pointer is xintLegendObjectClass.
The class name is XintLegend.
The header file is included as <Xint/Legend.h>.

The following resources are defined by the Legend object class:
Name Type Default Access
XmNiconWidth int 15 CSG
XmNcolumns int 1 CSG
XmNlegendLocation XintLocation * NULL CSG
XmNlegendTitle String NULL CSG
XmNlineStyle int XintLINE_NONE CSG
XmNmarginHeight int 8 CSG
XmNmarginWidth int 8 CSG
XmNvisibleEntryCount int 0 CSG

The following resources are defined by the Legend object class:
Name	Type	Default	Access
XmNiconWidth	int	15	CSG
XmNcolumns	int	1	CSG
XmNlegendLocation	XintLocation *	NULL	CSG
XmNlegendTitle	String	NULL	CSG
XmNlineStyle	int	XintLINE_NONE	CSG
XmNmarginHeight	int	8	CSG
XmNmarginWidth	int	8	CSG
XmNvisibleEntryCount	int	0	CSG

   typedef struct {
                   float x;
                   float y;
   } XintLocation;

member Description
x, y Specify the location of the center of the legend in the chart coordinate system (0 to 100 in both X and Y directions).

member	Description
x, y	Specify the location of the center of the legend in the chart coordinate system (0 to 100 in both X and Y directions).

XmNlineStyle

Controls the line style for the rectangle that is drawn around the legend. The line color and line thickness are controlled by the Graphic resources XmNcolor and XmNlineThickness. You can specify one of the following constants for XmNlineStyle:

Resource Value Description
XintLINE_NONE (default) No rectangle is drawn.
XintLINE_SOLID The rectangle is drawn with a solid line.
XintLINE_ON_OFF_DASH The rectangle is drawn with an on-off dash pattern.
XintLINE_DOUBLE_DASH The rectangle is drawn with a double dash pattern.
XintSHADOW_IN Shadow is drawn so that legend appears inset.
XintSHADOW_OUT Shadow is drawn so that legend appears outset.

Resource Value	Description
XintLINE_NONE (default)	No rectangle is drawn.
XintLINE_SOLID	The rectangle is drawn with a solid line.
XintLINE_ON_OFF_DASH	The rectangle is drawn with an on-off dash pattern.
XintLINE_DOUBLE_DASH	The rectangle is drawn with a double dash pattern.
XintSHADOW_IN	Shadow is drawn so that legend appears inset.
XintSHADOW_OUT	Shadow is drawn so that legend appears outset.

Graphic Class Inherited Resources

Legend inherits behavior and resources from the Graphic class. The set of resources that can be accessed along with the proper defaults is listed below.

Graphic Class
Name Type Default Access
XmNcolor Pixel foreground CSG
XmNdashList char * NULL CSG
XmNfillColor Pixel background CSG
XmNfillFilename char * NULL CSG
XmNfillPixmap Pixmap NULL CSG
XmNfillStyle int XintFILL_NONE CSG
XmNfont char * "*Helvetica*-120-*" CSG
XmNhighlightMode int XintHIGHLIGHT_HANDLE CSG
XmNlineStyle int XintLINE_SOLID CSG
XmNlineThickness int 1 CSG
XmNmove Boolean True CSG
XmNsensitive Boolean True CSG
XmNshape Boolean True CSG
XmNstippleColor Pixel foreground CSG

**Graphic Class**
Name	Type	Default	Access
XmNcolor	Pixel	foreground	CSG
XmNdashList	char *	NULL	CSG
XmNfillColor	Pixel	background	CSG
XmNfillFilename	char *	NULL	CSG
XmNfillPixmap	Pixmap	NULL	CSG
XmNfillStyle	int	XintFILL_NONE	CSG
XmNfont	char *	"Helvetica-120-*"	CSG
XmNhighlightMode	int	XintHIGHLIGHT_HANDLE	CSG
XmNlineStyle	int	XintLINE_SOLID	CSG
XmNlineThickness	int	1	CSG
XmNmove	Boolean	True	CSG
XmNsensitive	Boolean	True	CSG
XmNshape	Boolean	True	CSG
XmNstippleColor	Pixel	foreground	CSG

Macro

The XintIsLegend macro returns True if the specified object is a Legend object. It returns False otherwise.

     Boolean XintIsLegend (Object object)