1cdk_label(3) Library Functions Manual cdk_label(3)
2
6 cdk_label - Creates a managed curses label widget.
7
9 cc [ flag ... ] file ... -lcdk [ library ... ]
10 #include <cdk.h>
12 void activateCDKLabel (
14 CDKLABEL *label,
15 chtype unused);
16 void destroyCDKLabel (
18 CDKLABEL *label);
19 void drawCDKLabel (
21 CDKLABEL *label,
22 boolean box);
23 void eraseCDKLabel (
25 CDKLABEL *label);
26 boolean getCDKLabelBox (
28 CDKLABEL *label);
29 chtype **getCDKLabelMessage (
31 CDKLABEL *label
32 int *messageLines);
33 void moveCDKLabel (
35 CDKLABEL *label,
36 int xpos,
37 int ypos,
38 boolean relative,
39 boolean refresh);
40 CDKLABEL *newCDKLabel (
42 CDKSCREEN *cdkscreen,
43 int xpos,
44 int ypos,
45 CDK_CONST char **message,
46 int messageLines,
47 boolean box,
48 boolean shadow);
49 void positionCDKLabel (
51 CDKLABEL *label);
52 void setCDKLabel (
54 CDKLABEL *label,
55 CDK_CONST char **message,
56 int messageLines,
57 boolean box);
58 void setCDKLabelBackgroundAttrib (
60 CDKLABEL *label,
61 chtype attribute);
62 void setCDKLabelBackgroundColor (
64 CDKLABEL *label,
65 const char * color);
66 void setCDKLabelBox (
68 CDKLABEL *label,
69 boolean box);
70 void setCDKLabelBoxAttribute (
72 CDKLABEL *label,
73 chtype character);
74 void setCDKLabelHorizontalChar (
76 CDKLABEL *label,
77 chtype character);
78 void setCDKLabelLLChar (
80 CDKLABEL *label,
81 chtype character);
82 void setCDKLabelLRChar (
84 CDKLABEL *label,
85 chtype character);
86 void setCDKLabelMessage (
88 CDKLABEL *label,
89 CDK_CONST char **message,
90 int messageLines);
91 void setCDKLabelULChar (
93 CDKLABEL *label,
94 chtype character);
95 void setCDKLabelURChar (
97 CDKLABEL *label,
98 chtype character);
99 void setCDKLabelVerticalChar (
101 CDKLABEL *label,
102 chtype character);
103 char waitCDKLabel (
105 CDKLABEL *label,
106 char key);
107
109 The Cdk label widget creates a pop-up label window. The following
110 functions create or manipulate the Cdk label widget.
111
113 activateCDKLabel
114 obsolete entrypoint which calls drawCDKLabel.
115 destroyCDKLabel
117 removes the widget from the screen and frees memory the object
118 used.
119 drawCDKLabel
121 draws the label widget on the screen. If the box parameter is
122 true, the widget is drawn with a box.
123 eraseCDKLabel
125 removes the widget from the screen. This does NOT destroy the
126 widget.
127 getCDKLabelBox
129 returns true if the widget will be drawn with a box around it.
130 getCDKLabelMessage
132 returns the contents of the label widget. The parameter message‐
133 Lines points to the location which will be given the number of
134 message-lines.
135 moveCDKLabel
137 moves the given widget to the given position. The parameters xpos
138 and ypos are the new position of the widget. The parameter xpos
139 may be an integer or one of the pre-defined values TOP, BOTTOM,
140 and CENTER. The parameter ypos may be an integer or one of the
141 pre-defined values LEFT, RIGHT, and CENTER. The parameter rela‐
142 tive states whether the xpos/ypos pair is a relative move or an
143 absolute move. For example, if xpos = 1 and ypos = 2 and relative
144 = TRUE, then the widget would move one row down and two columns
145 right. If the value of relative was FALSE then the widget would
146 move to the position (1,2). Do not use the values TOP, BOTTOM,
147 LEFT, RIGHT, or CENTER when relative = TRUE. (weird things may
148 happen). The final parameter refresh is a boolean value which
149 states whether the widget will get refreshed after the move.
150 newCDKLabel
152 creates a label widget and returns a pointer to it. Parameters:
153 screen
155 is the screen you wish this widget to be placed in.
156 xpos controls the placement of the object along the horizontal
158 axis. It may be an integer or one of the pre-defined values
159 LEFT, RIGHT, and CENTER.
160 ypos controls the placement of the object along the vertical axis.
162 It may be an integer or one of the pre-defined values TOP,
163 BOTTOM, and CENTER.
164 message
166 is the message to be displayed in the window. It may contain
167 any of the standard Cdk display format commands. To learn
168 more about this see cdk_display [4m(3).
169 rows is the number of message rows that were passed in the message
171 parameter.
172 box is true if widget should be drawn with a box around it.
174 shadow
176 turns the shadow on or off around this widget.
177 If the widget could not be created then a NULL pointer is
179 returned.
180 positionCDKLabel
182 allows the user to move the widget around the screen via the cur‐
183 sor/keypad keys. See cdk_position (3) for key bindings.
184 setCDKLabel
186 allows the user to change the contents of the label widget. The
187 parameters are the same as the newCDKLabel.
188 setCDKLabelBackgroundAttrib
190 sets the background attribute of the widget. The parameter
191 attribute is a curses attribute, e.g., A_BOLD.
192 setCDKLabelBackgroundColor
194 sets the background color of the widget. The parameter color is
195 in the format of the Cdk format strings. For more information see
196 cdk_display [4m(3).
197 setCDKLabelBox
199 sets whether the widget will be drawn with a box around it.
200 setCDKLabelBoxAttribute
202 sets the attribute of the box.
203 setCDKLabelHorizontalChar
205 sets the horizontal drawing character for the box to the given
206 character.
207 setCDKLabelLLChar
209 sets the lower left hand corner of the widget's box to the given
210 character.
211 setCDKLabelLRChar
213 sets the lower right hand corner of the widget's box to the given
214 character.
215 setCDKLabelMessage
217 This sets the contents of the label widget.
218 setCDKLabelULChar
220 sets the upper left hand corner of the widget's box to the given
221 character.
222 setCDKLabelURChar
224 sets the upper right hand corner of the widget's box to the given
225 character.
226 setCDKLabelVerticalChar
228 sets the vertical drawing character for the box to the given char‐
229 acter.
230 waitCDKLabel
232 waits for a user to press a key. The label parameter is the
233 pointer to a label widget, and key is the key to wait for. If no
234 specific key is desired, use (char)0.
235
237 cdk(3), cdk_binding(3), cdk_display(3), cdk_position(3), cdk_screen(3)
238 cdk_label(3)