CELLLINUX64/util/CELLLINUX64/man/mann/tile.n

   1 '\"
   2 '\" Copyright 1991-1997 by Bell Labs Innovations for Lucent Technologies.
   3 '\"
   4 '\" Permission to use, copy, modify, and distribute this software and its
   5 '\" documentation for any purpose and without fee is hereby granted, provided
   6 '\" that the above copyright notice appear in all copies and that both that the
   7 '\" copyright notice and warranty disclaimer appear in supporting documentation,
   8 '\" and that the names of Lucent Technologies any of their entities not be used
   9 '\" in advertising or publicity pertaining to distribution of the software
  10 '\" without specific, written prior permission.
  11 '\"
  12 '\" Lucent Technologies disclaims all warranties with regard to this software,
  13 '\" including all implied warranties of merchantability and fitness.  In no event
  14 '\" shall Lucent Technologies be liable for any special, indirect or
  15 '\" consequential damages or any damages whatsoever resulting from loss of use,
  16 '\" data or profits, whether in an action of contract, negligence or other
  17 '\" tortuous action, arising out of or in connection with the use or performance
  18 '\" of this software.
  19 '\"
  20 '\" Tile command created by George Howlett.
  21 '\"
  22 '\" The definitions below are for supplemental macros used in Tcl/Tk
  23 '\" manual entries.
  24 '\"
  25 '\" .AP type name in/out ?indent?
  26 '\"     Start paragraph describing an argument to a library procedure.
  27 '\"     type is type of argument (int, etc.), in/out is either "in", "out",
  28 '\"     or "in/out" to describe whether procedure reads or modifies arg,
  29 '\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  30 '\"     needed;  use .AS below instead)
  31 '\"
  32 '\" .AS ?type? ?name?
  33 '\"     Give maximum sizes of arguments for setting tab stops.  Type and
  34 '\"     name are examples of largest possible arguments that will be passed
  35 '\"     to .AP later.  If args are omitted, default tab stops are used.
  36 '\"
  37 '\" .BS
  38 '\"     Start box enclosure.  From here until next .BE, everything will be
  39 '\"     enclosed in one large box.
  40 '\"
  41 '\" .BE
  42 '\"     End of box enclosure.
  43 '\"
  44 '\" .CS
  45 '\"     Begin code excerpt.
  46 '\"
  47 '\" .CE
  48 '\"     End code excerpt.
  49 '\"
  50 '\" .VS ?version? ?br?
  51 '\"     Begin vertical sidebar, for use in marking newly-changed parts
  52 '\"     of man pages.  The first argument is ignored and used for recording
  53 '\"     the version when the .VS was added, so that the sidebars can be
  54 '\"     found and removed when they reach a certain age.  If another argument
  55 '\"     is present, then a line break is forced before starting the sidebar.
  56 '\"
  57 '\" .VE
  58 '\"     End of vertical sidebar.
  59 '\"
  60 '\" .DS
  61 '\"     Begin an indented unfilled display.
  62 '\"
  63 '\" .DE
  64 '\"     End of indented unfilled display.
  65 '\"
  66 '\" .SO
  67 '\"     Start of list of standard options for a Tk widget.  The
  68 '\"     options follow on successive lines, in four columns separated
  69 '\"     by tabs.
  70 '\"
  71 '\" .SE
  72 '\"     End of list of standard options for a Tk widget.
  73 '\"
  74 '\" .OP cmdName dbName dbClass
  75 '\"     Start of description of a specific option.  cmdName gives the
  76 '\"     option's name as specified in the class command, dbName gives
  77 '\"     the option's name in the option database, and dbClass gives
  78 '\"     the option's class in the option database.
  79 '\"
  80 '\" .UL arg1 arg2
  81 '\"     Print arg1 underlined, then print arg2 normally.
  82 '\"
  83 '\" RCS: @(#) $Id: man.macros,v 1.3 2001/02/17 07:46:19 ghowlett Exp $
  84 '\"
  85 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  86 .if t .wh -1.3i ^B
  87 .nr ^l \n(.l
  88 .ad b
  89 '\"     # Start an argument description
  90 .de AP
  91 .ie !"\\$4"" .TP \\$4
  92 .el \{\
  93 .   ie !"\\$2"" .TP \\n()Cu
  94 .   el          .TP 15
  95 .\}
  96 .ta \\n()Au \\n()Bu
  97 .ie !"\\$3"" \{\
  98 \&\\$1  \\fI\\$2\\fP    (\\$3)
  99 .\".b
 100 .\}
 101 .el \{\
 102 .br
 103 .ie !"\\$2"" \{\
 104 \&\\$1  \\fI\\$2\\fP
 105 .\}
 106 .el \{\
 107 \&\\fI\\$1\\fP
 108 .\}
 109 .\}
 110 ..
 111 '\"     # define tabbing values for .AP
 112 .de AS
 113 .nr )A 10n
 114 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 115 .nr )B \\n()Au+15n
 116 .\"
 117 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 118 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 119 ..
 120 .AS Tcl_Interp Tcl_CreateInterp in/out
 121 '\"     # BS - start boxed text
 122 '\"     # ^y = starting y location
 123 '\"     # ^b = 1
 124 .de BS
 125 .br
 126 .mk ^y
 127 .nr ^b 1u
 128 .if n .nf
 129 .if n .ti 0
 130 .if n \l'\\n(.lu\(ul'
 131 .if n .fi
 132 ..
 133 '\"     # BE - end boxed text (draw box now)
 134 .de BE
 135 .nf
 136 .ti 0
 137 .mk ^t
 138 .ie n \l'\\n(^lu\(ul'
 139 .el \{\
 140 .\"     Draw four-sided box normally, but don't draw top of
 141 .\"     box if the box started on an earlier page.
 142 .ie !\\n(^b-1 \{\
 143 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 144 .\}
 145 .el \}\
 146 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 147 .\}
 148 .\}
 149 .fi
 150 .br
 151 .nr ^b 0
 152 ..
 153 '\"     # VS - start vertical sidebar
 154 '\"     # ^Y = starting y location
 155 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 156 .de VS
 157 .if !"\\$2"" .br
 158 .mk ^Y
 159 .ie n 'mc \s12\(br\s0
 160 .el .nr ^v 1u
 161 ..
 162 '\"     # VE - end of vertical sidebar
 163 .de VE
 164 .ie n 'mc
 165 .el \{\
 166 .ev 2
 167 .nf
 168 .ti 0
 169 .mk ^t
 170 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 171 .sp -1
 172 .fi
 173 .ev
 174 .\}
 175 .nr ^v 0
 176 ..
 177 '\"     # Special macro to handle page bottom:  finish off current
 178 '\"     # box/sidebar if in box/sidebar mode, then invoked standard
 179 '\"     # page bottom macro.
 180 .de ^B
 181 .ev 2
 182 'ti 0
 183 'nf
 184 .mk ^t
 185 .if \\n(^b \{\
 186 .\"     Draw three-sided box if this is the box's first page,
 187 .\"     draw two sides but no top otherwise.
 188 .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
 189 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 190 .\}
 191 .if \\n(^v \{\
 192 .nr ^x \\n(^tu+1v-\\n(^Yu
 193 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 194 .\}
 195 .bp
 196 'fi
 197 .ev
 198 .if \\n(^b \{\
 199 .mk ^y
 200 .nr ^b 2
 201 .\}
 202 .if \\n(^v \{\
 203 .mk ^Y
 204 .\}
 205 ..
 206 '\"     # DS - begin display
 207 .de DS
 208 .RS
 209 .nf
 210 .sp
 211 ..
 212 '\"     # DE - end display
 213 .de DE
 214 .fi
 215 .RE
 216 .sp
 217 ..
 218 '\"     # SO - start of list of standard options
 219 .de SO
 220 .SH "STANDARD OPTIONS"
 221 .LP
 222 .nf
 223 .ta 4c 8c 12c
 224 .ft B
 225 ..
 226 '\"     # SE - end of list of standard options
 227 .de SE
 228 .fi
 229 .ft R
 230 .LP
 231 See the \\fBoptions\\fR manual entry for details on the standard options.
 232 ..
 233 '\"     # OP - start of full description for a single option
 234 .de OP
 235 .LP
 236 .nf
 237 .ta 4c
 238 Command-Line Name:      \\fB\\$1\\fR
 239 Database Name:  \\fB\\$2\\fR
 240 Database Class: \\fB\\$3\\fR
 241 .fi
 242 .IP
 243 ..
 244 '\"     # CS - begin code excerpt
 245 .de CS
 246 .RS
 247 .nf
 248 .ta .25i .5i .75i 1i
 249 .ft CW
 250 .sp
 251 ..
 252 '\"     # CE - end code excerpt
 253 .de CE
 254 .fi
 255 .RE
 256 .ft R
 257 .sp
 258 ..
 259 .de UL
 260 \\$1\l'|0\(ul'\\$2
 261 ..
 262 .TH tile n 2.4 BLT "BLT Built-In Commands"
 263 .BS
 264 '\" Note:  do not modify the .SH NAME line immediately below!
 265 .SH NAME
 266 tile \-  Tiling versions of Tk widgets
 267 .SH SYNOPSIS
 268 .sp
 269 \fBtile::button \fIpathName\fR \fIoption value\fR...
 270 .sp
 271 \fBtile::checkbutton \fIpathName\fR \fIoption value\fR...
 272 .sp
 273 \fBtile::frame \fIpathName\fR \fIoption value\fR...
 274 .sp
 275 \fBtile::label \fIpathName\fR \fIoption value\fR...
 276 .sp
 277 \fBtile::radiobutton \fIpathName\fR \fIoption value\fR...
 278 .sp
 279 \fBtile::scrollbar \fIpathName\fR \fIoption value\fR...
 280 .sp
 281 \fBtile::toplevel \fIpathName\fR \fIoption value\fR...
 282 .sp
 283 .BE
 284 .SH DESCRIPTION
 285 The tile widgets let you create textured backgrounds.  The texture is
 286 a Tk image which is tiled over the entire background of the widget.
 287 .SH INTRODUCTION
 288 With the advent of Tk 4.0, images are now easy to create and use in
 289 applications.  Images add interest to applications and they convey
 290 more information.  But one area where Tk hasn't taken advantage of
 291 images is using images as textures for widgets.  Since tiling is a
 292 standard feature of windowing systems, it's very easy to use images
 293 as textures.
 294 .PP
 295 The tile widgets take the standard Tk 4.0 widgets and add tiling
 296 configuration options to them.  Textures are specified by the name
 297 of the image you wish to be tiled across the background of the widget.
 298 .SH EXAMPLE
 299 To add tiling to a widget, you simply create an image using
 300 Tk's \fBimage\fR command and use the image name as the value for
 301 the \fB\-tile\fR configuration option of the widget.
 302 .CS
 303 image create photo my_texture -file tan_paper.gif
 304 blt::tile::frame .f -tile my_texture
 305 .CE
 306 The image \f(CWmy_texture\fR is added to the frame.
 307 If \f(CWmy_texture\fR is updated, so will the widget background.
 308 .CS
 309 image create photo my_texture -file rain.gif
 310 .CE
 311 The tile widget commands reside in the "blt::tile" namespace, so
 312 as not to collide with the normal Tk widgets.
 313 An easy way to add tiling to existing programs is to import
 314 the tile widget commands into the global namespace.
 315 .CS
 316 image create photo my_texture -file tan_paper.gif
 317 namespace import -force blt::tile::*
 318 frame .f -tile my_texture
 319 .CE
 320 To use one image for all texturing, you can use the "Tile" option
 321 class name to specify the same image for all tile widgets.
 322 .CS
 323 image create photo my_texture -file tan_paper.gif
 324 option add *Tile my_texture
 325 .CE
 326 .SH OPTIONS
 327 The following configurations options are added to the widgets. If
 328 a \fB\-tile\fB or \fB\-activetile\fR option is specified, it overrides
 329 the background color of the widget.
 330 .TP
 331 \fB\-activetile \fIimage\fR
 332 Specifies a textured background to display when the widget is active.
 333 This option is available for the \fBtilebutton\fR,
 334 \fBtilecheckbutton\fR, \fBtileradiobutton\fR, and \fBtilescrollbar\fR
 335 widgets.  \fIImage\fR is the name an image created using Tk's
 336 \fBimage\fR command.  The background of the widget is tiled with
 337 \fIimage\fR.  If \fIimage\fR is \f(CW""\fR, then the active background
 338 color is displayed.  The default is \f(CW""\fR.
 339 .TP
 340 \fB\-tile \fIimage\fR
 341 Specifies a textured background to display for the widget.
 342 \fIImage\fR is the name an image created using Tk's \fBimage\fR
 343 command.  The background of the widget is tiled with \fIimage\fR.  If
 344 \fIimage\fR is \f(CW""\fR, then the normal background color is
 345 displayed.  The default is \f(CW""\fR.
 346 .SH KEYWORDS
 347 tile, texture, button, label, radiobutton, checkbutton, scrollbar, frame, toplevel