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

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::Compound - Create multi-line compound images.</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::Compound - Create multi-line compound images.</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="#description">DESCRIPTION</A></LI>
  24.     <LI><A HREF="#creating compound images">CREATING COMPOUND IMAGES</A></LI>
  25.     <LI><A HREF="#image command">IMAGE COMMAND</A></LI>
  26.     <LI><A HREF="#example">EXAMPLE</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::Compound - Create multi-line compound images.</P>
  35. <P>    use Tk::Compound;
  36.     <EM>$image</EM> = <EM>$widget</EM>-><STRONG>Compound</STRONG>?(<EM>name</EM>??,<EM>options</EM>?)
  37.     <EM>$image</EM>-><STRONG>Line</STRONG>?(<EM>options</EM>?)
  38.     <EM>$image</EM>-><STRONG>Text</STRONG>?(<EM>options</EM>?)
  39.     <EM>$image</EM>-><STRONG>Bitmap</STRONG>?(<EM>options</EM>?)
  40.     <EM>$image</EM>-><STRONG>Image</STRONG>?(<EM>options</EM>?)
  41.     <EM>$image</EM>-><STRONG>Space</STRONG>?(<EM>options</EM>?)</P>
  42. <P>
  43. <HR>
  44. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  45. <UL>
  46. <LI>Linux</LI>
  47. <LI>Solaris</LI>
  48. <LI>Windows</LI>
  49. </UL>
  50. <HR>
  51. <H1><A NAME="description">DESCRIPTION</A></H1>
  52. <P>Compound image types can be used to create images that consists of
  53. multiple horizontal lines; each line is composed of a series of items
  54. (texts, bitmaps, images or spaces) arranged from left to
  55. right. Compound images are mainly used to embed complex drawings into
  56. widgets that support the <STRONG>-image</STRONG> option. As shown in the EXAMPLE
  57. section below, a compound image can be used to display a bitmap and a
  58. text string simutaneously in a Tk <STRONG>Button</STRONG> widget.</P>
  59. <P>Compound images can only be used on windows on the same display as, and
  60. with the same pixel depth and visual as the <EM>$widget</EM> used to create them.</P>
  61. <P>
  62. <HR>
  63. <H1><A NAME="creating compound images">CREATING COMPOUND IMAGES</A></H1>
  64. <P>Compounds are created using <EM>$widget</EM>-><STRONG>Compound</STRONG>.            
  65. Compounds support the following <EM>options</EM>:</P>
  66. <DL>
  67. <DT><STRONG><A NAME="item_%2Dbackground_%3D%3E_color"><STRONG>-background</STRONG> => <EM>color</EM></A></STRONG><BR>
  68. <DD>
  69. Specifies the background color of the compound image. This color is
  70. also used as the default background color for the bitmap items in the
  71. compound image.
  72. <P></P>
  73. <DT><STRONG><A NAME="item_%2Dborderwidth_%3D%3E_pixels"><STRONG>-borderwidth</STRONG> => <EM>pixels</EM></A></STRONG><BR>
  74. <DD>
  75. Specifies a non-negative value indicating the width of the 3-D border
  76. drawn around the compound image.
  77. <P></P>
  78. <DT><STRONG><A NAME="item_%2Dfont_%3D%3E_font"><STRONG>-font</STRONG> => <EM>font</EM></A></STRONG><BR>
  79. <DD>
  80. Specifies the default font for the text items in the compound image.
  81. <P></P>
  82. <DT><STRONG><A NAME="item_%2Dforeground_%3D%3E_color"><STRONG>-foreground</STRONG> => <EM>color</EM></A></STRONG><BR>
  83. <DD>
  84. Specifies the default foreground color for the bitmap and text items
  85. in the compound image.
  86. <P></P>
  87. <DT><STRONG><A NAME="item_%2Dpadx_%3D%3E_value"><STRONG>-padx</STRONG> => <EM>value</EM></A></STRONG><BR>
  88. <DD>
  89. Specifies a non-negative value indicating how much extra space to
  90. request for the compound image in the X-direction. The <EM>value</EM> may
  91. have any of the forms acceptable to <STRONG>Tk_GetPixels(3)</STRONG>.
  92. <P></P>
  93. <DT><STRONG><A NAME="item_%2Dpady_%3D%3E_value"><STRONG>-pady</STRONG> => <EM>value</EM></A></STRONG><BR>
  94. <DD>
  95. Specifies a non-negative value indicating how much extra space to
  96. request for the compound image in the Y-direction.
  97. <P></P>
  98. <DT><STRONG><A NAME="item_%2Drelief_%3D%3E_value"><STRONG>-relief</STRONG> => <EM>value</EM></A></STRONG><BR>
  99. <DD>
  100. Specifies the 3-D effect desired for the background of the compound
  101. image. Acceptable values are <STRONG>raised</STRONG>, <STRONG>sunken</STRONG>, <STRONG>flat</STRONG>,
  102. <STRONG>ridge</STRONG>, and <STRONG>groove</STRONG>.
  103. <P></P>
  104. <DT><STRONG><A NAME="item_%2Dshowbackground_%3D%3E_value"><STRONG>-showbackground</STRONG> => <EM>value</EM></A></STRONG><BR>
  105. <DD>
  106. Specifies whether the background and the 3D borders should be drawn.
  107. Must be a valid boolean value. By default the background is not drawn
  108. and the compound image appears to have a transparent background.
  109. <P></P></DL>
  110. <P>
  111. <HR>
  112. <H1><A NAME="image command">IMAGE COMMAND</A></H1>
  113. <P>When a compound image is created, Tk also creates a new object.
  114. This object supports the <STRONG>configure</STRONG> and <STRONG>cget</STRONG> methods
  115. described in <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> which can be used to enquire and
  116. modify the options described above.
  117. </P>
  118. <PRE>
  119.  
  120. The object also supports the following methods:</PRE>
  121. <DL>
  122. <DT><STRONG><A NAME="item_Line"><EM>$compound</EM>-><STRONG>Line</STRONG>?(<EM>option =</EM> value ...>)?</A></STRONG><BR>
  123. <DD>
  124. Creates a new line at the bottom of the compound image. Lines support
  125. the following <EM>options</EM>:
  126. <DL>
  127. <DT><STRONG><A NAME="item_%2Danchor_value"><STRONG>-anchor</STRONG> value</A></STRONG><BR>
  128. <DD>
  129. Specifies how the line should be aligned along the horizontal axis.
  130. When the values are <STRONG>w</STRONG>, <STRONG>sw</STRONG> or <STRONG>nw</STRONG>, the line is aligned
  131. to the left. When the values are <STRONG>c</STRONG>, <STRONG>s</STRONG> or <STRONG>n</STRONG>, the line
  132. is aligned to the middle.  When the values are <STRONG>e</STRONG>, <STRONG>se</STRONG> or
  133. <STRONG>ne</STRONG>, the line is aligned to the right.
  134. <P></P>
  135. <DT><STRONG><STRONG>-padx</STRONG> => <EM>value</EM></STRONG><BR>
  136. <DD>
  137. Specifies a non-negative value indicating how much extra space to
  138. request for this line in the X-direction.
  139. <P></P></DL>
  140. <DT><STRONG><A NAME="item_Itemtype"><EM>$compound</EM>-><EM>Itemtype</EM>?(<EM>option =</EM> value ...>)?</A></STRONG><BR>
  141. <DD>
  142. Creates a new item of the type <EM>Itemtype</EM> at the end of the last
  143. line of the compound image. All types of items support
  144. these following common <EM>options</EM>:
  145. <DL>
  146. <DT><STRONG><STRONG>-anchor</STRONG> value</STRONG><BR>
  147. <DD>
  148. Specifies how the item should be aligned along the vertical axis. When
  149. the values are <STRONG>n</STRONG>, <STRONG>nw</STRONG> or <STRONG>ne</STRONG>, the item is aligned to
  150. the top of the line. When the values are <STRONG>c</STRONG>, <STRONG>w</STRONG> or <STRONG>e</STRONG>,
  151. the item is aligned to the middle of the line.  When the values are
  152. <STRONG>s</STRONG>, <STRONG>se</STRONG> or <STRONG>sw</STRONG>, the item is aligned to the bottom of
  153. the line.
  154. <P></P>
  155. <DT><STRONG><STRONG>-padx</STRONG> => <EM>value</EM></STRONG><BR>
  156. <DD>
  157. Specifies a non-negative value indicating how much extra space to
  158. request for this item in the X-direction.
  159. <P></P>
  160. <DT><STRONG><STRONG>-pady</STRONG> => <EM>value</EM></STRONG><BR>
  161. <DD>
  162. Specifies a non-negative value indicating how much extra space to
  163. request for this item in the Y-direction.
  164. <P></P>
  165. <DT><STRONG><A NAME="item_item%2Dtype_can_be_any_of_the_following%3A"><EM>item-type</EM> can be any of the following:</A></STRONG><BR>
  166. <DD>
  167. </DL>
  168. <DT><STRONG><A NAME="item_Bitmap"><EM>$compound</EM>-><STRONG>Bitmap</STRONG>?(<EM>option =</EM> value ...>)?</A></STRONG><BR>
  169. <DD>
  170. Creates a new bitmap item of at the end of the last
  171. line of the compound image. Additional <EM>options</EM> accepted by the
  172. bitmap type are:
  173. <DL>
  174. <DT><STRONG><STRONG>-background</STRONG> => <EM>color</EM></STRONG><BR>
  175. <DD>
  176. Specifies the background color of the bitmap item.
  177. <P></P>
  178. <DT><STRONG><A NAME="item_%2Dbitmap_%3D%3E_name"><STRONG>-bitmap</STRONG> => <EM>name</EM></A></STRONG><BR>
  179. <DD>
  180. Specifies a bitmap to display in this item, in any of the forms
  181. acceptable to <STRONG>Tk_GetBitmap(3)</STRONG>.
  182. <P></P>
  183. <DT><STRONG><STRONG>-foreground</STRONG> => <EM>color</EM></STRONG><BR>
  184. <DD>
  185. Specifies the foreground color of the bitmap item.
  186. <P></P></DL>
  187. <DT><STRONG><A NAME="item_Image"><EM>$compound</EM>-><STRONG>Image</STRONG>?(<EM>option =</EM> value ...>)?</A></STRONG><BR>
  188. <DD>
  189. Creates a new image item of at the end of the last
  190. line of the compound image. Additional <EM>options</EM> accepted by the
  191. image type are:
  192. <DL>
  193. <DT><STRONG><A NAME="item_%2Dimage_%3D%3E_name"><STRONG>-image</STRONG> => <EM>name</EM></A></STRONG><BR>
  194. <DD>
  195. Specifies an image to display in this item. <EM>name</EM>
  196. must have been created with the <STRONG>image create</STRONG> command.
  197. <P></P></DL>
  198. <DT><STRONG><A NAME="item_Space"><EM>$compound</EM>-><STRONG>Space</STRONG>?(<EM>option =</EM> value ...>)?</A></STRONG><BR>
  199. <DD>
  200. Creates a new space item of at the end of the last line of the
  201. compound image. Space items do not display anything. They just acts as
  202. space holders that add additional spaces between items inside a
  203. compound image. Additional <EM>options</EM> accepted by the image type
  204. are:
  205. <DL>
  206. <DT><STRONG><A NAME="item_%2Dwidth_%3D%3E_value"><STRONG>-width</STRONG> => <EM>value</EM></A></STRONG><BR>
  207. <DD>
  208. Specifies the width of this space. The <EM>value</EM> may have any of the
  209. forms acceptable to <STRONG>Tk_GetPixels(3)</STRONG>.
  210. <P></P>
  211. <DT><STRONG><A NAME="item_%2Dheight_%3D%3E_value"><STRONG>-height</STRONG> => <EM>value</EM></A></STRONG><BR>
  212. <DD>
  213. Specifies the height of this space. The <EM>value</EM> may have any of
  214. the forms acceptable to <STRONG>Tk_GetPixels(3)</STRONG>.
  215. <P></P></DL>
  216. <DT><STRONG><A NAME="item_Text"><EM>$compound</EM>-><STRONG>Text</STRONG>?(<EM>option =</EM> value ...>)?</A></STRONG><BR>
  217. <DD>
  218. Creates a new text item of at the end of the last line of the compound
  219. image. Additional <EM>options</EM> accepted by the text type are:
  220. <DL>
  221. <DT><STRONG><STRONG>-background</STRONG> => <EM>color</EM></STRONG><BR>
  222. <DD>
  223. Specifies the background color of the text item.
  224. <P></P>
  225. <DT><STRONG><A NAME="item_%2Dfont_%3D%3E_name"><STRONG>-font</STRONG> => <EM>name</EM></A></STRONG><BR>
  226. <DD>
  227. Specifies the font to be used for this text item.
  228. <P></P>
  229. <DT><STRONG><STRONG>-foreground</STRONG> => <EM>color</EM></STRONG><BR>
  230. <DD>
  231. Specifies the foreground color of the text item.
  232. <P></P>
  233. <DT><STRONG><A NAME="item_%2Djustify_value"><STRONG>-justify</STRONG> <EM>value</EM></A></STRONG><BR>
  234. <DD>
  235. When there are multiple lines of text displayed in a text item, this
  236. option determines how the lines line up with each other. <EM>value</EM>
  237. must be one of <STRONG>left</STRONG>, <STRONG>center</STRONG>, or <STRONG>right</STRONG>.  <STRONG>Left</STRONG>
  238. means that the lines' left edges all line up, <STRONG>center</STRONG> means that
  239. the lines' centers are aligned, and <STRONG>right</STRONG> means that the lines'
  240. right edges line up.
  241. <P></P>
  242. <DT><STRONG><A NAME="item_%2Dtext_%3D%3E_string"><STRONG>-text</STRONG> => <EM>string</EM></A></STRONG><BR>
  243. <DD>
  244. Specifies a text string to display in this text item.
  245. <P></P>
  246. <DT><STRONG><A NAME="item_%2Dunderline_value"><STRONG>-underline</STRONG> <EM>value</EM></A></STRONG><BR>
  247. <DD>
  248. Specifies the integer index of a character to underline in the text
  249. item. 0 corresponds to the first character of the text displayed in
  250. the text item, 1 to the next character, and so on.
  251. <P></P>
  252. <DT><STRONG><A NAME="item_%2Dwraplength_value"><STRONG>-wraplength</STRONG> <EM>value</EM></A></STRONG><BR>
  253. <DD>
  254. This option specifies the maximum line length of the label string on
  255. this text item. If the line length of the label string exceeds this
  256. length, it is wrapped onto the next line, so that no line is longer
  257. than the specified length. The value may be specified in any of the
  258. standard forms for screen distances. If this value is less than or
  259. equal to 0 then no wrapping is done: lines will break only at newline
  260. characters in the text.
  261. <P></P></DL>
  262. </DL>
  263. <P>
  264. <HR>
  265. <H1><A NAME="example">EXAMPLE</A></H1>
  266. <P>The following example creates a compound image with a bitmap and a
  267. text string and places this image into a <STRONG>Button(n)</STRONG>
  268. widget. Notice that the image must be created using the widget 
  269. that it resides in.</P>
  270. <PRE>
  271.   my $b = $parent->Button;
  272.   my $c = $b->Compound;
  273.   $b->configure(-image => $c);
  274.   $c->Line;
  275.   $c->Bitmap(-bitmap => 'warning');
  276.   $c->Space(-width => 8);
  277.   $c->Text(-text => "Warning", -underline => 0);
  278.   $b->pack;</PRE>
  279. <P>
  280. <HR>
  281. <H1><A NAME="keywords">KEYWORDS</A></H1>
  282. <P>image(n), <CODE>Tix(n)</CODE></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::Compound - Create multi-line compound images.</P></STRONG>
  286. </TD></TR>
  287. </TABLE>
  288.  
  289. </BODY>
  290.  
  291. </HTML>
  292.