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

SEE ALSO

211       cdk(3), cdk_binding(3), cdk_display(3), cdk_position(3), cdk_screen(3)
212
213
214
215                                                                cdk_marquee(3)
Impressum