NetBSD/dist/cdk/include/scale.h

#ifndef CDKSCALE_H
#define CDKSCALE_H	1

#include <cdk/cdk.h>

/*
 * Description of the widget:
 *
 */

/*
 * Copyright 1999, Mike Glover
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgment:
 *      This product includes software developed by Mike Glover
 *      and contributors.
 * 4. Neither the name of Mike Glover, nor the names of contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY MIKE GLOVER AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL MIKE GLOVER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * Define the CDK widget scale structure.
 */
struct SScale {
   CDKOBJS	obj;
   WINDOW	*parent;
   WINDOW	*win;
   WINDOW	*titleWin;
   chtype	*title[MAX_LINES];
   int		titlePos[MAX_LINES];
   int		titleLen[MAX_LINES];
   int		titleLines;
   WINDOW	*labelWin;
   chtype	*label;
   int		labelLen;
   WINDOW	*fieldWin;
   chtype	fieldAttr;
   int		fieldWidth;
   int		boxHeight;
   int		boxWidth;
   int		low;
   int		high;
   int		current;
   int		inc;
   int		fastinc;
   EExitType	exitType;
   boolean	shadow;
   chtype	ULChar;
   chtype	URChar;
   chtype	LLChar;
   chtype	LRChar;
   chtype	VChar;
   chtype	HChar;
   chtype	BoxAttrib;
   PROCESSFN	preProcessFunction;
   void *	preProcessData;
   PROCESSFN	postProcessFunction;
   void *	postProcessData;
};
typedef struct SScale CDKSCALE;

/*
 * This creates a new pointer to a scale widget.
 */
CDKSCALE *newCDKScale (
		CDKSCREEN *	/* cdkscreen */,
		int		/* xpos */,
		int		/* ypos */,
		char *		/* title */,
		char *		/* label */,
		chtype		/* fieldAttr */,
		int		/* fieldWidth */,
		int		/* start */,
		int		/* low */,
		int		/* high */,
		int		/* inc */,
		int		/* fastinc */,
		boolean		/* Box */,
		boolean		/* shadow */);

/*
 * This activates the widget.
 */
int activateCDKScale (
		CDKSCALE *	/* scale */,
		chtype *	/* actions */);

/*
 * This injects a single character into the widget.
 */
int injectCDKScale (
		CDKSCALE *	/* scale */,
		chtype		/* input */);

/*
 * This sets various attributes of the widget.
 */
void setCDKScale (
		CDKSCALE *	/* scale */,
		int		/* low */,
		int		/* high */,
		int		/* value */,
		boolean		/* Box */);

/*
 * This sets the low and high values.
 */
void setCDKScaleLowHigh (
		CDKSCALE *	/* scale */,
		int		/* low */,
		int		/* high */);

int getCDKScaleLowValue (
		CDKSCALE *	/* scale */);

int getCDKScaleHighValue (
		CDKSCALE *	/* scale */);

/*
 * This returns the current value of the widget.
 */
void setCDKScaleValue (
		CDKSCALE *	/* scale */,
		int		/* value */);

int getCDKScaleValue (
		CDKSCALE *	/* scale */);

/*
 * This sets the box attribute of the widget.
 */
void setCDKScaleBox (
		CDKSCALE *	/* scale */,
		boolean		/* Box */);

boolean getCDKScaleBox (
		CDKSCALE *	/* scale */);

/*
 * These functions set the drawing characters of the widget.
 */
void setCDKScaleULChar (
		CDKSCALE *	/* scale */,
		chtype		/* character */);

void setCDKScaleURChar (
		CDKSCALE *	/* scale */,
		chtype		/* character */);

void setCDKScaleLLChar (
		CDKSCALE *	/* scale */,
		chtype		/* character */);

void setCDKScaleLRChar (
		CDKSCALE *	/* scale */,
		chtype		/* character */);

void setCDKScaleVerticalChar (
		CDKSCALE *	/* scale */,
		chtype		/* character */);

void setCDKScaleHorizontalChar (
		CDKSCALE *	/* scale */,
		chtype		/* character */);

void setCDKScaleBoxAttribute (
		CDKSCALE *	/* scale */,
		chtype		/* character */);

/*
 * This sets the background color of the widget.
 */
void setCDKScaleBackgroundColor (
		CDKSCALE *	/* scale */,
		char *		/* color */);

/*
 * This draws the scale widget on the screen.
 */
#define drawCDKScale(obj,Box) drawCDKObject(obj,Box)

/*
 * This erases the widget on the screen.
 */
#define eraseCDKScale(obj) eraseCDKObject(obj)

/*
 * This moves the widget to the given location on the screen.
 */
#define moveCDKScale(obj,xpos,ypos,relative,refresh) moveCDKObject(obj,xpos,ypos,relative,refresh)

/*
 * This interactively positions the widget on the screen.
 */
#define positionCDKScale(widget) positionCDKObject(ObjOf(widget),widget->win)

/*
 * This destroys the widget and all associated memory.
 */
void destroyCDKScale (
		CDKSCALE *	/* scale */);

/*
 * These set the pre/post process callback functions.
 */
void setCDKScalePreProcess (
		CDKSCALE *	/* scale */,
		PROCESSFN	/* callback */,
		void *		/* data */);

void setCDKScalePostProcess (
		CDKSCALE *	/* scale */,
		PROCESSFN	/* callback */,
		void *		/* data */);

#endif /* CDKSCALE_H */