util/X86LINUX64/man/man3/Tk_HWNDToWindow.3

   1 '\"
   2 '\" Copyright (c) 1998-2000 by Scriptics Corporation.
   3 '\" All rights reserved.
   4 '\"
   5 .TH Tk_HWNDToWindow 3 "" Tk "Tk Library Procedures"
   6 .\" The -*- nroff -*- definitions below are for supplemental macros used
   7 .\" in Tcl/Tk manual entries.
   8 .\"
   9 .\" .AP type name in/out ?indent?
  10 .\"     Start paragraph describing an argument to a library procedure.
  11 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  12 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  13 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  14 .\"     needed;  use .AS below instead)
  15 .\"
  16 .\" .AS ?type? ?name?
  17 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  18 .\"     name are examples of largest possible arguments that will be passed
  19 .\"     to .AP later.  If args are omitted, default tab stops are used.
  20 .\"
  21 .\" .BS
  22 .\"     Start box enclosure.  From here until next .BE, everything will be
  23 .\"     enclosed in one large box.
  24 .\"
  25 .\" .BE
  26 .\"     End of box enclosure.
  27 .\"
  28 .\" .CS
  29 .\"     Begin code excerpt.
  30 .\"
  31 .\" .CE
  32 .\"     End code excerpt.
  33 .\"
  34 .\" .VS ?version? ?br?
  35 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  36 .\"     of man pages.  The first argument is ignored and used for recording
  37 .\"     the version when the .VS was added, so that the sidebars can be
  38 .\"     found and removed when they reach a certain age.  If another argument
  39 .\"     is present, then a line break is forced before starting the sidebar.
  40 .\"
  41 .\" .VE
  42 .\"     End of vertical sidebar.
  43 .\"
  44 .\" .DS
  45 .\"     Begin an indented unfilled display.
  46 .\"
  47 .\" .DE
  48 .\"     End of indented unfilled display.
  49 .\"
  50 .\" .SO ?manpage?
  51 .\"     Start of list of standard options for a Tk widget. The manpage
  52 .\"     argument defines where to look up the standard options; if
  53 .\"     omitted, defaults to "options". The options follow on successive
  54 .\"     lines, in three columns separated by tabs.
  55 .\"
  56 .\" .SE
  57 .\"     End of list of standard options for a Tk widget.
  58 .\"
  59 .\" .OP cmdName dbName dbClass
  60 .\"     Start of description of a specific option.  cmdName gives the
  61 .\"     option's name as specified in the class command, dbName gives
  62 .\"     the option's name in the option database, and dbClass gives
  63 .\"     the option's class in the option database.
  64 .\"
  65 .\" .UL arg1 arg2
  66 .\"     Print arg1 underlined, then print arg2 normally.
  67 .\"
  68 .\" .QW arg1 ?arg2?
  69 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  70 .\"
  71 .\" .PQ arg1 ?arg2?
  72 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  73 .\"     (for trailing punctuation) and then a closing parenthesis.
  74 .\"
  75 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  76 .if t .wh -1.3i ^B
  77 .nr ^l \n(.l
  78 .ad b
  79 .\"     # Start an argument description
  80 .de AP
  81 .ie !"\\$4"" .TP \\$4
  82 .el \{\
  83 .   ie !"\\$2"" .TP \\n()Cu
  84 .   el          .TP 15
  85 .\}
  86 .ta \\n()Au \\n()Bu
  87 .ie !"\\$3"" \{\
  88 \&\\$1 \\fI\\$2\\fP (\\$3)
  89 .\".b
  90 .\}
  91 .el \{\
  92 .br
  93 .ie !"\\$2"" \{\
  94 \&\\$1  \\fI\\$2\\fP
  95 .\}
  96 .el \{\
  97 \&\\fI\\$1\\fP
  98 .\}
  99 .\}
 100 ..
 101 .\"     # define tabbing values for .AP
 102 .de AS
 103 .nr )A 10n
 104 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 105 .nr )B \\n()Au+15n
 106 .\"
 107 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 108 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 109 ..
 110 .AS Tcl_Interp Tcl_CreateInterp in/out
 111 .\"     # BS - start boxed text
 112 .\"     # ^y = starting y location
 113 .\"     # ^b = 1
 114 .de BS
 115 .br
 116 .mk ^y
 117 .nr ^b 1u
 118 .if n .nf
 119 .if n .ti 0
 120 .if n \l'\\n(.lu\(ul'
 121 .if n .fi
 122 ..
 123 .\"     # BE - end boxed text (draw box now)
 124 .de BE
 125 .nf
 126 .ti 0
 127 .mk ^t
 128 .ie n \l'\\n(^lu\(ul'
 129 .el \{\
 130 .\"     Draw four-sided box normally, but don't draw top of
 131 .\"     box if the box started on an earlier page.
 132 .ie !\\n(^b-1 \{\
 133 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 134 .\}
 135 .el \}\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .\}
 139 .fi
 140 .br
 141 .nr ^b 0
 142 ..
 143 .\"     # VS - start vertical sidebar
 144 .\"     # ^Y = starting y location
 145 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 146 .de VS
 147 .if !"\\$2"" .br
 148 .mk ^Y
 149 .ie n 'mc \s12\(br\s0
 150 .el .nr ^v 1u
 151 ..
 152 .\"     # VE - end of vertical sidebar
 153 .de VE
 154 .ie n 'mc
 155 .el \{\
 156 .ev 2
 157 .nf
 158 .ti 0
 159 .mk ^t
 160 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 161 .sp -1
 162 .fi
 163 .ev
 164 .\}
 165 .nr ^v 0
 166 ..
 167 .\"     # Special macro to handle page bottom:  finish off current
 168 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 169 .\"     # page bottom macro.
 170 .de ^B
 171 .ev 2
 172 'ti 0
 173 'nf
 174 .mk ^t
 175 .if \\n(^b \{\
 176 .\"     Draw three-sided box if this is the box's first page,
 177 .\"     draw two sides but no top otherwise.
 178 .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
 179 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 180 .\}
 181 .if \\n(^v \{\
 182 .nr ^x \\n(^tu+1v-\\n(^Yu
 183 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 184 .\}
 185 .bp
 186 'fi
 187 .ev
 188 .if \\n(^b \{\
 189 .mk ^y
 190 .nr ^b 2
 191 .\}
 192 .if \\n(^v \{\
 193 .mk ^Y
 194 .\}
 195 ..
 196 .\"     # DS - begin display
 197 .de DS
 198 .RS
 199 .nf
 200 .sp
 201 ..
 202 .\"     # DE - end display
 203 .de DE
 204 .fi
 205 .RE
 206 .sp
 207 ..
 208 .\"     # SO - start of list of standard options
 209 .de SO
 210 'ie '\\$1'' .ds So \\fBoptions\\fR
 211 'el .ds So \\fB\\$1\\fR
 212 .SH "STANDARD OPTIONS"
 213 .LP
 214 .nf
 215 .ta 5.5c 11c
 216 .ft B
 217 ..
 218 .\"     # SE - end of list of standard options
 219 .de SE
 220 .fi
 221 .ft R
 222 .LP
 223 See the \\*(So manual entry for details on the standard options.
 224 ..
 225 .\"     # OP - start of full description for a single option
 226 .de OP
 227 .LP
 228 .nf
 229 .ta 4c
 230 Command-Line Name:      \\fB\\$1\\fR
 231 Database Name:  \\fB\\$2\\fR
 232 Database Class: \\fB\\$3\\fR
 233 .fi
 234 .IP
 235 ..
 236 .\"     # CS - begin code excerpt
 237 .de CS
 238 .RS
 239 .nf
 240 .ta .25i .5i .75i 1i
 241 ..
 242 .\"     # CE - end code excerpt
 243 .de CE
 244 .fi
 245 .RE
 246 ..
 247 .\"     # UL - underline word
 248 .de UL
 249 \\$1\l'|0\(ul'\\$2
 250 ..
 251 .\"     # QW - apply quotation marks to word
 252 .de QW
 253 .ie '\\*(lq'"' ``\\$1''\\$2
 254 .\"" fix emacs highlighting
 255 .el \\*(lq\\$1\\*(rq\\$2
 256 ..
 257 .\"     # PQ - apply parens and quotation marks to word
 258 .de PQ
 259 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 260 .\"" fix emacs highlighting
 261 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 262 ..
 263 .\"     # QR - quoted range
 264 .de QR
 265 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 266 .\"" fix emacs highlighting
 267 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 268 ..
 269 .\"     # MT - "empty" string
 270 .de MT
 271 .QW ""
 272 ..
 273 .BS
 274 .SH NAME
 275 Tk_HWNDToWindow \- Find Tk's window information for a Windows window
 276 .SH SYNOPSIS
 277 .nf
 278 \fB#include <tkPlatDecls.h>\fR
 279 .sp
 280 Tk_Window
 281 \fBTk_HWNDToWindow\fR(\fIhwnd\fR)
 282 .SH ARGUMENTS
 283 .AP HWND hwnd in
 284 Windows handle for the window.
 285 .BE
 286 .SH DESCRIPTION
 287 .PP
 288 Given a Windows HWND window identifier, this procedure returns the
 289 corresponding Tk_Window handle. If there is no Tk_Window corresponding
 290 to \fIhwnd\fR then NULL is returned.
 291 .SH KEYWORDS
 292 Windows window id