Scroll to navigation

cdk_label(3) Library Functions Manual cdk_label(3)

NAME

cdk_label - Creates a managed curses label widget.

SYNOPSIS

cc [ flag ... ] file ... -lcdk [ library ... ]

#include <cdk.h>

CDKLABEL *label,
chtype unused);
CDKLABEL *label);
CDKLABEL *label,
boolean box);
CDKLABEL *label);
CDKLABEL *label);
CDKLABEL *label
int *messageLines);
CDKLABEL *label,
int xpos,
int ypos,
boolean relative,
boolean refresh);
CDKSCREEN *cdkscreen,
int xpos,
int ypos,
CDK_CONST char **message,
int messageLines,
boolean box,
boolean shadow);
CDKLABEL *label);
CDKLABEL *label,
CDK_CONST char **message,
int messageLines,
boolean box);
CDKLABEL *label,
chtype attribute);
CDKLABEL *label,
const char * color);
CDKLABEL *label,
boolean box);
CDKLABEL *label,
chtype character);
CDKLABEL *label,
chtype character);
CDKLABEL *label,
chtype character);
CDKLABEL *label,
chtype character);
CDKLABEL *label,
CDK_CONST char **message,
int messageLines);
CDKLABEL *label,
chtype character);
CDKLABEL *label,
chtype character);
CDKLABEL *label,
chtype character);
CDKLABEL *label,
char key);

DESCRIPTION

The Cdk label widget creates a pop-up label window. The following functions create or manipulate the Cdk label widget.

AVAILABLE FUNCTIONS

obsolete entrypoint which calls drawCDKLabel.
removes the widget from the screen and frees memory the object used.
draws the label widget on the screen. If the box parameter is true, the widget is drawn with a box.
removes the widget from the screen. This does NOT destroy the widget.
returns true if the widget will be drawn with a box around it.
returns the contents of the label widget. The parameter messageLines points to the location which will be given the number of message-lines.
moves the given widget to the given position.
•
The parameters xpos and ypos are the new position of the widget.
The parameter xpos may be an integer or one of the pre-defined values TOP, BOTTOM, and CENTER.
The parameter ypos may be an integer or one of the pre-defined values LEFT, RIGHT, and CENTER.
•
The parameter relative states whether the xpos/ypos pair is a relative move or an absolute move.
For example, if xpos = 1 and ypos = 2 and relative = TRUE, then the widget would move one row down and two columns right. If the value of relative was FALSE then the widget would move to the position (1,2).
Do not use the values TOP, BOTTOM, LEFT, RIGHT, or CENTER when relative = TRUE. (weird things may happen).
•
The final parameter refresh is a boolean value which states whether the widget will get refreshed after the move.
creates a label widget and returns a pointer to it. Parameters:
is the screen you wish this widget to be placed in.
controls the placement of the object along the horizontal axis. It may be an integer or one of the pre-defined values LEFT, RIGHT, and CENTER.
controls the placement of the object along the vertical axis. It may be an integer or one of the pre-defined values TOP, BOTTOM, and CENTER.
is the message to be displayed in the window. It may contain any of the standard Cdk display format commands. To learn more about this see cdk_display (3).
is the number of message rows that were passed in the message parameter.
is true if widget should be drawn with a box around it.
turns the shadow on or off around this widget.
If the widget could not be created then a NULL pointer is returned.
allows the user to move the widget around the screen via the cursor/keypad keys. See cdk_position (3) for key bindings.
allows the user to change the contents of the label widget. The parameters are the same as the newCDKLabel.
sets the background attribute of the widget. The parameter attribute is a curses attribute, e.g., A_BOLD.
sets the background color of the widget. The parameter color is in the format of the Cdk format strings. For more information see cdk_display (3).
sets whether the widget will be drawn with a box around it.
sets the attribute of the box.
sets the horizontal drawing character for the box to the given character.
sets the lower left hand corner of the widget's box to the given character.
sets the lower right hand corner of the widget's box to the given character.
This sets the contents of the label widget.
sets the upper left hand corner of the widget's box to the given character.
sets the upper right hand corner of the widget's box to the given character.
sets the vertical drawing character for the box to the given character.
waits for a user to press a key. The label parameter is the pointer to a label widget, and key is the key to wait for. If no specific key is desired, use (char)0.

SEE ALSO

cdk(3), cdk_binding(3), cdk_display(3), cdk_position(3), cdk_screen(3)