1cdk_marquee(3)             Library Functions Manual             cdk_marquee(3)
2
3
4

NAME

6       cdk_marquee - curses marquee widget
7

SYNOPSIS

9       cc [ flag ... ] file ...  -lcdk [ library ... ]
10
11       #include <cdk.h>
12
13       int activateCDKMarquee (
14                      CDKMARQUEE *marquee,
15                      const char *message,
16                      int delay,
17                      int repeat,
18                      boolean box);
19
20       void deactivateCDKMarquee (
21                      CDKMARQUEE *marquee);
22
23       void destroyCDKMarquee (
24                      CDKMARQUEE *marquee);
25
26       void drawCDKMarquee (
27                      CDKMARQUEE *marquee,
28                      boolean box);
29
30       void eraseCDKMarquee (
31                      CDKMARQUEE *marquee);
32
33       boolean getCDKMarqueeBox (
34                      CDKMENTRY *mentry);
35
36       void moveCDKMarquee (
37                      CDKMARQUEE *marquee,
38                      int xpos,
39                      int ypos,
40                      boolean relative,
41                      boolean refresh);
42
43       CDKMARQUEE *newCDKMarquee (
44                      CDKSCREEN *cdkscreen,
45                      int xpos,
46                      int ypos,
47                      int fieldWidth,
48                      boolean box,
49                      boolean shadow);
50
51       void positionCDKMarquee (
52                      CDKMARQUEE *marquee);
53
54       void setCDKMarqueeBackgroundAttrib (
55                      CDKMARQUEE *marquee,
56                      chtype attribute);
57
58       void setCDKMarqueeBackgroundColor (
59                      CDKMARQUEE *marquee,
60                      const char * color);
61
62       void setCDKMarqueeBox (
63                      CDKMENTRY *mentry,
64                      boolean boxWidget);
65
66       void setCDKMarqueeBoxAttribute (
67                      CDKMARQUEE *marquee,
68                      chtype character);
69
70       void setCDKMarqueeHorizontalChar (
71                      CDKMARQUEE *marquee,
72                      chtype character);
73
74       void setCDKMarqueeLLChar (
75                      CDKMARQUEE *marquee,
76                      chtype character);
77
78       void setCDKMarqueeLRChar (
79                      CDKMARQUEE *marquee,
80                      chtype character);
81
82       void setCDKMarqueeULChar (
83                      CDKMARQUEE *marquee,
84                      chtype character);
85
86       void setCDKMarqueeURChar (
87                      CDKMARQUEE *marquee,
88                      chtype character);
89
90       void setCDKMarqueeVerticalChar (
91                      CDKMARQUEE *marquee,
92                      chtype character);
93

DESCRIPTION

95       The  Cdk marquee widget creates a pop-up marquee window.  The following
96       functions create or manipulate the Cdk marquee widget.
97

AVAILABLE FUNCTIONS

99       activateCDKMarquee
100            activates the marquee widget.
101
102            ·   The marquee parameter is a pointer to a defined  marquee  wid‐
103                get.
104
105            ·   The delay parameter states how long to wait between movements.
106                This value is highly dependent on  each  machine  the  program
107                runs on.
108
109            ·   The  repeat  value  tells the marquee widget how many times to
110                display the given message.
111
112            ·   The box option draws the widget with or without a  box.   This
113                function  returns  -1  if the message passed is NULL, 0 other‐
114                wise.
115
116       deactivateCDKMarquee
117            deactivates the marquee widget.
118
119       destroyCDKMarquee
120            removes the widget from the screen and  frees  memory  the  object
121            used.
122
123       drawCDKMarquee
124            draws  the  marquee widget on the screen.  If the box parameter is
125            true, the widget is drawn with a box.
126
127       eraseCDKMarquee
128            removes the widget from the screen.  This  does  NOT  destroy  the
129            widget.
130
131       getCDKMarqueeBox
132            returns true if the widget will be drawn with a box around it.
133
134       moveCDKMarquee
135            moves the given widget to the given position.
136
137            ·   The  parameters xpos and ypos are the new position of the wid‐
138                get.
139
140            ·   The parameter xpos may be an integer or one of the pre-defined
141                values TOP, BOTTOM, and CENTER.
142
143            ·   The parameter ypos may be an integer or one of the pre-defined
144                values LEFT, RIGHT, and CENTER.
145
146            ·   The parameter relative states whether the xpos/ypos pair is  a
147                relative move or an absolute move.
148
149                For  example,  if  xpos  = 1 and ypos = 2 and relative = TRUE,
150                then the widget would move one row down and two columns right.
151                If the value of relative was FALSE, then the widget would move
152                to the position (1,2).
153
154                Do not use the values TOP, BOTTOM, LEFT, RIGHT, or CENTER when
155                relative = TRUE.  (weird things may happen).
156
157            ·   The  final  parameter  refresh is a boolean value which states
158                whether the widget will get refreshed after the move.
159
160       newCDKMarquee
161            creates a marquee widget and returns a pointer to it.  Parameters:
162
163            screen
164                 is the screen you wish this widget to be placed in.
165
166            xpos controls the placement of the  object  along  the  horizontal
167                 axis.   It may be an integer or one of the pre-defined values
168                 LEFT, RIGHT, and CENTER.
169
170            ypos controls the placement of the object along the vertical axis.
171                 It  may  be  an integer or one of the pre-defined values TOP,
172                 BOTTOM, and CENTER.
173
174            width
175                 controls the width of the field.  If you provide a  value  of
176                 zero  for the width, the widget uses the width of the screen.
177                 If a negative value is provided, then  the  widget  uses  the
178                 width of the screen less the value provided.
179
180            shadow
181                 turns the shadow on or off around this widget.
182
183            If  the  widget  could  not  be  created  then  a  NULL pointer is
184            returned.
185
186       positionCDKMarquee
187            allows the user to move the widget around the screen via the  cur‐
188            sor/keypad keys.  See cdk_position (3) for key bindings.
189
190       setCDKMarqueeBackgroundAttrib
191            sets  the  background  attribute  of  the  widget.   The parameter
192            attribute is a curses attribute, e.g., A_BOLD.
193
194       setCDKMarqueeBackgroundColor
195            sets the background color of the widget.  The parameter  color  is
196            in the format of the Cdk format strings.  For more information see
197            cdk_display (3).
198
199       setCDKMarqueeBox
200            sets whether the widget will be drawn with a box around it.
201
202       setCDKMarqueeBoxAttribute
203            sets the attribute of the box.
204
205       setCDKMarqueeHorizontalChar
206            sets the horizontal drawing character for the  box  to  the  given
207            character.
208
209       setCDKMarqueeLLChar
210            sets  the  lower left hand corner of the widget's box to the given
211            character.
212
213       setCDKMarqueeLRChar
214            sets the lower right hand corner of the widget's box to the  given
215            character.
216
217       setCDKMarqueeULChar
218            sets  the  upper left hand corner of the widget's box to the given
219            character.
220
221       setCDKMarqueeURChar
222            sets the upper right hand corner of the widget's box to the  given
223            character.
224
225       setCDKMarqueeVerticalChar
226            sets the vertical drawing character for the box to the given char‐
227            acter.
228

SEE ALSO

230       cdk(3), cdk_binding(3), cdk_display(3), cdk_position(3), cdk_screen(3)
231
232
233
234                                                                cdk_marquee(3)
Impressum