man/man3/GetVisual.3 - toolchains/skids - Git at Google

 '\"
 '\" Copyright (c) 1994 The Regents of the University of California.
 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
 '\"
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\"
 '\" RCS: @(#) $Id: GetVisual.3,v 1.3 2002/08/05 04:30:38 dgp Exp $
 '\"
 '\" The definitions below are for supplemental macros used in Tcl/Tk
 '\" manual entries.
 '\"
 '\" .AP type name in/out ?indent?
 '\"	Start paragraph describing an argument to a library procedure.
 '\"	type is type of argument (int, etc.), in/out is either "in", "out",
 '\"	or "in/out" to describe whether procedure reads or modifies arg,
 '\"	and indent is equivalent to second arg of .IP (shouldn't ever be
 '\"	needed;  use .AS below instead)
 '\"
 '\" .AS ?type? ?name?
 '\"	Give maximum sizes of arguments for setting tab stops.  Type and
 '\"	name are examples of largest possible arguments that will be passed
 '\"	to .AP later.  If args are omitted, default tab stops are used.
 '\"
 '\" .BS
 '\"	Start box enclosure.  From here until next .BE, everything will be
 '\"	enclosed in one large box.
 '\"
 '\" .BE
 '\"	End of box enclosure.
 '\"
 '\" .CS
 '\"	Begin code excerpt.
 '\"
 '\" .CE
 '\"	End code excerpt.
 '\"
 '\" .VS ?version? ?br?
 '\"	Begin vertical sidebar, for use in marking newly-changed parts
 '\"	of man pages.  The first argument is ignored and used for recording
 '\"	the version when the .VS was added, so that the sidebars can be
 '\"	found and removed when they reach a certain age.  If another argument
 '\"	is present, then a line break is forced before starting the sidebar.
 '\"
 '\" .VE
 '\"	End of vertical sidebar.
 '\"
 '\" .DS
 '\"	Begin an indented unfilled display.
 '\"
 '\" .DE
 '\"	End of indented unfilled display.
 '\"
 '\" .SO
 '\"	Start of list of standard options for a Tk widget.  The
 '\"	options follow on successive lines, in four columns separated
 '\"	by tabs.
 '\"
 '\" .SE
 '\"	End of list of standard options for a Tk widget.
 '\"
 '\" .OP cmdName dbName dbClass
 '\"	Start of description of a specific option.  cmdName gives the
 '\"	option's name as specified in the class command, dbName gives
 '\"	the option's name in the option database, and dbClass gives
 '\"	the option's class in the option database.
 '\"
 '\" .UL arg1 arg2
 '\"	Print arg1 underlined, then print arg2 normally.
 '\"
 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
 '\"
 '\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
 .if t .wh -1.3i ^B
 .nr ^l \n(.l
 .ad b
 '\"	# Start an argument description
 .de AP
 .ie !"\\$4"" .TP \\$4
 .el \{\
 .   ie !"\\$2"" .TP \\n()Cu
 .   el          .TP 15
 .\}
 .ta \\n()Au \\n()Bu
 .ie !"\\$3"" \{\
 \&\\$1	\\fI\\$2\\fP	(\\$3)
 .\".b
 .\}
 .el \{\
 .br
 .ie !"\\$2"" \{\
 \&\\$1	\\fI\\$2\\fP
 .\}
 .el \{\
 \&\\fI\\$1\\fP
 .\}
 .\}
 ..
 '\"	# define tabbing values for .AP
 .de AS
 .nr )A 10n
 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 .nr )B \\n()Au+15n
 .\"
 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 ..
 .AS Tcl_Interp Tcl_CreateInterp in/out
 '\"	# BS - start boxed text
 '\"	# ^y = starting y location
 '\"	# ^b = 1
 .de BS
 .br
 .mk ^y
 .nr ^b 1u
 .if n .nf
 .if n .ti 0
 .if n \l'\\n(.lu\(ul'
 .if n .fi
 ..
 '\"	# BE - end boxed text (draw box now)
 .de BE
 .nf
 .ti 0
 .mk ^t
 .ie n \l'\\n(^lu\(ul'
 .el \{\
 .\"	Draw four-sided box normally, but don't draw top of
 .\"	box if the box started on an earlier page.
 .ie !\\n(^b-1 \{\
 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 .\}
 .el \}\
 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 .\}
 .\}
 .fi
 .br
 .nr ^b 0
 ..
 '\"	# VS - start vertical sidebar
 '\"	# ^Y = starting y location
 '\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
 .de VS
 .if !"\\$2"" .br
 .mk ^Y
 .ie n 'mc \s12\(br\s0
 .el .nr ^v 1u
 ..
 '\"	# VE - end of vertical sidebar
 .de VE
 .ie n 'mc
 .el \{\
 .ev 2
 .nf
 .ti 0
 .mk ^t
 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 .sp -1
 .fi
 .ev
 .\}
 .nr ^v 0
 ..
 '\"	# Special macro to handle page bottom:  finish off current
 '\"	# box/sidebar if in box/sidebar mode, then invoked standard
 '\"	# page bottom macro.
 .de ^B
 .ev 2
 'ti 0
 'nf
 .mk ^t
 .if \\n(^b \{\
 .\"	Draw three-sided box if this is the box's first page,
 .\"	draw two sides but no top otherwise.
 .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
 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 .\}
 .if \\n(^v \{\
 .nr ^x \\n(^tu+1v-\\n(^Yu
 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 .\}
 .bp
 'fi
 .ev
 .if \\n(^b \{\
 .mk ^y
 .nr ^b 2
 .\}
 .if \\n(^v \{\
 .mk ^Y
 .\}
 ..
 '\"	# DS - begin display
 .de DS
 .RS
 .nf
 .sp
 ..
 '\"	# DE - end display
 .de DE
 .fi
 .RE
 .sp
 ..
 '\"	# SO - start of list of standard options
 .de SO
 .SH "STANDARD OPTIONS"
 .LP
 .nf
 .ta 5.5c 11c
 .ft B
 ..
 '\"	# SE - end of list of standard options
 .de SE
 .fi
 .ft R
 .LP
 See the \\fBoptions\\fR manual entry for details on the standard options.
 ..
 '\"	# OP - start of full description for a single option
 .de OP
 .LP
 .nf
 .ta 4c
 Command-Line Name:	\\fB\\$1\\fR
 Database Name:	\\fB\\$2\\fR
 Database Class:	\\fB\\$3\\fR
 .fi
 .IP
 ..
 '\"	# CS - begin code excerpt
 .de CS
 .RS
 .nf
 .ta .25i .5i .75i 1i
 ..
 '\"	# CE - end code excerpt
 .de CE
 .fi
 .RE
 ..
 .de UL
 \\$1\l'|0\(ul'\\$2
 ..
 .TH Tk_GetVisual 3 4.0 Tk "Tk Library Procedures"
 .BS
 .SH NAME
 Tk_GetVisual \- translate from string to visual
 .SH SYNOPSIS
 .nf
 \fB#include <tk.h>\fR
 .sp
 Visual *
 \fBTk_GetVisual(\fIinterp, tkwin, string, depthPtr, colormapPtr\fB)\fR
 .SH ARGUMENTS
 .AS "Tcl_Interp" *colormapPtr
 .AP Tcl_Interp *interp in
 Interpreter to use for error reporting.
 .AP Tk_Window tkwin in
 Token for window in which the visual will be used.
 .AP "CONST char" *string in
 String that identifies the desired visual.  See below for
 valid formats.
 .AP int *depthPtr out
 Depth of returned visual gets stored here.
 .AP Colormap *colormapPtr out
 If non-NULL then a suitable colormap for visual is found and its
 identifier is stored here.
 .BE

 .SH DESCRIPTION
 .PP
 \fBTk_GetVisual\fR takes a string description of a visual and
 finds a suitable X Visual for use in \fItkwin\fR, if there is one.
 It returns a pointer to the X Visual structure for the visual
 and stores the number of bits per pixel for it at \fI*depthPtr\fR.
 If \fIstring\fR is unrecognizable or if no suitable visual could
 be found, then NULL is returned and \fBTk_GetVisual\fR leaves
 an error message in \fIinterp->result\fR.
 If \fIcolormap\fR is non-NULL then \fBTk_GetVisual\fR
 also locates an appropriate colormap for use with the result visual
 and stores its X identifier at \fI*colormapPtr\fR.
 .PP
 The \fIstring\fR argument specifies the desired visual in one
 of the following ways:
 .TP 15
 \fIclass depth\fR
 The string consists of a class name followed by an integer depth,
 with any amount of white space (including none) in between.
 \fIclass\fR selects what sort of visual is desired and must be one of
 \fBdirectcolor\fR, \fBgrayscale\fR, \fBgreyscale\fR, \fBpseudocolor\fR,
 \fBstaticcolor\fR, \fBstaticgray\fR, \fBstaticgrey\fR, or
 \fBtruecolor\fR, or a unique abbreviation.
 \fIdepth\fR specifies how many bits per pixel are needed for the
 visual.
 If possible, \fBTk_GetVisual\fR will return a visual with this depth;
 if there is no visual of the desired depth then \fBTk_GetVisual\fR
 looks first for a visual with greater depth, then one with less
 depth.
 .TP 15
 \fBdefault\fR
 Use the default visual for \fItkwin\fR's screen.
 .TP 15
 \fIpathName\fR
 Use the visual for the window given by \fIpathName\fR.
 \fIpathName\fR must be the name of a window on the same screen
 as \fItkwin\fR.
 .TP 15
 \fInumber\fR
 Use the visual whose X identifier is \fInumber\fR.
 .TP 15
 \fBbest\fR ?\fIdepth\fR?
 Choose the ``best possible'' visual, using the following rules, in
 decreasing order of priority:
 (a) a visual that has exactly the desired depth is best, followed
 by a visual with greater depth than requested (but as little extra
 as possible), followed by a visual with less depth than requested
 (but as great a depth as possible);
 (b) if no \fIdepth\fR is specified, then the deepest available visual
 is chosen;
 (c) \fBpseudocolor\fR is better than \fBtruecolor\fR or \fBdirectcolor\fR,
 which are better than \fBstaticcolor\fR, which is better than
 \fBstaticgray\fR or \fBgrayscale\fR;
 (d) the default visual for the screen is better than any other visual.

 .SH CREDITS
 .PP
 The idea for \fBTk_GetVisual\fR, and the first implementation, came
 from Paul Mackerras.

 .SH KEYWORDS
 colormap, screen, visual
	'\"
	'\" Copyright (c) 1994 The Regents of the University of California.
	'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
	'\"
	'\" See the file "license.terms" for information on usage and redistribution
	'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
	'\"
	'\" RCS: @(#) $Id: GetVisual.3,v 1.3 2002/08/05 04:30:38 dgp Exp $
	'\"
	'\" The definitions below are for supplemental macros used in Tcl/Tk
	'\" manual entries.
	'\"
	'\" .AP type name in/out ?indent?
	'\" Start paragraph describing an argument to a library procedure.
	'\" type is type of argument (int, etc.), in/out is either "in", "out",
	'\" or "in/out" to describe whether procedure reads or modifies arg,
	'\" and indent is equivalent to second arg of .IP (shouldn't ever be
	'\" needed; use .AS below instead)
	'\"
	'\" .AS ?type? ?name?
	'\" Give maximum sizes of arguments for setting tab stops. Type and
	'\" name are examples of largest possible arguments that will be passed
	'\" to .AP later. If args are omitted, default tab stops are used.
	'\"
	'\" .BS
	'\" Start box enclosure. From here until next .BE, everything will be
	'\" enclosed in one large box.
	'\"
	'\" .BE
	'\" End of box enclosure.
	'\"
	'\" .CS
	'\" Begin code excerpt.
	'\"
	'\" .CE
	'\" End code excerpt.
	'\"
	'\" .VS ?version? ?br?
	'\" Begin vertical sidebar, for use in marking newly-changed parts
	'\" of man pages. The first argument is ignored and used for recording
	'\" the version when the .VS was added, so that the sidebars can be
	'\" found and removed when they reach a certain age. If another argument
	'\" is present, then a line break is forced before starting the sidebar.
	'\"
	'\" .VE
	'\" End of vertical sidebar.
	'\"
	'\" .DS
	'\" Begin an indented unfilled display.
	'\"
	'\" .DE
	'\" End of indented unfilled display.
	'\"
	'\" .SO
	'\" Start of list of standard options for a Tk widget. The
	'\" options follow on successive lines, in four columns separated
	'\" by tabs.
	'\"
	'\" .SE
	'\" End of list of standard options for a Tk widget.
	'\"
	'\" .OP cmdName dbName dbClass
	'\" Start of description of a specific option. cmdName gives the
	'\" option's name as specified in the class command, dbName gives
	'\" the option's name in the option database, and dbClass gives
	'\" the option's class in the option database.
	'\"
	'\" .UL arg1 arg2
	'\" Print arg1 underlined, then print arg2 normally.
	'\"
	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
	'\"
	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
	.if t .wh -1.3i ^B
	.nr ^l \n(.l
	.ad b
	'\" # Start an argument description
	.de AP
	.ie !"\\$4"" .TP \\$4
	.el \{\
	. ie !"\\$2"" .TP \\n()Cu
	. el .TP 15
	.\}
	.ta \\n()Au \\n()Bu
	.ie !"\\$3"" \{\
	\&\\$1 \\fI\\$2\\fP (\\$3)
	.\".b
	.\}
	.el \{\
	.br
	.ie !"\\$2"" \{\
	\&\\$1 \\fI\\$2\\fP
	.\}
	.el \{\
	\&\\fI\\$1\\fP
	.\}
	.\}
	..
	'\" # define tabbing values for .AP
	.de AS
	.nr )A 10n
	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
	.nr )B \\n()Au+15n
	.\"
	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
	.nr )C \\n()Bu+\\w'(in/out)'u+2n
	..
	.AS Tcl_Interp Tcl_CreateInterp in/out
	'\" # BS - start boxed text
	'\" # ^y = starting y location
	'\" # ^b = 1
	.de BS
	.br
	.mk ^y
	.nr ^b 1u
	.if n .nf
	.if n .ti 0
	.if n \l'\\n(.lu\(ul'
	.if n .fi
	..
	'\" # BE - end boxed text (draw box now)
	.de BE
	.nf
	.ti 0
	.mk ^t
	.ie n \l'\\n(^lu\(ul'
	.el \{\
	.\" Draw four-sided box normally, but don't draw top of
	.\" box if the box started on an earlier page.
	.ie !\\n(^b-1 \{\
	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
	.\}
	.el \}\
	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
	.\}
	.\}
	.fi
	.br
	.nr ^b 0
	..
	'\" # VS - start vertical sidebar
	'\" # ^Y = starting y location
	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
	.de VS
	.if !"\\$2"" .br
	.mk ^Y
	.ie n 'mc \s12\(br\s0
	.el .nr ^v 1u
	..
	'\" # VE - end of vertical sidebar
	.de VE
	.ie n 'mc
	.el \{\
	.ev 2
	.nf
	.ti 0
	.mk ^t
	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
	.sp -1
	.fi
	.ev
	.\}
	.nr ^v 0
	..
	'\" # Special macro to handle page bottom: finish off current
	'\" # box/sidebar if in box/sidebar mode, then invoked standard
	'\" # page bottom macro.
	.de ^B
	.ev 2
	'ti 0
	'nf
	.mk ^t
	.if \\n(^b \{\
	.\" Draw three-sided box if this is the box's first page,
	.\" draw two sides but no top otherwise.
	.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
	.el \h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'\|0u'\c
	.\}
	.if \\n(^v \{\
	.nr ^x \\n(^tu+1v-\\n(^Yu
	\kx\h'-\\nxu'\h'\|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'\|0u'\c
	.\}
	.bp
	'fi
	.ev
	.if \\n(^b \{\
	.mk ^y
	.nr ^b 2
	.\}
	.if \\n(^v \{\
	.mk ^Y
	.\}
	..
	'\" # DS - begin display
	.de DS
	.RS
	.nf
	.sp
	..
	'\" # DE - end display
	.de DE
	.fi
	.RE
	.sp
	..
	'\" # SO - start of list of standard options
	.de SO
	.SH "STANDARD OPTIONS"
	.LP
	.nf
	.ta 5.5c 11c
	.ft B
	..
	'\" # SE - end of list of standard options
	.de SE
	.fi
	.ft R
	.LP
	See the \\fBoptions\\fR manual entry for details on the standard options.
	..
	'\" # OP - start of full description for a single option
	.de OP
	.LP
	.nf
	.ta 4c
	Command-Line Name: \\fB\\$1\\fR
	Database Name: \\fB\\$2\\fR
	Database Class: \\fB\\$3\\fR
	.fi
	.IP
	..
	'\" # CS - begin code excerpt
	.de CS
	.RS
	.nf
	.ta .25i .5i .75i 1i
	..
	'\" # CE - end code excerpt
	.de CE
	.fi
	.RE
	..
	.de UL
	\\$1\l'\|0\(ul'\\$2
	..
	.TH Tk_GetVisual 3 4.0 Tk "Tk Library Procedures"
	.BS
	.SH NAME
	Tk_GetVisual \- translate from string to visual
	.SH SYNOPSIS
	.nf
	\fB#include <tk.h>\fR
	.sp
	Visual *
	\fBTk_GetVisual(\fIinterp, tkwin, string, depthPtr, colormapPtr\fB)\fR
	.SH ARGUMENTS
	.AS "Tcl_Interp" *colormapPtr
	.AP Tcl_Interp *interp in
	Interpreter to use for error reporting.
	.AP Tk_Window tkwin in
	Token for window in which the visual will be used.
	.AP "CONST char" *string in
	String that identifies the desired visual. See below for
	valid formats.
	.AP int *depthPtr out
	Depth of returned visual gets stored here.
	.AP Colormap *colormapPtr out
	If non-NULL then a suitable colormap for visual is found and its
	identifier is stored here.
	.BE

	.SH DESCRIPTION
	.PP
	\fBTk_GetVisual\fR takes a string description of a visual and
	finds a suitable X Visual for use in \fItkwin\fR, if there is one.
	It returns a pointer to the X Visual structure for the visual
	and stores the number of bits per pixel for it at \fI*depthPtr\fR.
	If \fIstring\fR is unrecognizable or if no suitable visual could
	be found, then NULL is returned and \fBTk_GetVisual\fR leaves
	an error message in \fIinterp->result\fR.
	If \fIcolormap\fR is non-NULL then \fBTk_GetVisual\fR
	also locates an appropriate colormap for use with the result visual
	and stores its X identifier at \fI*colormapPtr\fR.
	.PP
	The \fIstring\fR argument specifies the desired visual in one
	of the following ways:
	.TP 15
	\fIclass depth\fR
	The string consists of a class name followed by an integer depth,
	with any amount of white space (including none) in between.
	\fIclass\fR selects what sort of visual is desired and must be one of
	\fBdirectcolor\fR, \fBgrayscale\fR, \fBgreyscale\fR, \fBpseudocolor\fR,
	\fBstaticcolor\fR, \fBstaticgray\fR, \fBstaticgrey\fR, or
	\fBtruecolor\fR, or a unique abbreviation.
	\fIdepth\fR specifies how many bits per pixel are needed for the
	visual.
	If possible, \fBTk_GetVisual\fR will return a visual with this depth;
	if there is no visual of the desired depth then \fBTk_GetVisual\fR
	looks first for a visual with greater depth, then one with less
	depth.
	.TP 15
	\fBdefault\fR
	Use the default visual for \fItkwin\fR's screen.
	.TP 15
	\fIpathName\fR
	Use the visual for the window given by \fIpathName\fR.
	\fIpathName\fR must be the name of a window on the same screen
	as \fItkwin\fR.
	.TP 15
	\fInumber\fR
	Use the visual whose X identifier is \fInumber\fR.
	.TP 15
	\fBbest\fR ?\fIdepth\fR?
	Choose the ``best possible'' visual, using the following rules, in
	decreasing order of priority:
	(a) a visual that has exactly the desired depth is best, followed
	by a visual with greater depth than requested (but as little extra
	as possible), followed by a visual with less depth than requested
	(but as great a depth as possible);
	(b) if no \fIdepth\fR is specified, then the deepest available visual
	is chosen;
	(c) \fBpseudocolor\fR is better than \fBtruecolor\fR or \fBdirectcolor\fR,
	which are better than \fBstaticcolor\fR, which is better than
	\fBstaticgray\fR or \fBgrayscale\fR;
	(d) the default visual for the screen is better than any other visual.

	.SH CREDITS
	.PP
	The idea for \fBTk_GetVisual\fR, and the first implementation, came
	from Paul Mackerras.

	.SH KEYWORDS
	colormap, screen, visual