![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to labelon.3r CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Research Unix] / researchv10dc / 630 / man / src / p_man / man3|
Return to labelon.3r CVS log | Up to [Research Unix] / researchv10dc / 630 / man / src / p_man / man3 |
1.1 root 1: .ds ZZ DEVELOPMENT PACKAGE
2: .TH LABELON 3R "630 MTG"
3: .XE "labelon()"
4: .XE "labeloff()"
5: .XE "labelicon()"
6: .XE "labeltext()"
7: .SH NAME
8: labelon, labeloff, labelicon, labeltext \- window labeling
9: .SH SYNOPSIS
10: .B #include <dmd.h>
11: .br
12: .B #include <label.h>
13: .sp
14: .B void labelon ( )
15: .sp
16: .B void labeloff ( )
17: .sp
18: .B void labelicon (bp, pos)
19: .br
20: .B Bitmap \(**bp;
21: .br
22: .B int pos;
23: .sp
24: .B labeltext (s, n, f)
25: .br
26: .B char \(**s;
27: .br
28: .B int n;
29: .br
30: .B int f;
31: .SH DESCRIPTION
32: The
33: .I labelon
34: function puts a label at the top of the window.
35: The label area is
36: .B LABEL_HEIGHT
37: pixels high and spans the full interior width of the window.
38: The label area is automatically updated to indicate the window's current host
39: and if that host is multiplexed.
40: It also indicates if scroll lock or caps lock is active for that window
41: and if the application running in the window has requested the printer.
42: .B Drect
43: is changed to the new smaller size of the interior of the window.
44: .PP
45: The
46: .I labeloff
47: function removes the label from the window and changes
48: .B Drect
49: to the new larger size.
50: .PP
51: The
52: .I labelicon
53: function draws the given bitmap into the label.
54: The bitmap is clipped to 16 pixels high and
55: to the right edge of the label area.
56: Its leftmost edge is aligned to position \f2pos\f1.
57: Positions are 16 pixels
58: apart, starting with position 1 (L_HOST_POSITION) at the left
59: edge of the label area. The first 5 positions (1 to 5) are used
60: by the terminal for the following default information:
61: .RS 5
62: .TP 25
63: L_HOST_POSITION
64: current host connection
65: .TP 25
66: L_MUX_POSITION
67: current host environment
68: .TP 25
69: L_PRINT_POSITON
70: printer request status
71: .TP 25
72: L_SCROLL_POSITION
73: scroll lock key status
74: .TP 25
75: L_CAP_POSITION
76: caps lock key status
77: .PP
78: .RE
79: .bp
80: It is not recommended for an application to override those
81: fields with its own bitmaps. The first
82: position index that an application should use is
83: .B L_USER_POSITION
84: which guarantees non-interference with the terminal.
85: .PP
86: Clipped portions of a label bitmap are not remembered by the
87: terminal if the window is made larger.
88: .PP
89: The function
90: .I labeltext
91: displays the string \fIs\fR of \fIn\fR characters in the
92: label area of the window based on the flag \fIf\fR. The possible values for
93: f are:
94: .RS 5
95: .TP 19
96: L_LEFT
97: left justify the string from the L_USER_POSITION index position
98: .TP 19
99: L_RIGHT
100: right justify the string in the label area
101: .TP 19
102: L_CENTER
103: center the string in the full length label area
104: .PP
105: .RE
106: The font used to display the string is the terminal's \fBmedium\fR font.
107: The display mode is F_XOR; therefore,
108: .I labeltext
109: will superimpose the new string over any existing label strings.
110: If there is not enough room in the label area for all characters to fit,
111: the string will be clipped off.
112: .PP
113: When the window is reshaped, the terminal only redraws the label area
114: with the default information. Any user supplied icons and strings must
115: be redrawn by the application.
116: .PP
117: Any application that makes use of both \fIlabelicon\fR and \fIlabeltext\fR
118: should make sure that they do not write to the same positions
119: of the label area.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.