File: cdkscreen.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 (146 lines) | stat: -rw-r--r-- 4,523 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
#ifndef CDKSCREEN_H
#define CDKSCREEN_H	1

#include "cdk.h"

/*
 * 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.
 */

/*
 * Declare and definitions needed for the widget.
 */
#define MAX_OBJECTS	1000
#define	MAX_WIDGETS	MAX_OBJECTS

/*
 * Define the CDK screen structure.
 */
struct SScreen {
   WINDOW	*window;
   void		*object[MAX_OBJECTS];
   EObjectType	cdktype[MAX_OBJECTS];
   int		objectCount;
};
typedef struct SScreen CDKSCREEN;

/*
 * This function creates a CDKSCREEN pointer.
 */
CDKSCREEN *initCDKScreen (WINDOW *window);

/*
 * This registers a CDKSCREEN. You would do this if you had more
 * than one screen created and you wanted them managed.
 */
int registerCDKScreen (CDKSCREEN **screens);

/*
 * This removes the given CDKSCREEN pointer from the array
 * of managed screens.
 */
int unregisterCDKScreen (CDKSCREEN **screens);

/*
 * This raises a screen in a list of managed screens.
 */
void raiseCDKScreen (CDKSCREEN **screens);

/*
 * This lowers a screen in a list of managed screens.
 */
void lowerCDKScreen (CDKSCREEN **screens);

/*
 * This sets which CDKSCREEN pointer will be the default screen
 * in the list of managed screen.
 */
CDKSCREEN *setDefaultCDKScreen (int screenNumber);

/*
 * This function registers a CDK widget with a given screen.
 */
void registerCDKObject (CDKSCREEN *screen, EObjectType cdktype, void *object);

/*
 * This unregisters a CDK widget from a screen.
 */
void unregisterCDKObject (EObjectType cdktype, void *object);

/*
 * This function raises a widget on a screen to the top of the widget
 * stack of the screen the widget is associated with. The side effect
 * of doing this is the widget will be on 'top' of all the other
 * widgets on their screens.
 */
void raiseCDKObject (EObjectType cdktype, void *object);

/*
 * This function lowers a widget on a screen to the bottom of the widget
 * stack of the screen the widget is associated with. The side effect
 * of doing this is that all the other widgets will be on 'top' of the
 * widget on their screens.
 */
void lowerCDKObject (EObjectType cdktype, void *object);

/*
 * This redraws all the widgets associated with the given screen.
 */
void refreshCDKScreen (CDKSCREEN *screen);

/*
 * This calls refreshCDKScreen. (it is here to try to be consistent
 * with the drawCDKXXX functions asscoicated with the widgets)
 */
void drawCDKScreen (CDKSCREEN *screen);

/*
 * This removes all the widgets from the screen.
 */
void eraseCDKScreen (CDKSCREEN *screen);

/*
 * This frees up any memory the CDKSCREEN pointer used.
 */
void destroyCDKScreen (CDKSCREEN *screen);

/*
 * This shuts down curses and everything else needed to
 * exit cleanly.
 */
void endCDK();

/*
 * This creates all the color pairs.
 */
void initCDKColor();
#endif