Grid Widget Class

Overview

The Grid widget class allows the user to define a two dimensional world coordinate system and to draw the corresponding grid. A rich set of resources is available for customizing the appearance of the grid lines, the grid frame and the annotation. Axes of the Grid widget can be linear or logarithmic. Grid lines can be displayed as solid lines, dashed lines or 3D lines. The type, thickness and color of the grid lines can be set independently for vertical and horizontal grid lines for both major and minor annotation. The font, format and orientation of the annotation text can also be customized for both the horizontal and vertical directions. The Grid widget class inherits all of the resources and functions defined by its superclasses CompBase and EditObject. Therefore, Graphic object editing, zooming, and hardcopy output is supported for the Grid class.

Inherited Behavior and Resources

The Grid widget inherits behavior and resources from the Core, Composite, Constraint, Motif Manager, INT CompBase and EditObject classes.

The class pointer is xintGridWidgetClass.
The class name is XintGrid.
The header file is included as <Xint/Grid.h>.

The following resources are defined by the Grid widget class:
Name	Type	Default	Access
XmNautoMarginAdjust	int	XintADJUST_NONE	CSG
XmNbottomAnnotationAngle	int	0	CSG
XmNbottomMargin	int	40	CSG
XmNcolor	Pixel	black	CSG
XmNexposeCallback	XtCallbackList	NULL	C
XmNframe	int	XintFRAME	CSG
XmNframeStyle	int	XintFRAME_SOLID	CSG
XmNframeThickness	int	2	CSG
XmNgridBelow	Boolean	True	CSG
XmNhorizontalAnnotationForeground	Pixel	black	CSG
XmNhorizontalAnnotationFormat	char *	"%g"	CSG
XmNhorizontalAnnotationPlacement	int	XintPLACEMENT_TOP_ BOTTOM	CSG
XmNhorizontalAnnotationPosition	float *	NULL	CSG
XmNhorizontalAxisType	int	XintAXIS_LINEAR	CSG
XmNhorizontalDirection	int	XintSTART_TO_END	CSG
XmNhorizontalEnd	float *	100.0	CSG
XmNhorizontalLabel	char *	NULL	CSG
XmNhorizontalLabelAlignment	int	XintALIGNMENT_CENTER	CSG
XmNhorizontalLabelFont	char *	"courierbold-r120"	CSG
XmNhorizontalLabelPlacement	int	XintPLACEMENT_TOP_ BOTTOM	CSG
XmNhorizontalMajorAnnotation	Boolean	True	CSG
XmNhorizontalMajorAnnotationFont	char *	"courierbold-r100"	CSG
XmNhorizontalMajorGridLineStyle	int	XintGRID_LINE_SOLID	CSG
XmNhorizontalMajorIncrement	float *	10.0	CSG
XmNhorizontalMajorThickness	int	2	CSG
XmNhorizontalMajorTickLength	int	-5	CSG
XmNhorizontalMinorAnnotation	Boolean	False	CSG
XmNhorizontalMinorAnnotationFont	char *	"couriermedium-r100"	CSG
XmNhorizontalMinorGridLineStyle	int	XintGRID_LINE_NONE	CSG
XmNhorizontalMinorIncrement	float *	5.0	CSG
XmNhorizontalMinorThickness	int	1	CSG
XmNhorizontalMinorTickLength	int	-5	CSG
XmNhorizontalStart	float *	0.0	CSG
XmNlabelForeground	Pixel	black	CSG
XmNleftAnnotationAngle	int	0	CSG
XmNleftMargin	int	60	CSG
XmNresizeCallback	XtCallbackList	NULL	C
XmNrightAnnotationAngle	int	0	CSG
XmNrightMargin	int	60	CSG
XmNroundAnnotation	Boolean	False	CSG
XmNtextThreeD	Boolean	False	CSG
XmNtitleAlignment	int	XintALIGNMENT_CENTER	CSG
XmNtitleBackground	Pixel	default background	CSG
XmNtitleFont	char *	"courierbold-r140"	CSG
XmNtitleForeground	Pixel	black	CSG
XmNtitlePlacement	int	XintPLACEMENT_TOP	CSG
XmNtitleShadowType	int	XintSHADOW_NONE	CSG
XmNtitleString	char *	NULL	CSG
XmNtopAnnotationAngle	int	0	CSG
XmNtopMargin	int	70	CSG
XmNverticalAnnotationForeground	Pixel	black	CSG
XmNverticalAnnotationFormat	char *	"%g"	CSG
XmNverticalAnnotationPlacement	int	XintPLACEMENT_LEFT_ RIGHT	CSG
XmNverticalAnnotationPosition	float *	NULL	CSG
XmNverticalAxisType	int	XintAXIS_LINEAR	CSG
XmNverticalDirection	int	XintSTART_TO_END	CSG
XmNverticalEnd	float *	100.0	CSG
XmNverticalLabel	char *	NULL	CSG
XmNverticalLabelAlignment	int	XintALIGNMENT_CENTER	CSG
XmNverticalLabelFont	char *	"courierbold-r120"	CSG
XmNverticalLabelOrientation	int	XintPARALLEL_TO_AXIS	CSG
XmNverticalLabelPlacement	int	XintPLACEMENT_LEFT_ RIGHT	CSG
XmNverticalMajorAnnotation	Boolean	True	CSG
XmNverticalMajorAnnotationFont	char *	"courierbold-r100"	CSG
XmNverticalMajorGridLineStyle	int	XintGRID_LINE_SOLID	CSG
XmNverticalMajorIncrement	float *	10.0	CSG
XmNverticalMajorThickness	int	2	CSG
XmNverticalMajorTickLength	int	-5	CSG
XmNverticalMinorAnnotation	Boolean	False	CSG
XmNverticalMinorAnnotationFont	char *	"couriermedium-r100"	CSG
XmNverticalMinorGridLineStyle	int	XintGRID_LINE_NONE	CSG
XmNverticalMinorIncrement	float *	5.0	CSG
XmNverticalMinorThickness	int	1	CSG
XmNverticalMinorTickLength	int	-5	CSG
XmNverticalStart	float *	0.0	CSG

