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.
138 · The parameters xpos and ypos are the new position of the wid‐
140 get.
141 The parameter xpos may be an integer or one of the pre-defined
143 values TOP, BOTTOM, and CENTER.
144 The parameter ypos may be an integer or one of the pre-defined
146 values LEFT, RIGHT, and CENTER.
147 · The parameter relative states whether the xpos/ypos pair is a
149 relative move or an absolute move.
150 For example, if xpos = 1 and ypos = 2 and relative = TRUE,
152 then the widget would move one row down and two columns right.
153 If the value of relative was FALSE, then the widget would move
154 to the position (1,2).
155 Do not use the values TOP, BOTTOM, LEFT, RIGHT, or CENTER when
157 relative = TRUE. (weird things may happen).
158 · The final parameter refresh is a boolean value which states
160 whether the widget will get refreshed after the move.
161 newCDKLabel
163 creates a label widget and returns a pointer to it. Parameters:
164 screen
166 is the screen you wish this widget to be placed in.
167 xpos controls the placement of the object along the horizontal
169 axis. It may be an integer or one of the pre-defined values
170 LEFT, RIGHT, and CENTER.
171 ypos controls the placement of the object along the vertical axis.
173 It may be an integer or one of the pre-defined values TOP,
174 BOTTOM, and CENTER.
175 message
177 is the message to be displayed in the window. It may contain
178 any of the standard Cdk display format commands. To learn
179 more about this see cdk_display [4m(3).
180 rows is the number of message rows that were passed in the message
182 parameter.
183 box is true if widget should be drawn with a box around it.
185 shadow
187 turns the shadow on or off around this widget.
188 If the widget could not be created then a NULL pointer is
190 returned.
191 positionCDKLabel
193 allows the user to move the widget around the screen via the cur‐
194 sor/keypad keys. See cdk_position (3) for key bindings.
195 setCDKLabel
197 allows the user to change the contents of the label widget. The
198 parameters are the same as the newCDKLabel.
199 setCDKLabelBackgroundAttrib
201 sets the background attribute of the widget. The parameter
202 attribute is a curses attribute, e.g., A_BOLD.
203 setCDKLabelBackgroundColor
205 sets the background color of the widget. The parameter color is
206 in the format of the Cdk format strings. For more information see
207 cdk_display [4m(3).
208 setCDKLabelBox
210 sets whether the widget will be drawn with a box around it.
211 setCDKLabelBoxAttribute
213 sets the attribute of the box.
214 setCDKLabelHorizontalChar
216 sets the horizontal drawing character for the box to the given
217 character.
218 setCDKLabelLLChar
220 sets the lower left hand corner of the widget's box to the given
221 character.
222 setCDKLabelLRChar
224 sets the lower right hand corner of the widget's box to the given
225 character.
226 setCDKLabelMessage
228 This sets the contents of the label widget.
229 setCDKLabelULChar
231 sets the upper left hand corner of the widget's box to the given
232 character.
233 setCDKLabelURChar
235 sets the upper right hand corner of the widget's box to the given
236 character.
237 setCDKLabelVerticalChar
239 sets the vertical drawing character for the box to the given char‐
240 acter.
241 waitCDKLabel
243 waits for a user to press a key. The label parameter is the
244 pointer to a label widget, and key is the key to wait for. If no
245 specific key is desired, use (char)0.
246
248 cdk(3), cdk_binding(3), cdk_display(3), cdk_position(3), cdk_screen(3)
249 cdk_label(3)