/* * $Id: alphalist.h,v 1.25 2014/01/19 01:58:40 tom Exp $ */ #ifndef CDKINCLUDES #ifndef CDKALPHALIST_H #define CDKALPHALIST_H 1 #ifdef __cplusplus extern "C" { #endif #ifndef CDK_H #define CDKINCLUDES #include #undef CDKINCLUDES #include #include #include #endif /* * Changes 1999-2012,2014 copyright Thomas E. Dickey * * 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. */ #include #include /* * Define the CDK alphalist widget structure. */ struct SAlphalist { CDKOBJS obj; WINDOW * parent; WINDOW * win; WINDOW * shadowWin; CDKENTRY * entryField; CDKSCROLL * scrollField; char ** list; int listSize; int xpos; int ypos; int height; int width; int boxHeight; int boxWidth; chtype highlight; chtype fillerChar; boolean shadow; EExitType exitType; }; typedef struct SAlphalist CDKALPHALIST; /* * This creates a pointer to a new CDK alphalist widget. */ CDKALPHALIST *newCDKAlphalist ( CDKSCREEN * /* cdkscreen */, int /* xpos */, int /* ypos */, int /* height */, int /* width */, const char * /* title */, const char * /* label */, CDK_CSTRING * /* list */, int /* listSize */, chtype /* fillerChar */, chtype /* highlight */, boolean /* Box */, boolean /* shadow */); /* * This allows the user to interact with the widget. */ char *activateCDKAlphalist ( CDKALPHALIST * /* alphalist */, chtype * /* actions */); /* * This injects a single character into the widget. */ #define injectCDKAlphalist(obj,input) injectCDKObject(obj,input,String) /* * This sets multiple attributes of the alphalist widget. */ void setCDKAlphalist ( CDKALPHALIST * /* alphalist */, CDK_CSTRING * /* list */, int /* listSize */, chtype /* fillerChar */, chtype /* highlight */, boolean /* Box */); /* * This sets the contents of the alpha list. */ void setCDKAlphalistContents ( CDKALPHALIST * /* alphalist */, CDK_CSTRING * /* list */, int /* listSize */); char **getCDKAlphalistContents ( CDKALPHALIST * /* alphalist */, int * /* size */); /* * Get/set the current position in the scroll-widget. */ int getCDKAlphalistCurrentItem( CDKALPHALIST * /* widget */); void setCDKAlphalistCurrentItem( CDKALPHALIST * /* widget */, int /* item */); /* * This sets the filler character of the entry field of the alphalist. */ void setCDKAlphalistFillerChar ( CDKALPHALIST * /* alphalist */, chtype /* fillerCharacter */); chtype getCDKAlphalistFillerChar ( CDKALPHALIST * /* alphalist */); /* * This sets the highlight bar attributes. */ void setCDKAlphalistHighlight ( CDKALPHALIST * /* alphalist */, chtype /* highlight */); chtype getCDKAlphalistHighlight ( CDKALPHALIST * /* alphalist */); /* * This sets the box attribute of the widget. */ void setCDKAlphalistBox ( CDKALPHALIST * /* alphalist */, boolean /* Box */); boolean getCDKAlphalistBox ( CDKALPHALIST * /* alphalist */); /* * These functions set the drawing characters of the widget. */ #define setCDKAlphalistULChar(w,c) setULCharOf(w,c) #define setCDKAlphalistURChar(w,c) setURCharOf(w,c) #define setCDKAlphalistLLChar(w,c) setLLCharOf(w,c) #define setCDKAlphalistLRChar(w,c) setLRCharOf(w,c) #define setCDKAlphalistVerticalChar(w,c) setVTCharOf(w,c) #define setCDKAlphalistHorizontalChar(w,c) setHZCharOf(w,c) #define setCDKAlphalistBoxAttribute(w,c) setBXAttrOf(w,c) /* * This sets the background color of the widget. */ #define setCDKAlphalistBackgroundColor(w,c) setCDKObjectBackgroundColor(ObjOf(w),c) /* * This sets the background attribute of the widget. */ #define setCDKAlphalistBackgroundAttrib(w,c) setBKAttrOf(w,c) /* * This draws the widget on the screen. */ #define drawCDKAlphalist(obj,box) drawCDKObject(obj,box) /* * This removes the widget from the screen. */ #define eraseCDKAlphalist(obj) eraseCDKObject(obj) /* * This moves the widget to the location specified. */ #define moveCDKAlphalist(obj,xpos,ypos,relative,refresh) moveCDKObject(obj,xpos,ypos,relative,refresh) /* * This allows the user to interactively position the widget. */ #define positionCDKAlphalist(widget) positionCDKObject(ObjOf(widget),widget->win) /* * This destroys the widget and all the memory associated with it. */ #define destroyCDKAlphalist(obj) destroyCDKObject(obj) /* * These functions set the pre and post process functions for the widget. */ void setCDKAlphalistPreProcess ( CDKALPHALIST * /* alphalist */, PROCESSFN /* callback */, void * /* data */); void setCDKAlphalistPostProcess ( CDKALPHALIST * /* alphalist */, PROCESSFN /* callback */, void * /* data */); #ifdef __cplusplus } #endif #endif /* CDKALPHALIST_H */ #endif /* CDKINCLUDES */