Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / man / man3 / Tk_CanvasTextInfo.3
CommitLineData
920dae64
AT
1'\"
2'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
3'\"
4'\" See the file "license.terms" for information on usage and redistribution
5'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
6'\"
7'\" RCS: @(#) $Id: CanvTxtInfo.3,v 1.2 1998/09/14 18:22:46 stanton Exp $
8'\"
9'\" The definitions below are for supplemental macros used in Tcl/Tk
10'\" manual entries.
11'\"
12'\" .AP type name in/out ?indent?
13'\" Start paragraph describing an argument to a library procedure.
14'\" type is type of argument (int, etc.), in/out is either "in", "out",
15'\" or "in/out" to describe whether procedure reads or modifies arg,
16'\" and indent is equivalent to second arg of .IP (shouldn't ever be
17'\" needed; use .AS below instead)
18'\"
19'\" .AS ?type? ?name?
20'\" Give maximum sizes of arguments for setting tab stops. Type and
21'\" name are examples of largest possible arguments that will be passed
22'\" to .AP later. If args are omitted, default tab stops are used.
23'\"
24'\" .BS
25'\" Start box enclosure. From here until next .BE, everything will be
26'\" enclosed in one large box.
27'\"
28'\" .BE
29'\" End of box enclosure.
30'\"
31'\" .CS
32'\" Begin code excerpt.
33'\"
34'\" .CE
35'\" End code excerpt.
36'\"
37'\" .VS ?version? ?br?
38'\" Begin vertical sidebar, for use in marking newly-changed parts
39'\" of man pages. The first argument is ignored and used for recording
40'\" the version when the .VS was added, so that the sidebars can be
41'\" found and removed when they reach a certain age. If another argument
42'\" is present, then a line break is forced before starting the sidebar.
43'\"
44'\" .VE
45'\" End of vertical sidebar.
46'\"
47'\" .DS
48'\" Begin an indented unfilled display.
49'\"
50'\" .DE
51'\" End of indented unfilled display.
52'\"
53'\" .SO
54'\" Start of list of standard options for a Tk widget. The
55'\" options follow on successive lines, in four columns separated
56'\" by tabs.
57'\"
58'\" .SE
59'\" End of list of standard options for a Tk widget.
60'\"
61'\" .OP cmdName dbName dbClass
62'\" Start of description of a specific option. cmdName gives the
63'\" option's name as specified in the class command, dbName gives
64'\" the option's name in the option database, and dbClass gives
65'\" the option's class in the option database.
66'\"
67'\" .UL arg1 arg2
68'\" Print arg1 underlined, then print arg2 normally.
69'\"
70'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
71'\"
72'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
73.if t .wh -1.3i ^B
74.nr ^l \n(.l
75.ad b
76'\" # Start an argument description
77.de AP
78.ie !"\\$4"" .TP \\$4
79.el \{\
80. ie !"\\$2"" .TP \\n()Cu
81. el .TP 15
82.\}
83.ta \\n()Au \\n()Bu
84.ie !"\\$3"" \{\
85\&\\$1 \\fI\\$2\\fP (\\$3)
86.\".b
87.\}
88.el \{\
89.br
90.ie !"\\$2"" \{\
91\&\\$1 \\fI\\$2\\fP
92.\}
93.el \{\
94\&\\fI\\$1\\fP
95.\}
96.\}
97..
98'\" # define tabbing values for .AP
99.de AS
100.nr )A 10n
101.if !"\\$1"" .nr )A \\w'\\$1'u+3n
102.nr )B \\n()Au+15n
103.\"
104.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105.nr )C \\n()Bu+\\w'(in/out)'u+2n
106..
107.AS Tcl_Interp Tcl_CreateInterp in/out
108'\" # BS - start boxed text
109'\" # ^y = starting y location
110'\" # ^b = 1
111.de BS
112.br
113.mk ^y
114.nr ^b 1u
115.if n .nf
116.if n .ti 0
117.if n \l'\\n(.lu\(ul'
118.if n .fi
119..
120'\" # BE - end boxed text (draw box now)
121.de BE
122.nf
123.ti 0
124.mk ^t
125.ie n \l'\\n(^lu\(ul'
126.el \{\
127.\" Draw four-sided box normally, but don't draw top of
128.\" box if the box started on an earlier page.
129.ie !\\n(^b-1 \{\
130\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
131.\}
132.el \}\
133\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134.\}
135.\}
136.fi
137.br
138.nr ^b 0
139..
140'\" # VS - start vertical sidebar
141'\" # ^Y = starting y location
142'\" # ^v = 1 (for troff; for nroff this doesn't matter)
143.de VS
144.if !"\\$2"" .br
145.mk ^Y
146.ie n 'mc \s12\(br\s0
147.el .nr ^v 1u
148..
149'\" # VE - end of vertical sidebar
150.de VE
151.ie n 'mc
152.el \{\
153.ev 2
154.nf
155.ti 0
156.mk ^t
157\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
158.sp -1
159.fi
160.ev
161.\}
162.nr ^v 0
163..
164'\" # Special macro to handle page bottom: finish off current
165'\" # box/sidebar if in box/sidebar mode, then invoked standard
166'\" # page bottom macro.
167.de ^B
168.ev 2
169'ti 0
170'nf
171.mk ^t
172.if \\n(^b \{\
173.\" Draw three-sided box if this is the box's first page,
174.\" draw two sides but no top otherwise.
175.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
176.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177.\}
178.if \\n(^v \{\
179.nr ^x \\n(^tu+1v-\\n(^Yu
180\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
181.\}
182.bp
183'fi
184.ev
185.if \\n(^b \{\
186.mk ^y
187.nr ^b 2
188.\}
189.if \\n(^v \{\
190.mk ^Y
191.\}
192..
193'\" # DS - begin display
194.de DS
195.RS
196.nf
197.sp
198..
199'\" # DE - end display
200.de DE
201.fi
202.RE
203.sp
204..
205'\" # SO - start of list of standard options
206.de SO
207.SH "STANDARD OPTIONS"
208.LP
209.nf
210.ta 5.5c 11c
211.ft B
212..
213'\" # SE - end of list of standard options
214.de SE
215.fi
216.ft R
217.LP
218See the \\fBoptions\\fR manual entry for details on the standard options.
219..
220'\" # OP - start of full description for a single option
221.de OP
222.LP
223.nf
224.ta 4c
225Command-Line Name: \\fB\\$1\\fR
226Database Name: \\fB\\$2\\fR
227Database Class: \\fB\\$3\\fR
228.fi
229.IP
230..
231'\" # CS - begin code excerpt
232.de CS
233.RS
234.nf
235.ta .25i .5i .75i 1i
236..
237'\" # CE - end code excerpt
238.de CE
239.fi
240.RE
241..
242.de UL
243\\$1\l'|0\(ul'\\$2
244..
245.TH Tk_CanvasTextInfo 3 4.0 Tk "Tk Library Procedures"
246.BS
247.SH NAME
248Tk_CanvasTextInfo \- additional information for managing text items in canvases
249.SH SYNOPSIS
250.nf
251\fB#include <tk.h>\fR
252.sp
253Tk_CanvasTextInfo *
254\fBTk_CanvasGetTextInfo\fR(\fIcanvas\fR)
255.SH ARGUMENTS
256.AS Tk_Canvas canvas
257.AP Tk_Canvas canvas in
258A token that identifies a particular canvas widget.
259.BE
260
261.SH DESCRIPTION
262.PP
263Textual canvas items are somewhat more complicated to manage than
264other items, due to things like the selection and the input focus.
265\fBTk_CanvasGetTextInfo\fR may be invoked by a type manager
266to obtain additional information needed for items that display text.
267The return value from \fBTk_CanvasGetTextInfo\fR is a pointer to
268a structure that is shared between Tk and all the items that display
269text.
270The structure has the following form:
271.CS
272typedef struct Tk_CanvasTextInfo {
273 Tk_3DBorder \fIselBorder\fR;
274 int \fIselBorderWidth\fR;
275 XColor *\fIselFgColorPtr\fR;
276 Tk_Item *\fIselItemPtr\fR;
277 int \fIselectFirst\fR;
278 int \fIselectLast\fR;
279 Tk_Item *\fIanchorItemPtr\fR;
280 int \fIselectAnchor\fR;
281 Tk_3DBorder \fIinsertBorder\fR;
282 int \fIinsertWidth\fR;
283 int \fIinsertBorderWidth\fR;
284 Tk_Item *\fIfocusItemPtr\fR;
285 int \fIgotFocus\fR;
286 int \fIcursorOn\fR;
287} Tk_CanvasTextInfo;
288.CE
289The \fBselBorder\fR field identifies a Tk_3DBorder that should be
290used for drawing the background under selected text.
291\fIselBorderWidth\fR gives the width of the raised border around
292selected text, in pixels.
293\fIselFgColorPtr\fR points to an XColor that describes the foreground
294color to be used when drawing selected text.
295\fIselItemPtr\fR points to the item that is currently selected, or
296NULL if there is no item selected or if the canvas doesn't have the
297selection.
298\fIselectFirst\fR and \fIselectLast\fR give the indices of the first
299and last selected characters in \fIselItemPtr\fR, as returned by the
300\fIindexProc\fR for that item.
301\fIanchorItemPtr\fR points to the item that currently has the selection
302anchor; this is not necessarily the same as \fIselItemPtr\fR.
303\fIselectAnchor\fR is an index that identifies the anchor position
304within \fIanchorItemPtr\fR.
305\fIinsertBorder\fR contains a Tk_3DBorder to use when drawing the
306insertion cursor; \fIinsertWidth\fR gives the total width of the
307insertion cursor in pixels, and \fIinsertBorderWidth\fR gives the
308width of the raised border around the insertion cursor.
309\fIfocusItemPtr\fR identifies the item that currently has the input
310focus, or NULL if there is no such item.
311\fIgotFocus\fR is 1 if the canvas widget has the input focus and
3120 otherwise.
313\fIcursorOn\fR is 1 if the insertion cursor should be drawn in
314\fIfocusItemPtr\fR and 0 if it should not be drawn; this field
315is toggled on and off by Tk to make the cursor blink.
316.PP
317The structure returned by \fBTk_CanvasGetTextInfo\fR
318is shared between Tk and the type managers; typically the type manager
319calls \fBTk_CanvasGetTextInfo\fR once when an item is created and
320then saves the pointer in the item's record.
321Tk will update information in the Tk_CanvasTextInfo; for example,
322a \fBconfigure\fR widget command might change the \fIselBorder\fR
323field, or a \fBselect\fR widget command might change the \fIselectFirst\fR
324field, or Tk might change \fIcursorOn\fR in order to make the insertion
325cursor flash on and off during successive redisplays.
326.PP
327Type managers should treat all of the fields of the Tk_CanvasTextInfo
328structure as read-only, except for \fIselItemPtr\fR, \fIselectFirst\fR,
329\fIselectLast\fR, and \fIselectAnchor\fR.
330Type managers may change \fIselectFirst\fR, \fIselectLast\fR, and
331\fIselectAnchor\fR to adjust for insertions and deletions in the
332item (but only if the item is the current owner of the selection or
333anchor, as determined by \fIselItemPtr\fR or \fIanchorItemPtr\fR).
334If all of the selected text in the item is deleted, the item should
335set \fIselItemPtr\fR to NULL to indicate that there is no longer a
336selection.
337
338.SH KEYWORDS
339canvas, focus, insertion cursor, selection, selection anchor, text