File: alphalist.h

package info (click to toggle)
libcdk 4.9.9-4
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 5,008 kB
  • ctags: 2,239
  • sloc: ansic: 28,664; sh: 334; makefile: 275; cpp: 42
file content (178 lines) | stat: -rw-r--r-- 5,845 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
#ifndef CDKALPHALIST_H
#define CDKALPHALIST_H	1

#include "cdk.h"
#include "entry.h"
#include "scroll.h"

/*
 * Description of the widget:
 *
 */

/*
 * Copyright (c) 1990 The Regents of the University of California.
 * 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 acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 THE REGENTS 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 alphalist widget structure.
 */
struct SAlphalist {
   CDKSCREEN	*screen;
   WINDOW	*parent;
   WINDOW	*win;
   WINDOW	*shadowWin;
   CDKENTRY	*entryField;
   CDKSCROLL	*scrollField;
   char		*list[MAX_ITEMS];
   int		listSize;
   int		xpos;
   int		ypos;
   int		height;
   int		width;
   int		boxHeight;
   int		boxWidth;
   chtype	highlight;
   chtype	fillerChar;
   boolean	box;
   boolean	shadow;
   EExitType	exitType;
   int		screenIndex;
   BINDFN	bindFunction[MAX_BINDINGS];
   void *	bindData[MAX_BINDINGS];
   PROCESSFN	preProcessFunction;
   void *	preProcessData;
   PROCESSFN	postProcessFunction;
   void *	postProcessData;
};
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,
				char *title, char *label,
				char *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.
 */
char *injectCDKAlphalist (CDKALPHALIST *alphalist, chtype input);

/*
 * This sets multiple attributes of the alphalist widget.
 */
void setCDKAlphalist (CDKALPHALIST *alphalist,
			char *list[], int listSize,
			chtype fillerChar, chtype highlight,
			boolean Box);

/*
 * This sets the contents of the alpha list.
 */
void setCDKAlphalistContents (CDKALPHALIST *alphalist, char *list[], int listSize);
char **getCDKAlphalistContents (CDKALPHALIST *alphalist, int *size);

/*
 * 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 attibute of the widget.
 */
void setCDKAlphalistBox (CDKALPHALIST *alphalist, boolean Box);
boolean getCDKAlphalistBox (CDKALPHALIST *alphalist);

/*
 * These functions set the drawing characters of the widget.
 */
void setCDKAlphalistULChar (CDKALPHALIST *alphalist, chtype character);
void setCDKAlphalistURChar (CDKALPHALIST *alphalist, chtype character);
void setCDKAlphalistLLChar (CDKALPHALIST *alphalist, chtype character);
void setCDKAlphalistLRChar (CDKALPHALIST *alphalist, chtype character);
void setCDKAlphalistVerticalChar (CDKALPHALIST *alphalist, chtype character);
void setCDKAlphalistHorizontalChar (CDKALPHALIST *alphalist, chtype character);
void setCDKAlphalistBoxAttribute (CDKALPHALIST *alphalist, chtype character);

/*
 * This sets the background color of the widget.
 */ 
void setCDKAlphalistBackgroundColor (CDKALPHALIST *alphalist, char *color);

/*
 * This draws the widget on the screen.
 */
void drawCDKAlphalist (CDKALPHALIST *alphalist, boolean Box);

/*
 * This removes the widget from the screen.
 */
void eraseCDKAlphalist (CDKALPHALIST *alphalist);

/*
 * This moves the widget to the location specified.
 */
void moveCDKAlphalist (CDKALPHALIST *alphalist, int xpos, int ypos, boolean relative, boolean refresh);

/*
 * This allows the user to interactively position the widget.
 */
void positionCDKAlphalist (CDKALPHALIST *alphalist);

/*
 * This destroys the widget and all the memory associated with it.
 */
void destroyCDKAlphalist (CDKALPHALIST *alphalist);

/*
 * 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);
#endif