XmNautoMarginAdjust

Specifies which of the values of the margin resources (XmNtopMargin, XmNbottomMargin, XmNleftMargin and XmNrightMargin) are automatically determined by the widget. You can specify one of the following constants:

Defined Constant Description
XintADJUST_ALL All margins will be automatically computed by the widget.
XintADJUST_NONE (default) None of the margins will be automatically computed by the widget.
XintADJUST_LEFT The left margin will be automatically computed by the widget.
XintADJUST_RIGHT The right margin will be automatically computed by the widget.
XintADJUST_TOP The top margin will be automatically computed by the widget.
XintADJUST_BOTTOM The bottom margin will be automatically computed by the widget.

Defined Constant	Description
XintADJUST_ALL	All margins will be automatically computed by the widget.
XintADJUST_NONE (default)	None of the margins will be automatically computed by the widget.
XintADJUST_LEFT	The left margin will be automatically computed by the widget.
XintADJUST_RIGHT	The right margin will be automatically computed by the widget.
XintADJUST_TOP	The top margin will be automatically computed by the widget.
XintADJUST_BOTTOM	The bottom margin will be automatically computed by the widget.

You also can specify a combination of the constants by using a logical OR operation or a arithmetic + operation. For instance, to have the left and right margin sized automatically and the top and bottom margin sized as specfied with the XmNtop and XmNbottom resources, you would set XmNautoMarginAdjust to XintADJUST_LEFT | XintADJUST_RIGHT or XintADJUST_LEFT + XintADJUST_RIGHT.

Defined Constant Description
XintFRAME (default) Draws a complete frame inside the widget window.
XintFRAME_NONE No frame will be drawn.
XintFRAME_LEFT Draws the left portion of the frame.
XintFRAME_RIGHT Draws the right portion of the frame.
XintFRAME_TOP Draws the top portion of the frame.
XintFRAME_BOTTOM Draws the bottom portion of the frame.

Defined Constant	Description
XintFRAME (default)	Draws a complete frame inside the widget window.
XintFRAME_NONE	No frame will be drawn.
XintFRAME_LEFT	Draws the left portion of the frame.
XintFRAME_RIGHT	Draws the right portion of the frame.
XintFRAME_TOP	Draws the top portion of the frame.
XintFRAME_BOTTOM	Draws the bottom portion of the frame.

