CELLLINUX64/util/CELLLINUX64/man/man3/SetClassProcs.3

   1 '\"
   2 '\" Copyright (c) 2000 Ajuba Solutions.
   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: SetClassProcs.3,v 1.1 2000/11/22 01:50:26 ericm 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
 218 See 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
 225 Command-Line Name:      \\fB\\$1\\fR
 226 Database Name:  \\fB\\$2\\fR
 227 Database 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_SetClassProcs 3 8.4 Tk "Tk Library Procedures"
 246 .BS
 247 .SH NAME
 248 Tk_SetClassProcs \- register widget specific procedures
 249 .SH SYNOPSIS
 250 .nf
 251 \fB#include <tk.h>\fR
 252 .sp
 253 \fBTk_SetClassProcs\fR(\fItkwin, procs, instanceData\fR)
 254 .SH ARGUMENTS
 255 .AS Tk_ClassProc instanceData
 256 .AP Tk_Window tkwin in
 257 Token for window to modify.
 258 .AP Tk_ClassProcs *procs in
 259 Pointer to data structure containing widget specific procedures.
 260 The data structure pointed to by \fIprocs\fR must be static:
 261 Tk keeps a reference to it as long as the window exists.
 262 .AP ClientData instanceData in
 263 Arbitrary one-word value to pass to widget callbacks.
 264 .BE
 265
 266 .SH DESCRIPTION
 267 .PP
 268 \fBTk_SetClassProcs\fR is called to register a set of procedures that
 269 are used as callbacks in different places.
 270 .PP
 271 The structure pointed to by \fIprocs\fR contains the following:
 272 .CS
 273 typedef struct Tk_ClassProcs {
 274         unsigned int \fIsize\fR;
 275         Tk_ClassWorldChangedProc *\fIworldChangedProc\fR;
 276         Tk_ClassCreateProc *\fIcreateProc\fR;
 277         Tk_ClassModalProc *\fImodalProc\fR;
 278 } Tk_ClassProcs;
 279 .CE
 280 The \fIsize\fR field is used to simplify future expansion of the
 281 structure. It should always be set to (literally) \fBsizeof(Tk_ClassProcs)\fR.
 282 .PP
 283 \fIworldChangedProc\fR is invoked when the system has altered
 284 in some way that requires some reaction from the widget.  For example,
 285 when a font alias (see the \fBfont\fR manual entry) is reconfigured,
 286 widgets configured to use that font alias must update their display
 287 accordingly.  \fIworldChangedProc\fR should have arguments and results
 288 that match the type \fBTk_ClassWorldChangedProc\fR:
 289 .CS
 290 typedef void Tk_ClassWorldChangedProc(
 291         ClientData \fIinstanceData\fR);
 292 .CE
 293 The \fIinstanceData\fR parameter passed to the \fIworldChangedProc\fR
 294 will be identical to the \fIinstanceData\fR paramter passed to
 295 \fBTk_SetClassProcs\fR.
 296 .PP
 297 \fIcreateProc\fR is used to create platform-dependant windows.  It is
 298 invoked by \fBTk_MakeWindowExist\fR.  \fIcreateProc\fR should have
 299 arguments and results that match the type \fBTk_ClassCreateProc\fR:
 300 .CS
 301 typedef Window Tk_ClassCreateProc(
 302         Tk_Window \fItkwin\fR,
 303         Window \fIparent\fR,
 304         ClientData \fIinstanceData\fR);
 305 .CE
 306 The \fItkwin\fR and \fIinstanceData\fR parameters will be identical to
 307 the \fItkwin\fR and \fIinstanceData\fR parameters passed to
 308 \fBTk_SetClassProcs\fR.  The \fIparent\fR parameter will be the parent
 309 of the window to be created.  The \fIcreateProc\fR should return the
 310 created window.
 311 .PP
 312 \fImodalProc\fR is invoked after all bindings on a widget have been
 313 triggered in order to handle a modal loop.  \fImodalProc\fR should
 314 have arguments and results that match the type \fBTk_ClassModalProc\fR:
 315 .CS
 316 typedef void Tk_ClassModalProc(
 317         Tk_Window \fItkwin\fR,
 318         XEvent *\fIeventPtr\fR);
 319 .CE
 320 The \fItkwin\fR parameter to \fImodalProc\fR will be identical to the
 321 \fItkwin\fR parameter passed to \fBTk_SetClassProcs\fR.  The
 322 \fIeventPtr\fR parameter will be a pointer to an XEvent structure
 323 describing the event being processed.
 324
 325 .SH KEYWORDS
 326 callback, class