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

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::pack - Geometry manager that packs around edges of cavity</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::pack - Geometry manager that packs around edges of cavity</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="#the packer algorithm">THE PACKER ALGORITHM</A></LI>
  26.     <LI><A HREF="#expansion">EXPANSION</A></LI>
  27.     <LI><A HREF="#geometry propagation">GEOMETRY PROPAGATION</A></LI>
  28.     <LI><A HREF="#restrictions on master windows">RESTRICTIONS ON MASTER WINDOWS</A></LI>
  29.     <LI><A HREF="#packing order">PACKING ORDER</A></LI>
  30.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  31.     <LI><A HREF="#keywords">KEYWORDS</A></LI>
  32. </UL>
  33. <!-- INDEX END -->
  34.  
  35. <HR>
  36. <P>
  37. <H1><A NAME="name">NAME</A></H1>
  38. <P>Tk::pack - Geometry manager that packs around edges of cavity</P>
  39. <P>
  40. <HR>
  41. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  42. <UL>
  43. <LI>Linux</LI>
  44. <LI>Solaris</LI>
  45. <LI>Windows</LI>
  46. </UL>
  47. <HR>
  48. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  49. <P>    <EM>$widget</EM>-><STRONG>pack</STRONG>?(<EM>args</EM>)?</P>
  50. <P>    <EM>$widget</EM>-><STRONG>pack</STRONG><EM>Option</EM>?(<EM>args</EM>)?</P>
  51. <P>
  52. <HR>
  53. <H1><A NAME="description">DESCRIPTION</A></H1>
  54. <P>The <STRONG>pack</STRONG> method is used to communicate with the packer,
  55. a geometry manager that arranges the children of a parent by
  56. packing them in order around the edges of the parent.</P>
  57. <P>In this <STRONG>perl</STRONG> port of Tk it is normal to pack widgets one-at-a-time
  58. using the widget object to be packed to invoke a method call.
  59. This is a slight distortion of underlying Tk interface (which
  60. can handle lists of windows to one pack method call) but has proven
  61. effective in practice.</P>
  62. <P>The <STRONG>pack</STRONG> method can have any of several forms, depending
  63. on <EM>Option</EM>:</P>
  64. <DL>
  65. <DT><STRONG><A NAME="item_pack"><EM>$slave</EM>-><STRONG>pack</STRONG>?(<EM>options</EM>)?</A></STRONG><BR>
  66. <DD>
  67. The options consist of pairs of arguments that specify how
  68. to manage the slave.
  69. See <A HREF="#the packer algorithm">THE PACKER ALGORITHM</A> below for details on how the options
  70. are used by the packer.
  71. The following options are supported:
  72. <DL>
  73. <DT><STRONG><A NAME="item_%2Dafter_%3D%3E_%24other"><STRONG>-after</STRONG> => <EM>$other</EM></A></STRONG><BR>
  74. <DD>
  75. <EM>$other</EM> must be another window.
  76. Use its master as the master for the slave, and insert
  77. the slave just after <EM>$other</EM> in the packing order.
  78. <P></P>
  79. <DT><STRONG><A NAME="item_%2Danchor_%3D%3E_anchor"><STRONG>-anchor</STRONG> => <EM>anchor</EM></A></STRONG><BR>
  80. <DD>
  81. <EM>Anchor</EM> must be a valid anchor position such as <STRONG>n</STRONG>
  82. or <STRONG>sw</STRONG>; it specifies where to position each slave in its
  83. parcel.
  84. Defaults to <STRONG>center</STRONG>.
  85. <P></P>
  86. <DT><STRONG><A NAME="item_%2Dbefore_%3D%3E_%24other"><STRONG>-before</STRONG> => <EM>$other</EM></A></STRONG><BR>
  87. <DD>
  88. <EM>$other</EM> must be another window.
  89. Use its master as the master for the slave, and insert
  90. the slave just before <EM>$other</EM> in the packing order.
  91. <P></P>
  92. <DT><STRONG><A NAME="item_%2Dexpand_%3D%3E_boolean"><STRONG>-expand</STRONG> => <EM>boolean</EM></A></STRONG><BR>
  93. <DD>
  94. Specifies whether the slave should be expanded to consume
  95. extra space in their master.
  96. <EM>Boolean</EM> may have any proper boolean value, such as <STRONG>1</STRONG>
  97. or <STRONG>no</STRONG>.
  98. Defaults to 0.
  99. <P></P>
  100. <DT><STRONG><A NAME="item_%2Dfill_%3D%3E_style"><STRONG>-fill</STRONG> => <EM>style</EM></A></STRONG><BR>
  101. <DD>
  102. If a slave's parcel is larger than its requested dimensions, this
  103. option may be used to stretch the slave.
  104. <EM>Style</EM> must have one of the following values:
  105. <DL>
  106. <DT><STRONG><A NAME="item_none"><STRONG>none</STRONG></A></STRONG><BR>
  107. <DD>
  108. Give the slave its requested dimensions plus any internal padding
  109. requested with <STRONG>-ipadx</STRONG> or <STRONG>-ipady</STRONG>.  This is the default.
  110. <P></P>
  111. <DT><STRONG><A NAME="item_x"><STRONG>x</STRONG></A></STRONG><BR>
  112. <DD>
  113. Stretch the slave horizontally to fill the entire width of its
  114. parcel (except leave external padding as specified by <STRONG>-padx</STRONG>).
  115. <P></P>
  116. <DT><STRONG><A NAME="item_y"><STRONG>y</STRONG></A></STRONG><BR>
  117. <DD>
  118. Stretch the slave vertically to fill the entire height of its
  119. parcel (except leave external padding as specified by <STRONG>-pady</STRONG>).
  120. <P></P>
  121. <DT><STRONG><A NAME="item_both"><STRONG>both</STRONG></A></STRONG><BR>
  122. <DD>
  123. Stretch the slave both horizontally and vertically.
  124. <P></P></DL>
  125. <DT><STRONG><A NAME="item_%2Din_%3D%3E_%24master"><STRONG>-in</STRONG> => <EM>$master</EM></A></STRONG><BR>
  126. <DD>
  127. Insert the <CODE>slave(s)</CODE> at the end of the packing order for the master
  128. window given by <EM>$master</EM>.
  129. <P></P>
  130. <DT><STRONG><A NAME="item_%2Dipadx_%3D%3E_amount"><STRONG>-ipadx</STRONG> => <EM>amount</EM></A></STRONG><BR>
  131. <DD>
  132. <EM>Amount</EM> specifies how much horizontal internal padding to
  133. leave on each side of the slave(s).
  134. <EM>Amount</EM> must be a valid screen distance, such as <STRONG>2</STRONG> or <STRONG>.5c</STRONG>.
  135. It defaults to 0.
  136. <P></P>
  137. <DT><STRONG><A NAME="item_%2Dipady_%3D%3E_amount"><STRONG>-ipady</STRONG> => <EM>amount</EM></A></STRONG><BR>
  138. <DD>
  139. <EM>Amount</EM> specifies how much vertical internal padding to
  140. leave on each side of the slave(s).
  141. <EM>Amount</EM>  defaults to 0.
  142. <P></P>
  143. <DT><STRONG><A NAME="item_%2Dpadx_%3D%3E_amount"><STRONG>-padx</STRONG> => <EM>amount</EM></A></STRONG><BR>
  144. <DD>
  145. <EM>Amount</EM> specifies how much horizontal external padding to
  146. leave on each side of the slave(s).
  147. <EM>Amount</EM> defaults to 0.
  148. <P></P>
  149. <DT><STRONG><A NAME="item_%2Dpady_%3D%3E_amount"><STRONG>-pady</STRONG> => <EM>amount</EM></A></STRONG><BR>
  150. <DD>
  151. <EM>Amount</EM> specifies how much vertical external padding to
  152. leave on each side of the slave(s).
  153. <EM>Amount</EM> defaults to 0.
  154. <P></P>
  155. <DT><STRONG><A NAME="item_%2Dside_%3D%3E_side"><STRONG>-side</STRONG> => <EM>side</EM></A></STRONG><BR>
  156. <DD>
  157. Specifies which side of the master the <CODE>slave(s)</CODE> will be packed against.
  158. Must be <STRONG>left</STRONG>, <STRONG>right</STRONG>, <STRONG>top</STRONG>, or <STRONG>bottom</STRONG>.
  159. Defaults to <STRONG>top</STRONG>.
  160. <P></P></DL>
  161. </DL>
  162. <P>If no <STRONG>-in</STRONG>, <STRONG>-after</STRONG> or <STRONG>-before</STRONG> option is specified
  163. then slave will be inserted at the end of the packing list
  164. for its parent unless it is already managed by the packer (in which
  165. case it will be left where it is).
  166. If one of these options is specified then slave will be
  167. inserted at the specified point.
  168. If the slave are already managed by the geometry manager
  169. then any unspecified options for them retain their previous values rather
  170. than receiving default values.</P>
  171. <DL>
  172. <DT><STRONG><A NAME="item_packForget"><EM>$slave</EM>-><STRONG>packForget</STRONG></A></STRONG><BR>
  173. <DD>
  174. Removes <EM>slave</EM> from the packing order for its
  175. master and unmaps its window.
  176. The slave will no longer be managed by the packer.
  177. <P></P>
  178. <DT><STRONG><A NAME="item_packInfo"><EM>$slave</EM>-><STRONG>packInfo</STRONG></A></STRONG><BR>
  179. <DD>
  180. Returns a list whose elements are the current configuration state of
  181. the slave given by <EM>$slave</EM> in the same option-value form that
  182. might be specified to <STRONG>packConfigure</STRONG>.
  183. The first two elements of the list are ``<STRONG>-in</STRONG>=><EM>$master</EM>'' where
  184. <EM>$master</EM> is the slave's master.
  185. <P></P>
  186. <DT><STRONG><A NAME="item_packPropagate"><EM>$master</EM>-><STRONG>packPropagate</STRONG>?(<EM>boolean</EM>)?</A></STRONG><BR>
  187. <DD>
  188. If <EM>boolean</EM> has a true boolean value such as <STRONG>1</STRONG> or <STRONG>on</STRONG>
  189. then propagation is enabled for <EM>$master</EM>,
  190. (see <A HREF="#geometry propagation">GEOMETRY PROPAGATION</A> below).
  191. If <EM>boolean</EM> has a false boolean value then propagation is
  192. disabled for <EM>$master</EM>.
  193. In either of these cases an empty string is returned.
  194. If <EM>boolean</EM> is omitted then the method returns <STRONG>0</STRONG> or
  195. <STRONG>1</STRONG> to indicate whether propagation is currently enabled
  196. for <EM>$master</EM>.
  197. Propagation is enabled by default.
  198. <P></P>
  199. <DT><STRONG><A NAME="item_packSlaves"><EM>$master</EM>-><STRONG>packSlaves</STRONG></A></STRONG><BR>
  200. <DD>
  201. Returns a list of all of the slaves in the packing order for <EM>$master</EM>.
  202. The order of the slaves in the list is the same as their order in
  203. the packing order.
  204. If <EM>$master</EM> has no slaves then an empty list/string is returned in
  205. array/scalar context, respectively
  206. <P></P></DL>
  207. <P>
  208. <HR>
  209. <H1><A NAME="the packer algorithm">THE PACKER ALGORITHM</A></H1>
  210. <P>For each master the packer maintains an ordered list of slaves
  211. called the <EM>packing list</EM>.
  212. The <STRONG>-in</STRONG>, <STRONG>-after</STRONG>, and <STRONG>-before</STRONG> configuration
  213. options are used to specify the master for each slave and the slave's
  214. position in the packing list.
  215. If none of these options is given for a slave then the slave
  216. is added to the end of the packing list for its parent.</P>
  217. <P>The packer arranges the slaves for a master by scanning the
  218. packing list in order.
  219. At the time it processes each slave, a rectangular area within
  220. the master is still unallocated.
  221. This area is called the <EM>cavity</EM>;  for the first slave it
  222. is the entire area of the master.</P>
  223. <P>For each slave the packer carries out the following steps:</P>
  224. <DL>
  225. <DT><STRONG><A NAME="item_%5B1%5D">[1]</A></STRONG><BR>
  226. <DD>
  227. The packer allocates a rectangular <EM>parcel</EM> for the slave
  228. along the side of the cavity given by the slave's <STRONG>-side</STRONG> option.
  229. If the side is top or bottom then the width of the parcel is
  230. the width of the cavity and its height is the requested height
  231. of the slave plus the <STRONG>-ipady</STRONG> and <STRONG>-pady</STRONG> options.
  232. For the left or right side the height of the parcel is
  233. the height of the cavity and the width is the requested width
  234. of the slave plus the <STRONG>-ipadx</STRONG> and <STRONG>-padx</STRONG> options.
  235. The parcel may be enlarged further because of the <STRONG>-expand</STRONG>
  236. option (see <A HREF="#expansion">EXPANSION</A> below)
  237. <P></P>
  238. <DT><STRONG><A NAME="item_%5B2%5D">[2]</A></STRONG><BR>
  239. <DD>
  240. The packer chooses the dimensions of the slave.
  241. The width will normally be the slave's requested width plus
  242. twice its <STRONG>-ipadx</STRONG> option and the height will normally be
  243. the slave's requested height plus twice its <STRONG>-ipady</STRONG>
  244. option.
  245. However, if the <STRONG>-fill</STRONG> option is <STRONG>x</STRONG> or <STRONG>both</STRONG>
  246. then the width of the slave is expanded to fill the width of the parcel,
  247. minus twice the <STRONG>-padx</STRONG> option.
  248. If the <STRONG>-fill</STRONG> option is <STRONG>y</STRONG> or <STRONG>both</STRONG>
  249. then the height of the slave is expanded to fill the width of the parcel,
  250. minus twice the <STRONG>-pady</STRONG> option.
  251. <P></P>
  252. <DT><STRONG><A NAME="item_%5B3%5D">[3]</A></STRONG><BR>
  253. <DD>
  254. The packer positions the slave over its parcel.
  255. If the slave is smaller than the parcel then the <STRONG>-anchor</STRONG>
  256. option determines where in the parcel the slave will be placed.
  257. If <STRONG>-padx</STRONG> or <STRONG>-pady</STRONG> is non-zero, then the given
  258. amount of external padding will always be left between the
  259. slave and the edges of the parcel.
  260. <P>Once a given slave has been packed, the area of its parcel
  261. is subtracted from the cavity, leaving a smaller rectangular
  262. cavity for the next slave.
  263. If a slave doesn't use all of its parcel, the unused space
  264. in the parcel will not be used by subsequent slaves.
  265. If the cavity should become too small to meet the needs of
  266. a slave then the slave will be given whatever space is
  267. left in the cavity.
  268. If the cavity shrinks to zero size, then all remaining slaves
  269. on the packing list will be unmapped from the screen until
  270. the master window becomes large enough to hold them again.</P>
  271. <P></P></DL>
  272. <P>
  273. <HR>
  274. <H1><A NAME="expansion">EXPANSION</A></H1>
  275. <P>If a master window is so large that there will be extra space
  276. left over after all of its slaves have been packed, then the
  277. extra space is distributed uniformly among all of the slaves
  278. for which the <STRONG>-expand</STRONG> option is set.
  279. Extra horizontal space is distributed among the expandable
  280. slaves whose <STRONG>-side</STRONG> is <STRONG>left</STRONG> or <STRONG>right</STRONG>,
  281. and extra vertical space is distributed among the expandable
  282. slaves whose <STRONG>-side</STRONG> is <STRONG>top</STRONG> or <STRONG>bottom</STRONG>.</P>
  283. <P>
  284. <HR>
  285. <H1><A NAME="geometry propagation">GEOMETRY PROPAGATION</A></H1>
  286. <P>The packer normally computes how large a master must be to
  287. just exactly meet the needs of its slaves, and it sets the
  288. requested width and height of the master to these dimensions.
  289. This causes geometry information to propagate up through a
  290. window hierarchy to a top-level window so that the entire
  291. sub-tree sizes itself to fit the needs of the leaf windows.
  292. However, the <STRONG>packPropagate</STRONG> method may be used to
  293. turn off propagation for one or more masters.
  294. If propagation is disabled then the packer will not set
  295. the requested width and height of the packer.
  296. This may be useful if, for example, you wish for a master
  297. window to have a fixed size that you specify.</P>
  298. <P>
  299. <HR>
  300. <H1><A NAME="restrictions on master windows">RESTRICTIONS ON MASTER WINDOWS</A></H1>
  301. <P>The master for each slave must either be the slave's parent
  302. (the default) or a descendant of the slave's parent.
  303. This restriction is necessary to guarantee that the
  304. slave can be placed over any part of its master that is
  305. visible without danger of the slave being clipped by its parent.</P>
  306. <P>
  307. <HR>
  308. <H1><A NAME="packing order">PACKING ORDER</A></H1>
  309. <P>If the master for a slave is not its parent then you must make sure
  310. that the slave is higher in the stacking order than the master.
  311. Otherwise the master will obscure the slave and it will appear as
  312. if the slave hasn't been packed correctly.
  313. The easiest way to make sure the slave is higher than the master is
  314. to create the master window first:  the most recently created window
  315. will be highest in the stacking order.
  316. Or, you can use the <STRONG>raise</STRONG> and <STRONG>lower</STRONG> methods to change
  317. the stacking order of either the master or the slave.</P>
  318. <P>
  319. <HR>
  320. <H1><A NAME="see also">SEE ALSO</A></H1>
  321. <P><A HREF="../../../site/lib/Tk/form.html">Tk::form</A>
  322. <A HREF="../../../site/lib/Tk/grid.html">Tk::grid</A>
  323. <A HREF="../../../site/lib/Tk/place.html">Tk::place</A></P>
  324. <P>
  325. <HR>
  326. <H1><A NAME="keywords">KEYWORDS</A></H1>
  327. <P>geometry manager, location, packer, parcel, propagation, size</P>
  328. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  329. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  330. <STRONG><P CLASS=block> Tk::pack - Geometry manager that packs around edges of cavity</P></STRONG>
  331. </TD></TR>
  332. </TABLE>
  333.  
  334. </BODY>
  335.  
  336. </HTML>
  337.