The last four constants can be added (or OR'd) together to form various combinations (e.g. XintFRAME_TOP + XintFRAME_BOTTOM to have the widget draw the top and bottom portions of the frame).

XmNframeStyle

Specifies the style of line used to draw the Grid widget frame. Specify one of the following constants as the value of this resource:

Defined Constant Description
XintFRAME_SOLID Frame is drawn with a solid line.
XintFRAME_DASHED Frame is drawn with a dashed line.
XintFRAME_DOUBLE_DASHED Frame is drawn with a double dashed line.
XintFRAME_SHADOW_IN Frame is drawn so that it appears inset.
XintFRAME_SHADOW_OUT Frame is drawn so that it appears outset.

Defined Constant	Description
XintFRAME_SOLID	Frame is drawn with a solid line.
XintFRAME_DASHED	Frame is drawn with a dashed line.
XintFRAME_DOUBLE_DASHED	Frame is drawn with a double dashed line.
XintFRAME_SHADOW_IN	Frame is drawn so that it appears inset.
XintFRAME_SHADOW_OUT	Frame is drawn so that it appears outset.

XmNframeThickness

Specifies the width (in pixels) of the Grid widget frame.

XmNgridBelow

Specifies whether the grid lines are displayed above (False) or below (True) Graphic objects drawn on a Grid widget.

XmNhorizontalAnnotationForeground

Specifies the pixel color used to draw the horizontal annotation.

XmNhorizontalAnnotationFormat

Specifies the format used to draw the horizontal annotation. Use any C format descriptor (e.g. "%5.2f") suitable for displaying float point data.

XmNhorizontalAnnotationPlacement

Specifies the placement of horizontal annotation. You can specify one the following constants:

Defined Constant Description
XintPLACEMENT_NONE Horizontal annotation is not displayed.
XintPLACEMENT_TOP Horizontal annotation is displayed above the Grid frame.
XintPLACEMENT_BOTTOM Horizontal annotation is displayed below the Grid frame.
XintPLACEMENT_TOP_BOTTOM (default) Horizontal annotation is displayed above and below the Grid frame.
XintPLACEMENT_INSIDE Horizontal annotation is drawn inside the Grid frame at the location specified by resource XmNhorizontalAnnotationPosition.

Defined Constant	Description
XintPLACEMENT_NONE	Horizontal annotation is not displayed.
XintPLACEMENT_TOP	Horizontal annotation is displayed above the Grid frame.
XintPLACEMENT_BOTTOM	Horizontal annotation is displayed below the Grid frame.
XintPLACEMENT_TOP_BOTTOM (default)	Horizontal annotation is displayed above and below the Grid frame.
XintPLACEMENT_INSIDE	Horizontal annotation is drawn inside the Grid frame at the location specified by resource XmNhorizontalAnnotationPosition.

The constants listed above can be combined with an arithmetic addition or logical OR operation. For example, to draw annotation both at the top and inside the Grid frame area, specify the following: XintPLACEMENT_TOP + XintPLACEMENT_INSIDE.

XmNhorizontalAnnotationPosition

Specifies the location at which to draw the horizontal annotation within the Grid frame when the resource XmNhorizontalAnnotationPlacement includes the value XintPLACEMENT_INSIDE. This value can be positive or negative with respect to XmNhorizontalStart.

XmNhorizontalAxisType

Specifies the type of axis for the horizontal direction. Specify XintLINEAR for a linear axis and XintLOG for a logarithmic axis.

XmNhorizontalDirection

Specifies the orientation of the horizontal axis. Specify the constant XintSTART_TO_END to have the horizontal starting value located on the left end of the axis or the constant XintEND_TO_START to have the horizontal starting value located on the right end of the axis.

XmNhorizontalEnd

Specifies the axis ending value in user coordinates in the horizontal direction.

XmNhorizontalLabel

Specifies a single line string or multiple line string that provides labeling for the horizontal annotation. The label placement is controlled by resource, XmNhorizontalLabelPlacement.

XmNhorizontalLabelAlignment

Specifies the alignment of each line of the horizontal label. Multiple lines can be specified by inserting the special character `\n' between each line in the label string. Label lines are adjusted in respect to the horizontal label area, which is the same width as the widget's display area. You can specify one of the following constants:

Defined Constant Description
XintALIGNMENT_BEGINNING Lines of the label are left aligned.
XintALIGNMENT_CENTER Lines of the label are centered.
XintALIGNMENT_END Lines of the label are right aligned.

Defined Constant	Description
XintALIGNMENT_BEGINNING	Lines of the label are left aligned.
XintALIGNMENT_CENTER	Lines of the label are centered.
XintALIGNMENT_END	Lines of the label are right aligned.

XmNhorizontalLabelFont

Specifies the name of a font used to draw the horizontal label specified by resource, XmNhorizontalLabel.

XmNhorizontalLabelPlacement

Specifies the placement of the horizontal label. You can specify one of the following constants:

Defined Constant Description
XintPLACEMENT_TOP The horizontal label is drawn above the widget's display area
XintPLACEMENT_BOTTOM The horizontal label is drawn below the widget's display area.
XintPLACEMENT_TOP_BOTTOM The horizontal label is drawn both above and below the widget's display area.

Defined Constant	Description
XintPLACEMENT_TOP	The horizontal label is drawn above the widget's display area
XintPLACEMENT_BOTTOM	The horizontal label is drawn below the widget's display area.
XintPLACEMENT_TOP_BOTTOM	The horizontal label is drawn both above and below the widget's display area.

XmNhorizontalMajorAnnotation

Specifies whether or not to draw major annotation in the horizontal direction.

XmNhorizontalMajorAnnotationFont

Specifies the name of the font used to draw major annotation in the horizontal direction.

XmNhorizontalMajorGridLineStyle

Specifies the line style used to draw the major grid lines corresponding to the horizontal axis. You can use one of the following constants:

Resource Value Description
XintGRID_LINE_NONE No grid lines are drawn.
XintGRID_LINE_SOLID (default) Grid lines are solid lines.
XintGRID_LINE_DASHED Grid lines are drawn using an on-off dash pattern.
XintGRID_LINE_DOUBLE_DASHED Grid lines are drawn using a double dashed pattern.
XintGRID_LINE_SHADOW_IN Grid lines are drawn using reversed shadow colors.
XintGRID_LINE_SHADOW_OUT Grid lines are drawn using the normal bottom and top shadow colors.

Resource Value	Description
XintGRID_LINE_NONE	No grid lines are drawn.
XintGRID_LINE_SOLID (default)	Grid lines are solid lines.
XintGRID_LINE_DASHED	Grid lines are drawn using an on-off dash pattern.
XintGRID_LINE_DOUBLE_DASHED	Grid lines are drawn using a double dashed pattern.
XintGRID_LINE_SHADOW_IN	Grid lines are drawn using reversed shadow colors.
XintGRID_LINE_SHADOW_OUT	Grid lines are drawn using the normal bottom and top shadow colors.

XmNhorizontalMajorIncrement

Specifies the major grid increment, as a positive value, in the horizontal direction.

XmNhorizontalMajorThickness

Specifies the thickness, in pixels, of the major grid lines associated with the horizontal axis.

XmNhorizontalMajorTickLength

Specifies the length of major tick marks associated with the horizontal axis. Specify a positive value to have the tick marks drawn inside the grid frame or a negative value to have the tick marks drawn outside the grid frame.

XmNhorizontalMinorAnnotation

Specifies whether or not to draw minor annotation in the horizontal direction.

XmNhorizontalMinorAnnotationFont

Specifies the name of the font used to draw minor annotation in the horizontal direction.

XmNhorizontalMinorGridLineStyle

Specifies the line style used to draw the minor grid lines corresponding to the horizontal axis. Use one of the following constants:

Resource Value Description
XintGRID_LINE_NONE No grid lines are drawn.
XintGRID_LINE_SOLID (default) Grid lines are drawn using a solid line.
XintGRID_LINE_DASHED Grid lines are drawn using a on-off dash pattern.
XintGRID_LINE_DOUBLE_DASHED Grid lines are drawn using a double dashed pattern.
XintGRID_LINE_SHADOW_IN Grid lines are drawn using reversed shadow colors.
XintGRID_LINE_SHADOW_OUT Grid lines are drawn using the bottom and top shadow colors.

Resource Value	Description
XintGRID_LINE_NONE	No grid lines are drawn.
XintGRID_LINE_SOLID (default)	Grid lines are drawn using a solid line.
XintGRID_LINE_DASHED	Grid lines are drawn using a on-off dash pattern.
XintGRID_LINE_DOUBLE_DASHED	Grid lines are drawn using a double dashed pattern.
XintGRID_LINE_SHADOW_IN	Grid lines are drawn using reversed shadow colors.
XintGRID_LINE_SHADOW_OUT	Grid lines are drawn using the bottom and top shadow colors.

XmNhorizontalMinorIncrement

Specifies the minor increment, as a positive value, in the horizontal direction.

XmNhorizontalMinorThickness

Specifies the thickness, in pixels, of minor grid lines associated with the horizontal axis.

XmNhorizontalMinorTickLength

Specifies the length in pixels of minor tick marks associated with the horizontal axis. Specify a positive value to have the tick marks drawn inside the grid frame or a negative value to have the tick marks drawn outside the grid frame.

XmNhorizontalStart

Specifies the starting value in user coordinates of the horizontal axis.

XmNlabelForeground

Specifies the pixel used to draw the horizontal and vertical labels.

XmNleftAnnotationAngle

Specifies the angle of rotation to apply when drawing the left annotation. Specify a value between -360 and 360. An XWindow font will be used to draw the annotation when this resource is set to 0, a stroke font will be used otherwise.

XmNleftMargin

Specifies the margin, in pixels, between the left of the window and the left of the widget's display area. This area may contain the vertical annotation and vertical label. This resource is set automatically if resource XmNautoMarginAdjust is set to XintADJUST_ALL or XintADJUST_LEFT.

XmNresizeCallback

Specifies a list of callbacks to be called when the Grid widget window is resized.

XmNrightAnnotationAngle

Specifies the angle of rotation to apply when drawing the right annotation. Specify a value between -360 and 360. An XWindow font will be used to draw the annotation when this resource is set to 0, a stroke font will be used otherwise.

XmNrightMargin

XmNroundAnnotation

Specifies whether annotation is placed at a multiple of the increment (True) or at the starting value plus multiples of the increment (False).

XmNtextThreeD

Specfies whether the widget's labels and title are drawn with a shadow so that they have a 3-dimensional appearance. The default is False indicating that they will not have a 3-dimensional appearance.

XmNtitleAlignment

Specifies the alignment of the lines of the title if it has more than one line. Multiple lines can be specified by inserting special character `\n' between each line in the title string. You can specify one of the following constants:

Defined Constant Description
XintALIGNMENT_BEGINNING Lines of the title are left adjusted.
XintALIGNMENT_CENTER Lines of the title are centered.
XintALIGNMENT_END Lines of the title are right adjusted.

Defined Constant	Description
XintALIGNMENT_BEGINNING	Lines of the title are left adjusted.
XintALIGNMENT_CENTER	Lines of the title are centered.
XintALIGNMENT_END	Lines of the title are right adjusted.

XmNtitleBackground

Specifies the pixel value used to draw the background of the title.

XmNtitleFont

Specifies the name of the font used to draw the title.

XmNtitleForeground

Specifies the pixel value used to draw the foreground of the title.

XmNtitlePlacement

Specifies the placement of the title string. You can specify one of the following constants:

Defined Constant Description
XintPLACEMENT_NONE The title is not drawn.
XintPLACEMENT_TOP (default) The title is drawn above the widget's window.
XintPLACEMENT_BOTTOM The title is drawn at the bottom of the widget's window.

Defined Constant	Description
XintPLACEMENT_NONE	The title is not drawn.
XintPLACEMENT_TOP (default)	The title is drawn above the widget's window.
XintPLACEMENT_BOTTOM	The title is drawn at the bottom of the widget's window.

XmNtitleShadowType

Specifies the type of shadow to draw around the title. You can specify one of the following constants:

Defined Constant Description
XintSHADOW_NONE No shadow is drawn.
XintSHADOW_IN Shadow drawn so that title appears inset.
XintSHADOW_OUT Shadow drawn so that tile appears outset.
XintSHADOW_ETCHED_IN Shadow drawn using a double line inset.
XintSHADOW_ETCHED_OUT Shadow drawn using a double line outset.

Defined Constant	Description
XintSHADOW_NONE	No shadow is drawn.
XintSHADOW_IN	Shadow drawn so that title appears inset.
XintSHADOW_OUT	Shadow drawn so that tile appears outset.
XintSHADOW_ETCHED_IN	Shadow drawn using a double line inset.
XintSHADOW_ETCHED_OUT	Shadow drawn using a double line outset.

XmNtitleString

Specifies the string used to draw the title. The color, font and location of the title string can be specified using resources XmNtitleFont, XmNtitleForeground and XmNtitlePlacement.

XmNtopAnnotationAngle

Specifies the angle of rotation to apply when drawing the top annotation. Specify a value between -360 and 360. An XWindow font will be used to draw the annotation when this resource is set to 0, a stroke font will be used otherwise.

XmNtopMargin

Specifies the margin, in pixels, between the top of the widget window and the top of the widget's display window. This area may contain the horizontal annotation, horizontal label and title. This resource is automatically set by the widget when the value of the resource XmNautoMarginAdjust is XintADJUST_ALL or XintADJUST_TOP.

XmNverticalAnnotationForeground

Specifies the color (as a Pixel value) used to draw the vertical annotation.

XmNverticalAnnotationFormat

Specifies the format used to draw the vertical annotation. Use any C format descriptor (e.g. "%5.2f") for displaying floating point data.

XmNverticalAnnotationPlacement

Specifies the placement of vertical annotation. You can specify one the following constants:

Defined Constant Description
XintPLACEMENT_NONE Vertical annotation is not displayed.
XintPLACEMENT_RIGHT Vertical annotation is displayed to the right of the Grid frame.
XintPLACEMENT_LEFT Vertical annotation is displayed to the left of the Grid frame.
XintPLACEMENT_LEFT_RIGHT (default) Vertical annotation is displayed left and right of the Grid frame.
XintPLACEMENT_INSIDE Vertical annotation is drawn inside the Grid frame at the location specified by resource XmNverticalAnnotationPosition.

Defined Constant	Description
XintPLACEMENT_NONE	Vertical annotation is not displayed.
XintPLACEMENT_RIGHT	Vertical annotation is displayed to the right of the Grid frame.
XintPLACEMENT_LEFT	Vertical annotation is displayed to the left of the Grid frame.
XintPLACEMENT_LEFT_RIGHT (default)	Vertical annotation is displayed left and right of the Grid frame.
XintPLACEMENT_INSIDE	Vertical annotation is drawn inside the Grid frame at the location specified by resource XmNverticalAnnotationPosition.

The constants listed above can be combined with an arithmetic addition or logical OR operation. For example, to draw annotation both on the right and also inside the Grid frame area, specify the following: XintPLACEMENT_RIGHT + XintPLACEMENT_INSIDE.

XmNverticalAnnotationPosition

Specifies the location at which to draw the vertical annotation within the Grid frame when the resource XmNverticalAnnotationPlacement includes the value XintPLACEMENT_INSIDE. This value can be positive or negative with respect to XmNverticalStart.

XmNverticalAxisType

Specifies the type of axis in the vertical direction. Specify XintLINEAR for a linear axis or XintLOG for a logarithmic axis.

XmNverticalDirection

Specifies the orientation of the vertical axis. Specify XintSTART_TO_END to have the vertical starting value located at the top of the axis or XintEND_TO_START to have the vertical ending value located at the top of the axis.

XmNverticalEnd

Specifies the axis ending value in user coordinates in the vertical direction.

XmNverticalLabel

Specifies a single or multiple line string that provides labelling for the vertical annotation. The label placement is controlled by resource XmNverticalLabelPlacement.

XmNverticalLabelAlignment

Specifies the alignment of each line of the vertical label. Multiple lines can be specified by inserting the special character `\n' between lines in the label string. Label lines are adjusted in respect to the vertical label area, which is the same height as the widget's display area. For a vertical label, beginning alignment means the lines are justified to the top of the widget's display area and continue downward. End alignment means these lines will be justified to the bottom of the widget's display area and continue upward. You can specify one of the following constants:

Defined Constant Description
XintALIGNMENT_BEGINNING Lines of the label are aligned with the top of the widget's display area.
XintALIGNMENT_CENTER Lines of the label are centered.
XintALIGNMENT_END Lines of the label are aligned with the bottom of the widget's display area.

Defined Constant	Description
XintALIGNMENT_BEGINNING	Lines of the label are aligned with the top of the widget's display area.
XintALIGNMENT_CENTER	Lines of the label are centered.
XintALIGNMENT_END	Lines of the label are aligned with the bottom of the widget's display area.

XmNverticalLabelFont

Specifies the name of a font used to draw the vertical label specified by the resource XmNverticalLabel.

XmNverticalLabelOrientation

Specifies the orientation of the label string. Specify the constant XintPARALLEL_TO_AXIS to have the label rotated 90 degrees from the horizontal and placed along the vertical axis, or the constant XintSTACKED to have the letters of the label stacked vertically.

XmNverticalLabelPlacement

Specifies the placement of the vertical label. You can specify one of the following constants:

Defined Constant Description
XintPLACEMENT_LEFT The vertical label is drawn left of the widget's display area.
XintPLACEMENT_RIGHT The vertical label is drawn right of the widget's display area.
XintPLACEMENT_LEFT_RIGHT The vertical label is drawn both left and right of the widget's display area.

Defined Constant	Description
XintPLACEMENT_LEFT	The vertical label is drawn left of the widget's display area.
XintPLACEMENT_RIGHT	The vertical label is drawn right of the widget's display area.
XintPLACEMENT_LEFT_RIGHT	The vertical label is drawn both left and right of the widget's display area.

XmNverticalMajorAnnotation

Specifies whether or not to draw major annotation in the vertical direction.

XmNverticalMajorAnnotationFont

Specifies the name of the font used to draw the major annotation in the vertical direction.

XmNverticalMajorGridLineStyle

Specifies the line style used to draw the major grid lines corresponding to the vertical axis. Use one of the following constants:

Resource Value	Description
XintGRID_LINE_NONE	No grid lines are drawn.
XintGRID_LINE_SOLID (default)	Grid lines are drawn using a solid line.
XintGRID_LINE_DASHED	Grid lines are drawn using a on-off dash pattern.
XintGRID_LINE_DOUBLE_DASHED	Grid lines are drawn using a double dashed pattern.
XintGRID_LINE_SHADOW_IN	Grid lines are drawn using reversed shadow colors.
XintGRID_LINE_SHADOW_OUT	Grid lines are drawn using the bottom and top shadow colors.

XmNverticalMajorIncrement

Specifies the major increment, as a positive value, in the vertical direction.

XmNverticalMajorThickness

Specifies the width, in pixels, of major grid lines associated with the vertical axis.

XmNverticalMajorTickLength

Specifies the length, in pixels, of major tick marks associated with the vertical axis. Specify a positive value to have the tick marks drawn inside the grid frame or a negative value to have the tick marks drawn outside the grid frame.

XmNverticalMinorAnnotation

Specifies whether or not to draw vertical minor annotation. The default value is True, indicating that the vertical minor annotation is to be drawn.

XmNverticalMinorAnnotationFont

Specifies the name of a font used to draw minor annotation in the vertical direction.

XmNverticalMinorGridLineStyle

Specifies the line style used to draw the minor grid lines corresponding to the vertical axis. Use one of the following constants:

Resource Value	Description
XintGRID_LINE_NONE	No grid lines are drawn.
XintGRID_LINE_SOLID (default)	Grid lines are drawn using a solid line.
XintGRID_LINE_DASHED	Grid lines are drawn using a on-off dash pattern.
XintGRID_LINE_DOUBLE_DASHED	Grid lines are drawn using a double dashed pattern.
XintGRID_LINE_SHADOW_IN	Grid lines are drawn using reversed shadow colors.
XintGRID_LINE_SHADOW_OUT	Grid lines are drawn using the bottom and top shadow colors.

XmNverticalMinorIncrement

Specifies the minor increment, as a positive value, in the vertical direction.

XmNverticalMinorThickness

Specifies the width, in pixels, of minor grid lines associated with the vertical axis.

XmNverticalMinorTickLength

Specifies the length, in pixels, of minor tick marks associated with the vertical axis. Specify a positive value to have the tick marks drawn inside the grid frame or a negative value to have the tick marks drawn outside the grid frame.

XmNverticalStart

Specifies the starting value, in user coordinates, of the horizontal axis.

Constraint Resources

The following constraint resources are defined by the Grid widget class. These resources can be applied to specify the location of Axis widgets created as children of a Grid widget.

Name	Type	Default	Access
XmNaxisOffset	int	5	CSG
XmNpercentEnd	int	100	CSG
XmNpercentStart	int	0	CSG
XmNplacement	int	dynamic	CSG

XmNaxisOffset

Specifies the offset in pixels between the Grid widget annotation area and the Axis widget.

XmNpercentEnd

Specifies the ending location of the Axis widget as a percentage. Specify 100 to have the Axis widget extend to the end of the Grid widget.

XmNpercentStart

Specifies the starting location of the Axis widget as a percentage. Specify 0 to have the Axis widget start at the beginning of the Grid widget.

XmNplacement

Specifies the location of the Axis widget. You can specify one of the following constants:

Resource Value Description
XintPLACEMENT_TOP The Axis widget is created above the Grid top annotation area. The Axis widget must be horizontal.
XintPLACEMENT_BOTTOM The Axis widget is created under the Grid bottom annotation area. The Axis widget must be horizontal.
XintPLACEMENT_LEFT The Axis widget is created left of the Grid left annotation area. The Axis widget must be vertical.
XintPLACEMENT_RIGHT The Axis widget is created right of the Grid right annotation area. The Axis widget must be vertical.

Resource Value	Description
XintPLACEMENT_TOP	The Axis widget is created above the Grid top annotation area. The Axis widget must be horizontal.
XintPLACEMENT_BOTTOM	The Axis widget is created under the Grid bottom annotation area. The Axis widget must be horizontal.
XintPLACEMENT_LEFT	The Axis widget is created left of the Grid left annotation area. The Axis widget must be vertical.
XintPLACEMENT_RIGHT	The Axis widget is created right of the Grid right annotation area. The Axis widget must be vertical.

Defined Actions

The Grid widget class inherits all of the action routines defined by the superclass EditObject. Refer to the EditObject widget class reference section for a description of the action routines. In addition, the Grid widget class defines the action routines listed below. Both the inherited and defined actions can be tied to user event sequences via a translation table.

Name Description
Highlight() Highlights the color of the title string to that color specified as the value of resource XmNhighlightColor.
UnHighlight() Returns the color of the title string to its original color.

Name	Description
Highlight()	Highlights the color of the title string to that color specified as the value of resource XmNhighlightColor.
UnHighlight()	Returns the color of the title string to its original color.

Default Translations

The following translation table is used by a Grid widget. These default translations can be overridden by the end-user or application programmer.

Event Sequence Actions Invoked
<EnterWindow> ManagerEnter() InitDrawCursor()
<LeaveWindow> ManagerFocus() EndDrawCursor()
<FocusIn> ManagerFocusIn() Highlight()
<FocusOut> ManagerFocusOut() UnHighlight()
Ctrl <Key>k ChangeCursorMask()
!Shift <Key> Tab PreviousTabGroup()
None <Key> Tab NextTabGroup()
!Shift <Btn1Down> TraverseCurrent() Locator() SelectionCallback() InitAreaSelection(callback) ObjectEditEnd()
!Ctrl <Btn1Down> TraverseCurrent() Locator() SelectionCallback() InitAreaSelection(extend) ObjectSelect(extend)
None <Btn1Down> TraverseCurrent() ObjectSelect(single) ObjectEditStart() Locator() SelectionCallback() InitAreaSelection(single)
None <Btn2Down> ObjectEditEnd(m) SelectionCallback()
None <BtnDown> SelectionCallback()
<Btn1Up> EndAreaSelection() ObjectEditEnd()
<PtrMoved> DrawCursor() ExtendAreaSelection() ObjectEdit() Locator()

Event Sequence	Actions Invoked
<EnterWindow>	ManagerEnter() InitDrawCursor()
<LeaveWindow>	ManagerFocus() EndDrawCursor()
<FocusIn>	ManagerFocusIn() Highlight()
<FocusOut>	ManagerFocusOut() UnHighlight()
Ctrl <Key>k	ChangeCursorMask()
!Shift <Key> Tab	PreviousTabGroup()
None <Key> Tab	NextTabGroup()
!Shift <Btn1Down>	TraverseCurrent() Locator() SelectionCallback() InitAreaSelection(callback) ObjectEditEnd()
!Ctrl <Btn1Down>	TraverseCurrent() Locator() SelectionCallback() InitAreaSelection(extend) ObjectSelect(extend)
None <Btn1Down>	TraverseCurrent() ObjectSelect(single) ObjectEditStart() Locator() SelectionCallback() InitAreaSelection(single)
None <Btn2Down>	ObjectEditEnd(m) SelectionCallback()
None <BtnDown>	SelectionCallback()
<Btn1Up>	EndAreaSelection() ObjectEditEnd()
<PtrMoved>	DrawCursor() ExtendAreaSelection() ObjectEdit() Locator()

Defined Callbacks

The following callbacks are defined (or inherited) by the Grid widget class:

Name Structure Reason
XmNareaSelectionCallback XintGridAreaSelectionCallbackStruct XintCR_AREA_SELECTION
XmNexposeCallback XintCallbackStruct XintCR_EXPOSE
XmNlocatorCallback XintGridLocatorCallbackStruct XintCR_LOCATOR
XmNresizeCallback XintCallbackStruct XintCR_RESIZE
XmNselectionCallback XintGridLocatorCallbackStruct XintCR_SELECTION

Name	Structure	Reason
XmNareaSelectionCallback	XintGridAreaSelectionCallbackStruct	XintCR_AREA_SELECTION
XmNexposeCallback	XintCallbackStruct	XintCR_EXPOSE
XmNlocatorCallback	XintGridLocatorCallbackStruct	XintCR_LOCATOR
XmNresizeCallback	XintCallbackStruct	XintCR_RESIZE
XmNselectionCallback	XintGridLocatorCallbackStruct	XintCR_SELECTION

XintGridAreaSelectionCallbackStruct

The following ordered table lists the members of the callback structure XintGridAreaSelectionCallbackStruct returned to each procedure in the callback list specified by the resource XmNareaSelectionCallback.

Data Type Member Description
int reason Indicates why the callback was invoked.
XEvent * event Points to the XEvent that triggered the callback.
int x_start X coordinate of the upper left corner of the selected rectangle in pixel units.
int y_start Y coordinate of the upper left corner of the selected rectangle in pixel units.
int x_end X coordinate of the lower right corner of the selected rectangle in pixel units.
int y_end Y coordinate of the lower right corner of the selected rectangle in pixel units.
float user_x_start X coordinate of the upper left corner of the selected rectangle in user units.
float user_y_start Y coordinate of the upper left corner of the selected rectangle in user units.
float user_x_end X coordinate of the lower right corner of the selected rectangle in user units.
float user_y_end Y coordinate of the lower right corner of the selected rectangle in user units.

Data Type	Member	Description
int	reason	Indicates why the callback was invoked.
XEvent *	event	Points to the XEvent that triggered the callback.
int	x_start	X coordinate of the upper left corner of the selected rectangle in pixel units.
int	y_start	Y coordinate of the upper left corner of the selected rectangle in pixel units.
int	x_end	X coordinate of the lower right corner of the selected rectangle in pixel units.
int	y_end	Y coordinate of the lower right corner of the selected rectangle in pixel units.
float	user_x_start	X coordinate of the upper left corner of the selected rectangle in user units.
float	user_y_start	Y coordinate of the upper left corner of the selected rectangle in user units.
float	user_x_end	X coordinate of the lower right corner of the selected rectangle in user units.
float	user_y_end	Y coordinate of the lower right corner of the selected rectangle in user units.

XintCallbackStruct

The following ordered table lists the members of the callback structure XintCallbackStruct used by the Grid widget for the expose and resize callbacks.

Data Type Member Description
int reason Indicates why the callback was invoked.
XEvent * event Pointer to the XEvent that triggered the callback.
Window window Window ID of the Grid widget.

Data Type	Member	Description
int	reason	Indicates why the callback was invoked.
XEvent *	event	Pointer to the XEvent that triggered the callback.
Window	window	Window ID of the Grid widget.

XintGridLocatorCallbackStruct

The following ordered table lists the members of the callback structure XintGridLocatorCallbackStruct returned to each procedure in the callback list specified by resource XmNlocatorCallback.

Data Type Member Description
int reason Indicates why the callback was invoked.
XEvent * event Points to the XEvent that triggered the callback.
int pixel_x The X location of the cursor in the window coordinate system.
int pixel_y The Y location of the cursor in the window coordinate system.
float user_x The X location of the cursor in the user coordinate system.
float user_y The Y location of the cursor in the user coordinate system.
Boolean inside_frame True if the cursor is inside the grid's frame and False otherwise.

Data Type	Member	Description
int	reason	Indicates why the callback was invoked.
XEvent *	event	Points to the XEvent that triggered the callback.
int	pixel_x	The X location of the cursor in the window coordinate system.
int	pixel_y	The Y location of the cursor in the window coordinate system.
float	user_x	The X location of the cursor in the user coordinate system.
float	user_y	The Y location of the cursor in the user coordinate system.
Boolean	inside_frame	True if the cursor is inside the grid's frame and False otherwise.

Area selection callback

This list of callback procedures, inherited from the EditObject class, is called whenever an area is selected inside a Grid widget's window using the area selection action routines.The callback structure returned by this callback is redefined by the Grid class.

Expose callback

This list of callback procedures is called whenever the Grid widget's window is exposed so that the application can redraw anything that it displays in the Grid widget's window.

Locator callback

This list of callback procedures, inherited from the EditObject class, is called by the Locator action when the cursor is moved inside a Grid widget's window. The callback structure returned by this callback is redefined by the Grid class.

Resize callback

This list of callback procedures is called whenever the Grid widget window is resized so that the application can resize anything that is displaying in the Grid widget's window.

Selection callback

This list of callback procedures, inherited from the EditObject class, is called when the user presses one of the mouse buttons inside the widget window. The callback structure returned by this callback is redefined by the Grid class.

Defined Functions

The following functions are defined by the Grid widget class.

Function Name Description
XintCreateGrid Creates an unmanaged Grid widget.
XintGridZoom Performs a zoom operation for a widget whose class is derived from the XintGrid widget class.

Function Name	Description
XintCreateGrid	Creates an unmanaged Grid widget.
XintGridZoom	Performs a zoom operation for a widget whose class is derived from the XintGrid widget class.

XintCreateGrid

This function creates an unmanaged Grid widget.

     Widget XintCreateGrid (...)

Widget parent Parent of the new Grid widget.
char * name Name of the new Grid widget.
ArgList arglist List of resource/value items.
Cardinal argcount Number of items in arglist.

XintGridZoom

Causes a selected area of a widget's displayed image to be zoomed. The widget must be an instance of the XintGrid widget class or a class derived from the Grid widget class. The area to be scaled must have been previously selected and returned to the application via an area selection callback. The zoom operation can be performed so that the scaled image replaces the previous image displayed by the widget. Alternatively, a new widget can be created to display the scaled area.

     Widget XintGridZoom (...)

Widget widget Widget ID of the widget containing the area to be scaled.
Widget parent Specify the parent's widget ID so that a new widget will be created as a child of the widget's parent, to display the zoomed area, or specify NULL so that the original widget will be used to display the zoomed area.
XintGridAreaSelectionCallbackStruct * selection Specify the address of an XintGridAreaSelectionCallback structure that indicates the area to be zoomed, or specify NULL to indicate that the currently displayed area in the widget is the area to be zoomed.
float zx The horizontal scale factor to be used to zoom the selected area.
float zy The vertical scale factor to be used to zoom the selected area.

This function returns the widget ID of the widget containing the zoomed area (i.e., the original widget or the new widget) if it is successful. Otherwise, it returns NULL.

Widget	parent	Parent of the new Grid widget.
char *	name	Name of the new Grid widget.
ArgList	arglist	List of resource/value items.
Cardinal	argcount	Number of items in arglist.

Widget	widget	Widget ID of the widget containing the area to be scaled.
Widget	parent	Specify the parent's widget ID so that a new widget will be created as a child of the widget's parent, to display the zoomed area, or specify NULL so that the original widget will be used to display the zoomed area.
XintGridAreaSelectionCallbackStruct *	selection	Specify the address of an XintGridAreaSelectionCallback structure that indicates the area to be zoomed, or specify NULL to indicate that the currently displayed area in the widget is the area to be zoomed.
float	zx	The horizontal scale factor to be used to zoom the selected area.
float	zy	The vertical scale factor to be used to zoom the selected area.