home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _15e504f5cbdf3fa1a8931f41e8e3519d < prev    next >
Text File  |  2000-03-23  |  15KB  |  292 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::place - Geometry manager for fixed or rubber-sheet placement</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Tk::place - Geometry manager for fixed or rubber-sheet placement</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#fine points">FINE POINTS</A></LI>
  26.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  27.     <LI><A HREF="#keywords">KEYWORDS</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>Tk::place - Geometry manager for fixed or rubber-sheet placement</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <P>   <EM>$widget</EM>-><STRONG>place</STRONG>?(<EM>-option</EM>=><EM>value</EM>?, <EM>-option</EM>=><EM>value</EM>, ...)?</P>
  46. <P>   <EM>$widget</EM>-><STRONG>placeForget</STRONG></P>
  47. <P>   <EM>$widget</EM>-><STRONG>placeInfo</STRONG></P>
  48. <P>   <EM>$master</EM>-><STRONG>placeSlaves</STRONG></P>
  49. <P>
  50. <HR>
  51. <H1><A NAME="description">DESCRIPTION</A></H1>
  52. <P>The placer is a geometry manager for Tk.
  53. It provides simple fixed placement of windows, where you specify
  54. the exact size and location of one window, called the <EM>slave</EM>,
  55. within another window, called the <EM>$master</EM>.
  56. The placer also provides rubber-sheet placement, where you specify the
  57. size and location of the slave in terms of the dimensions of
  58. the master, so that the slave changes size and location
  59. in response to changes in the size of the master.
  60. Lastly, the placer allows you to mix these styles of placement so
  61. that, for example, the slave has a fixed width and height but is
  62. centered inside the master.</P>
  63. <DL>
  64. <DT><STRONG><A NAME="item_place"><EM>$slave</EM>-><STRONG>place</STRONG>?(<EM>-option</EM>=><EM>value</EM>?, <EM>-option</EM>=><EM>value</EM>, ...?)?</A></STRONG><BR>
  65. <DD>
  66. The <STRONG>place</STRONG> method arranges for the placer
  67. to manage the geometry of <EM>$slave</EM>.
  68. The remaining arguments consist of one or more <EM>-option</EM>=><EM>value</EM>
  69. pairs that specify the way in which <EM>$slave</EM>'s
  70. geometry is managed.
  71. If the placer is already managing <EM>$slave</EM>, then the
  72. <EM>-option</EM>=><EM>value</EM> pairs modify the configuration for <EM>$slave</EM>.
  73. The <STRONG>place</STRONG> method returns an empty string as result.
  74. The following <EM>-option</EM>=><EM>value</EM> pairs are supported:
  75. <DL>
  76. <DT><STRONG><A NAME="item_%2Din_%3D%3E_%24master"><STRONG>-in</STRONG> => <EM>$master</EM></A></STRONG><BR>
  77. <DD>
  78. <EM>$master</EM> is the reference to the window relative
  79. to which <EM>$slave</EM> is to be placed.
  80. <EM>$master</EM> must either be <EM>$slave</EM>'s parent or a descendant
  81. of <EM>$slave</EM>'s parent.
  82. In addition, <EM>$master</EM> and <EM>$slave</EM> must both be descendants
  83. of the same top-level window.
  84. These restrictions are necessary to guarantee
  85. that <EM>$slave</EM> is visible whenever <EM>$master</EM> is visible.
  86. If this option isn't specified then the master defaults to
  87. <EM>$slave</EM>'s parent.
  88. <P></P>
  89. <DT><STRONG><A NAME="item_%2Dx_%3D%3E_location"><STRONG>-x</STRONG> => <EM>location</EM></A></STRONG><BR>
  90. <DD>
  91. <EM>Location</EM> specifies the x-coordinate within the master window
  92. of the anchor point for <EM>$slave</EM> widget.
  93. The location is specified in screen units (i.e. any of the forms
  94. accepted by <STRONG>Tk_GetPixels</STRONG>) and need not lie within the bounds
  95. of the master window.
  96. <P></P>
  97. <DT><STRONG><A NAME="item_%2Drelx_%3D%3E_location"><STRONG>-relx</STRONG> => <EM>location</EM></A></STRONG><BR>
  98. <DD>
  99. <EM>Location</EM> specifies the x-coordinate within the master window
  100. of the anchor point for <EM>$slave</EM> widget.
  101. In this case the location is specified in a relative fashion
  102. as a floating-point number:  0.0 corresponds to the left edge
  103. of the master and 1.0 corresponds to the right edge of the master.
  104. <EM>Location</EM> need not be in the range 0.0-1.0.
  105. If both <STRONG>-x</STRONG> and <STRONG>-relx</STRONG> are specified for a slave
  106. then their values are summed.  For example, ``<STRONG>-relx</STRONG>=>0.5, <STRONG>-x</STRONG>=-2''
  107. positions the left edge of the slave 2 pixels to the left of the
  108. center of its master.
  109. <P></P>
  110. <DT><STRONG><A NAME="item_%2Dy_%3D%3E_location"><STRONG>-y</STRONG> => <EM>location</EM></A></STRONG><BR>
  111. <DD>
  112. <EM>Location</EM> specifies the y-coordinate within the master window
  113. of the anchor point for <EM>$slave</EM> widget.
  114. The location is specified in screen units (i.e. any of the forms
  115. accepted by <STRONG>Tk_GetPixels</STRONG>) and need not lie within the bounds
  116. of the master window.
  117. <P></P>
  118. <DT><STRONG><A NAME="item_%2Drely_%3D%3E_location"><STRONG>-rely</STRONG> => <EM>location</EM></A></STRONG><BR>
  119. <DD>
  120. <EM>Location</EM> specifies the y-coordinate within the master window
  121. of the anchor point for <EM>$slave</EM> widget.
  122. In this case the value is specified in a relative fashion
  123. as a floating-point number:  0.0 corresponds to the top edge
  124. of the master and 1.0 corresponds to the bottom edge of the master.
  125. <EM>Location</EM> need not be in the range 0.0-1.0.
  126. If both <STRONG>-y</STRONG> and <STRONG>-rely</STRONG> are specified for a slave
  127. then their values are summed.  For example, <STRONG>-rely</STRONG>=>0.5, <STRONG>-x</STRONG>=>3
  128. positions the top edge of the slave 3 pixels below the
  129. center of its master.
  130. <P></P>
  131. <DT><STRONG><A NAME="item_%2Danchor_%3D%3E_where"><STRONG>-anchor</STRONG> => <EM>where</EM></A></STRONG><BR>
  132. <DD>
  133. <EM>Where</EM> specifies which point of <EM>$slave</EM> is to be positioned
  134. at the (x,y) location selected by the <STRONG>-x</STRONG>, <STRONG>-y</STRONG>,
  135. <STRONG>-relx</STRONG>, and <STRONG>-rely</STRONG> options.
  136. The anchor point is in terms of the outer area of <EM>$slave</EM>
  137. including its border, if any.
  138. Thus if <EM>where</EM> is <STRONG>se</STRONG> then the lower-right corner of
  139. <EM>$slave</EM>'s border will appear at the given (x,y) location
  140. in the master.
  141. The anchor position defaults to <STRONG>nw</STRONG>.
  142. <P></P>
  143. <DT><STRONG><A NAME="item_%2Dwidth_%3D%3E_size"><STRONG>-width</STRONG> => <EM>size</EM></A></STRONG><BR>
  144. <DD>
  145. <EM>Size</EM> specifies the width for <EM>$slave</EM> in screen units
  146. (i.e. any of the forms accepted by <STRONG>Tk_GetPixels</STRONG>).
  147. The width will be the outer width of <EM>$slave</EM> including its
  148. border, if any.
  149. If <EM>size</EM> is an empty string, or if no <STRONG>-width</STRONG>
  150. or <STRONG>-relwidth</STRONG> option is specified, then the width requested
  151. internally by the window will be used.
  152. <P></P>
  153. <DT><STRONG><A NAME="item_%2Drelwidth_%3D%3E_size"><STRONG>-relwidth</STRONG> => <EM>size</EM></A></STRONG><BR>
  154. <DD>
  155. <EM>Size</EM> specifies the width for <EM>$slave</EM>.
  156. In this case the width is specified as a floating-point number
  157. relative to the width of the master: 0.5 means <EM>$slave</EM> will
  158. be half as wide as the master, 1.0 means <EM>$slave</EM> will have
  159. the same width as the master, and so on.
  160. If both <STRONG>-width</STRONG> and <STRONG>-relwidth</STRONG> are specified for a slave,
  161. their values are summed.  For example, <STRONG>-relwidth</STRONG>=>1.0, <STRONG>-width</STRONG>=>5
  162. makes the slave 5 pixels wider than the master.
  163. <P></P>
  164. <DT><STRONG><A NAME="item_%2Dheight_%3D%3E_size"><STRONG>-height</STRONG> => <EM>size</EM></A></STRONG><BR>
  165. <DD>
  166. <EM>Size</EM> specifies the height for <EM>$slave</EM> in screen units
  167. (i.e. any of the forms accepted by <STRONG>Tk_GetPixels</STRONG>).
  168. The height will be the outer dimension of <EM>$slave</EM> including its
  169. border, if any.
  170. If <EM>size</EM> is an empty string, or if no <STRONG>-height</STRONG> or
  171. <STRONG>-relheight</STRONG> option is specified, then the height requested
  172. internally by the window will be used.
  173. <P></P>
  174. <DT><STRONG><A NAME="item_%2Drelheight_%3D%3E_size"><STRONG>-relheight</STRONG> => <EM>size</EM></A></STRONG><BR>
  175. <DD>
  176. <EM>Size</EM> specifies the height for <EM>$slave</EM>.
  177. In this case the height is specified as a floating-point number
  178. relative to the height of the master: 0.5 means <EM>$slave</EM> will
  179. be half as high as the master, 1.0 means <EM>$slave</EM> will have
  180. the same height as the master, and so on.
  181. If both <STRONG>-height</STRONG> and <STRONG>-relheight</STRONG> are specified for a slave,
  182. their values are summed.  For example, <STRONG>-relheight</STRONG>=>1.0, <STRONG>-height</STRONG>=>-2
  183. makes the slave 2 pixels shorter than the master.
  184. <P></P>
  185. <DT><STRONG><A NAME="item_%2Dbordermode_%3D%3E_mode"><STRONG>-bordermode</STRONG> => <EM>mode</EM></A></STRONG><BR>
  186. <DD>
  187. <EM>Mode</EM> determines the degree to which borders within the
  188. master are used in determining the placement of the slave.
  189. The default and most common value is <STRONG>inside</STRONG>.
  190. In this case the placer considers the area of the master to
  191. be the innermost area of the master, inside any border:
  192. an option of <STRONG>-x</STRONG>=><STRONG>0</STRONG> corresponds to an x-coordinate just
  193. inside the border and an option of <STRONG>-relwidth</STRONG>=>1.0
  194. means <EM>$slave</EM> will fill the area inside the master's
  195. border.
  196. If <EM>mode</EM> is <STRONG>outside</STRONG> then the placer considers
  197. the area of the master to include its border;
  198. this mode is typically used when placing <EM>$slave</EM>
  199. outside its master, as with the options
  200. <STRONG>-x</STRONG>=><STRONG>0</STRONG>, <STRONG>-y</STRONG>=><STRONG>0</STRONG>, <STRONG>-anchor</STRONG>=><STRONG>ne</STRONG>.
  201. Lastly, <EM>mode</EM> may be specified as <STRONG>ignore</STRONG>, in which
  202. case borders are ignored:  the area of the master is considered
  203. to be its official X area, which includes any internal border but
  204. no external border.  A bordermode of <STRONG>ignore</STRONG> is probably
  205. not very useful.
  206. <P>If the same value is specified separately with
  207. two different options, such as <STRONG>-x</STRONG> and <STRONG>-relx</STRONG>, then
  208. the most recent option is used and the older one is ignored.</P>
  209. <P></P></DL>
  210. <DT><STRONG><A NAME="item_placeSlaves"><EM>$slave</EM>-><STRONG>placeSlaves</STRONG></A></STRONG><BR>
  211. <DD>
  212. The <STRONG>placeSlaves</STRONG> method returns a list of all the slave
  213. windows for which <EM>$master</EM> is the master.
  214. If there are no slaves for <EM>$master</EM> then an empty list is
  215. returned.
  216. <P></P>
  217. <DT><STRONG><A NAME="item_placeForget"><EM>$slave</EM>-><STRONG>placeForget</STRONG></A></STRONG><BR>
  218. <DD>
  219. The <STRONG>placeForget</STRONG> method causes the placer to stop managing
  220. the geometry of <EM>$slave</EM>.  As a side effect of this method call
  221. <EM>$slave</EM> will be unmapped so that it doesn't appear on the
  222. screen.
  223. If <EM>$slave</EM> isn't currently managed by the placer then the
  224. method call has no effect.
  225. <STRONG>placeForget</STRONG> returns an empty string as result.
  226. <P></P>
  227. <DT><STRONG><A NAME="item_placeInfo"><EM>$slave</EM>-><STRONG>placeInfo</STRONG></A></STRONG><BR>
  228. <DD>
  229. The <STRONG>placeInfo</STRONG> method returns a list giving the current
  230. configuration of <EM>$slave</EM>.
  231. The list consists of <EM>-option</EM>=><EM>value</EM> pairs in exactly the
  232. same form as might be specified to the <STRONG>place</STRONG>
  233. method.
  234. If the configuration of a window has been retrieved with
  235. <STRONG>placeInfo</STRONG>, that configuration can be restored later by
  236. first using <STRONG>placeForget</STRONG> to erase any existing information
  237. for the window and then invoking <STRONG>place</STRONG> with
  238. the saved information.
  239. <P></P></DL>
  240. <P>
  241. <HR>
  242. <H1><A NAME="fine points">FINE POINTS</A></H1>
  243. <P>It is not necessary for the master window to be the parent
  244. of the slave window.
  245. This feature is useful in at least two situations.
  246. First, for complex window layouts it means you can create a
  247. hierarchy of subwindows whose only purpose
  248. is to assist in the layout of the parent.
  249. The ``<EM>real children</EM>'' of the parent (i.e. the windows that
  250. are significant for the application's user interface) can be
  251. children of the parent yet be placed inside the windows
  252. of the geometry-management hierarchy.
  253. This means that the path names of the ``<EM>real children</EM>''
  254. don't reflect the geometry-management hierarchy and users
  255. can specify options for the real children
  256. without being aware of the structure of the geometry-management
  257. hierarchy.</P>
  258. <P>A second reason for having a master different than the slave's
  259. parent is to tie two siblings together.
  260. For example, the placer can be used to force a window always to
  261. be positioned centered just below one of its
  262. siblings by specifying the configuration</P>
  263. <P>    <STRONG>-in</STRONG>=><EM>$sibling</EM>, <STRONG>-relx</STRONG>=>0.5, <STRONG>-rely</STRONG>=>1.0,
  264. <STRONG>-anchor</STRONG>=>'n', <STRONG>-bordermode</STRONG>=>'outside'</P>
  265. <P>Whenever the <EM>$sibling</EM> widget is repositioned in the future, the slave
  266. will be repositioned as well.</P>
  267. <P>Unlike many other geometry managers (such as the packer)
  268. the placer does not make any attempt to manipulate the geometry of
  269. the master windows or the parents of slave windows (i.e. it doesn't
  270. set their requested sizes).
  271. To control the sizes of these windows, make them windows like
  272. frames and canvases that provide configuration options for this purpose.</P>
  273. <P>
  274. <HR>
  275. <H1><A NAME="see also">SEE ALSO</A></H1>
  276. <P><A HREF="../../../site/lib/Tk/form.html">Tk::form</A>
  277. <A HREF="../../../site/lib/Tk/grid.html">Tk::grid</A>
  278. <A HREF="../../../site/lib/Tk/pack.html">Tk::pack</A></P>
  279. <P>
  280. <HR>
  281. <H1><A NAME="keywords">KEYWORDS</A></H1>
  282. <P>geometry manager, height, location, master, place, rubber sheet, slave, width</P>
  283. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  284. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  285. <STRONG><P CLASS=block> Tk::place - Geometry manager for fixed or rubber-sheet placement</P></STRONG>
  286. </TD></TR>
  287. </TABLE>
  288.  
  289. </BODY>
  290.  
  291. </HTML>
  292.