home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _d6e11b3e0eb493a072f7d94a24eec5bb < prev    next >
Text File  |  2000-03-23  |  8KB  |  193 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::NoteBook - display several windows in limited space with notebook metaphor.</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::NoteBook - display several windows in limited space with notebook metaphor.</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="#methods">METHODS</A></LI>
  26.     <LI><A HREF="#authors">AUTHORS</A></LI>
  27. </UL>
  28. <!-- INDEX END -->
  29.  
  30. <HR>
  31. <P>
  32. <H1><A NAME="name">NAME</A></H1>
  33. <P>Tk::NoteBook - display several windows in limited space with notebook metaphor.</P>
  34. <P>
  35. <HR>
  36. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  37. <UL>
  38. <LI>Linux</LI>
  39. <LI>Solaris</LI>
  40. <LI>Windows</LI>
  41. </UL>
  42. <HR>
  43. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  44. <PRE>
  45.   use Tk::NoteBook;
  46.   ...
  47.   $w = $frame->NoteBook();
  48.   $page1 = $w->add("page1", options);
  49.   $page2 = $w->add("page2", options);
  50.   ...
  51.   $page2 = $w->add("page2", options);</PRE>
  52. <P>
  53. <HR>
  54. <H1><A NAME="description">DESCRIPTION</A></H1>
  55. <P>The NoteBook widget provides a notebook metaphor to display several
  56. windows in limited space. The notebook is divided into a stack of pages
  57. of which only one is displayed at any time. The other pages can be
  58. selected by means of choosing the visual ``tabs'' at the top of the
  59. widget. Additionally, the <Tab> key may be used to traverse the pages.
  60. If <STRONG>-underline</STRONG> is used, Alt- bindings will also work.</P>
  61. <P>The widget takes all the options that a Frame does. In addition,
  62. it supports the following options:</P>
  63. <DL>
  64. <DT><STRONG><A NAME="item_%2Ddynamicgeometry"><STRONG>-dynamicgeometry</STRONG></A></STRONG><BR>
  65. <DD>
  66. If set to false (default and recommended), the size of the NoteBook
  67. will match the size of the largest page. Otherwise the size will
  68. match the size of the current page causing the NoteBook to change
  69. size when different pages of different sizes are selected.
  70. <P></P>
  71. <DT><STRONG><A NAME="item_%2Dipadx"><STRONG>-ipadx</STRONG></A></STRONG><BR>
  72. <DD>
  73. The amount of internal horizontal padding around the pages.
  74. <P></P>
  75. <DT><STRONG><A NAME="item_%2Dipady"><STRONG>-ipady</STRONG></A></STRONG><BR>
  76. <DD>
  77. The amount of internal vertical padding around the pages.
  78. <P></P></DL>
  79. <P>
  80. <HR>
  81. <H1><A NAME="methods">METHODS</A></H1>
  82. <P>The following methods may be used with a NoteBook object in addition
  83. to standard methods.</P>
  84. <DL>
  85. <DT><STRONG><A NAME="item_add"><STRONG>add(</STRONG><EM>pageName</EM>, <EM>options</EM><STRONG>)</STRONG></A></STRONG><BR>
  86. <DD>
  87. Adds a page with name <EM>pageName</EM> to the notebook. Returns an object
  88. of type <STRONG>Frame</STRONG>. The recognized <EM>options</EM> are:
  89. <DL>
  90. <DT><STRONG><A NAME="item_%2Danchor"><STRONG>-anchor</STRONG></A></STRONG><BR>
  91. <DD>
  92. Specifies how the information in a tab is to be displayed. Must be
  93. one of <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, <STRONG>nw</STRONG> or
  94. <STRONG>center</STRONG>.
  95. <P></P>
  96. <DT><STRONG><A NAME="item_%2Dbitmap"><STRONG>-bitmap</STRONG></A></STRONG><BR>
  97. <DD>
  98. Specifies a bitmap to display on the tab of this page. The bitmap
  99. is displayed only if none of the <STRONG>-label</STRONG> or <STRONG>-image</STRONG> options
  100. are specified.
  101. <P></P>
  102. <DT><STRONG><A NAME="item_%2Dimage"><STRONG>-image</STRONG></A></STRONG><BR>
  103. <DD>
  104. Specifies an image to display on the tab of this page. The image
  105. is displayed only if the <STRONG>-label</STRONG> option is not specified.
  106. <P></P>
  107. <DT><STRONG><A NAME="item_%2Dlabel"><STRONG>-label</STRONG></A></STRONG><BR>
  108. <DD>
  109. Specifies the text string to display on the tab of this page.
  110. <P></P>
  111. <DT><STRONG><A NAME="item_%2Djustify"><STRONG>-justify</STRONG></A></STRONG><BR>
  112. <DD>
  113. When there are multiple lines of text displayed in a tab, this
  114. option determines the justification of the lines.
  115. <P></P>
  116. <DT><STRONG><A NAME="item_%2Dcreatecmd"><STRONG>-createcmd</STRONG></A></STRONG><BR>
  117. <DD>
  118. Specifies a <A HREF="../../../site/lib/Tk/callbacks.html">callback</A> to be called the first time the page is
  119. shown on the screen. This option can be used to delay the creation
  120. of the contents of a page until necessary. It can be useful in
  121. situations where there are a large number of pages in a NoteBook
  122. widget; with <STRONG>-createcmd</STRONG> you do not have to make the user wait
  123. until all pages are constructed before displaying the first page.
  124. <P></P>
  125. <DT><STRONG><A NAME="item_%2Draisecmd"><STRONG>-raisecmd</STRONG></A></STRONG><BR>
  126. <DD>
  127. Specifies a <A HREF="../../../site/lib/Tk/callbacks.html">callback</A> to be called whenever this page is raised
  128. by the user.
  129. <P></P>
  130. <DT><STRONG><A NAME="item_%2Dstate"><STRONG>-state</STRONG></A></STRONG><BR>
  131. <DD>
  132. Specifies whether this page can be raised by the user. Must be
  133. either <STRONG>normal</STRONG> or <STRONG>disabled</STRONG>.
  134. <P></P>
  135. <DT><STRONG><A NAME="item_%2Dunderline"><STRONG>-underline</STRONG></A></STRONG><BR>
  136. <DD>
  137. Specifies the integer index of a character to underline in the
  138. tab. This option is used by the default bindings to implement
  139. keyboard traversal for menu buttons and menu entries. 0
  140. corresponds to the first character of text displayed on the
  141. widget, 1 to the next character and so on.
  142. <P></P>
  143. <DT><STRONG><A NAME="item_%2Dwraplength"><STRONG>-wraplength</STRONG></A></STRONG><BR>
  144. <DD>
  145. This option specifies the maximum line length of the label string
  146. on this tab. If the line length of the label string exceeds this
  147. length, then it is wrapped onto the next line so that no line is
  148. longer than the specified length. The value may be specified in
  149. any standard forms for screen distances. If this value is less
  150. than or equal to 0, then no wrapping is done: lines will break
  151. only at newline characters in the text.
  152. <P></P></DL>
  153. <DT><STRONG><A NAME="item_delete"><STRONG>delete(</STRONG><EM>pageName</EM><STRONG>)</STRONG></A></STRONG><BR>
  154. <DD>
  155. Deletes the page identified by <EM>pageName</EM>.
  156. <P></P>
  157. <DT><STRONG><A NAME="item_pagecget"><STRONG>pagecget(</STRONG><EM>pageName</EM>, <EM>-option</EM><STRONG>)</STRONG></A></STRONG><BR>
  158. <DD>
  159. Returns the current value of the configuration option given by
  160. <EM>-option</EM> in the page given by <EM>pageName</EM>. <EM>Option</EM> may have any of
  161. the values accepted in the <STRONG>add</STRONG> method.
  162. <P></P>
  163. <DT><STRONG><A NAME="item_pageconfigure"><STRONG>pageconfigure(</STRONG><EM>pageName</EM>, <EM>options</EM><STRONG>)</STRONG></A></STRONG><BR>
  164. <DD>
  165. Like configure for the page indicated by <EM>pageName</EM>. <EM>Options</EM> may
  166. be any of the options accepted by the <STRONG>add</STRONG> method.
  167. <P></P>
  168. <DT><STRONG><A NAME="item_raise"><STRONG>raise(</STRONG><EM>pageName</EM><STRONG>)</STRONG></A></STRONG><BR>
  169. <DD>
  170. Raise the page identified by <EM>pageName</EM>.
  171. <P></P>
  172. <DT><STRONG><A NAME="item_raised"><STRONG>raised()</STRONG></A></STRONG><BR>
  173. <DD>
  174. Returns the name of the currently raised page.
  175. <P></P></DL>
  176. <P>
  177. <HR>
  178. <H1><A NAME="authors">AUTHORS</A></H1>
  179. <P><STRONG>Rajappa Iyer</STRONG>  <<A HREF="mailto:rsi@earthling.net">rsi@earthling.net</A>>
  180. Nick Ing-Simmons <<A HREF="mailto:nick@ni-s.u-net.com">nick@ni-s.u-net.com</A>></P>
  181. <P>This code and documentation was derived from NoteBook.tcl in
  182. Tix4.0 written by Ioi Lam. It may be distributed under the same
  183. conditions as Perl itself.</P>
  184. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  185. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  186. <STRONG><P CLASS=block> Tk::NoteBook - display several windows in limited space with notebook metaphor.</P></STRONG>
  187. </TD></TR>
  188. </TABLE>
  189.  
  190. </BODY>
  191.  
  192. </HTML>
  193.