home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _acb20857a051822ba8bcc0e97bc3d796 < prev    next >
Text File  |  2000-03-23  |  8KB  |  186 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Tk::DirTree - Create and manipulate DirTree widgets</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::DirTree - Create and manipulate DirTree widgets</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="#superclass">SUPER-CLASS</A></LI>
  25.     <LI><A HREF="#standard options">STANDARD OPTIONS</A></LI>
  26.     <LI><A HREF="#widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></LI>
  27.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  28.     <LI><A HREF="#widget methods">WIDGET METHODS</A></LI>
  29.     <LI><A HREF="#bindings">BINDINGS</A></LI>
  30.     <LI><A HREF="#keywords">KEYWORDS</A></LI>
  31.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  32.     <LI><A HREF="#author">AUTHOR</A></LI>
  33. </UL>
  34. <!-- INDEX END -->
  35.  
  36. <HR>
  37. <P>
  38. <H1><A NAME="name">NAME</A></H1>
  39. <P>Tk::DirTree - Create and manipulate DirTree widgets</P>
  40. <P>
  41. <HR>
  42. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  43. <UL>
  44. <LI>Linux</LI>
  45. <LI>Solaris</LI>
  46. <LI>Windows</LI>
  47. </UL>
  48. <HR>
  49. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  50. <P>    <STRONG>use Tk::DirTree;</STRONG></P>
  51. <P>    <EM>$dirtree</EM> = <EM>$parent</EM>-><STRONG>DirTree</STRONG>(?<EM>options</EM>?);</P>
  52. <P>
  53. <HR>
  54. <H1><A NAME="superclass">SUPER-CLASS</A></H1>
  55. <P>The <STRONG>DirTree</STRONG> class is derived from the <A HREF="../../../site/lib/Tk/Tree.html">Tree</A> class and inherits
  56. all the methods, options and subwidgets of its super-class.</P>
  57. <P>
  58. <HR>
  59. <H1><A NAME="standard options">STANDARD OPTIONS</A></H1>
  60. <P><STRONG>Tree</STRONG> supports all the standard options of a Tree widget.  See
  61. <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> for details on the standard options.</P>
  62. <P>
  63. <HR>
  64. <H1><A NAME="widgetspecific options">WIDGET-SPECIFIC OPTIONS</A></H1>
  65. <DL>
  66. <DT><STRONG><A NAME="item_Name%3A_browseCmd">Name:        <STRONG>browseCmd</STRONG></A></STRONG><BR>
  67. <DD>
  68. <DT><STRONG><A NAME="item_Class%3A_BrowseCmd">Class:        <STRONG>BrowseCmd</STRONG></A></STRONG><BR>
  69. <DD>
  70. <DT><STRONG><A NAME="item_Switch%3A_%2Dbrowsecmd">Switch:        <STRONG>-browsecmd</STRONG></A></STRONG><BR>
  71. <DD>
  72. Specifies a <A HREF="../../../site/lib/Tk/callbacks.html">callback</A> to call whenever the user browses on a directory
  73. (usually by single-clicking on the name of the directory). The callback
  74. is called with one argument, the complete pathname of the directory.
  75. <P></P>
  76. <DT><STRONG><A NAME="item_Name%3A_command">Name:        <STRONG>command</STRONG></A></STRONG><BR>
  77. <DD>
  78. <DT><STRONG><A NAME="item_Class%3A_Command">Class:        <STRONG>Command</STRONG></A></STRONG><BR>
  79. <DD>
  80. <DT><STRONG><A NAME="item_Switch%3A_%2Dcommand">Switch:        <STRONG>-command</STRONG></A></STRONG><BR>
  81. <DD>
  82. Specifies the <A HREF="../../../site/lib/Tk/callbacks.html">callback</A> to be called when the user activates on a directory
  83. (usually by double-clicking on the name of the directory). The callback
  84. is called with one argument, the complete pathname of the directory.
  85. <P></P>
  86. <DT><STRONG><A NAME="item_Name%3A_dircmd">Name:        <STRONG>dircmd</STRONG></A></STRONG><BR>
  87. <DD>
  88. <DT><STRONG><A NAME="item_Class%3A_DirCmd">Class:        <STRONG>DirCmd</STRONG></A></STRONG><BR>
  89. <DD>
  90. <DT><STRONG><A NAME="item_Switch%3A_%2Ddircmd">Switch:        <STRONG>-dircmd</STRONG></A></STRONG><BR>
  91. <DD>
  92. Specifies the <A HREF="../../../site/lib/Tk/callbacks.html">callback</A> to be called when a directory listing is needed
  93. for a particular directory. If this option is not specified, by
  94. default the DirTree widget will attempt to read the directory as a
  95. Unix directory. On special occasions, the application programmer may
  96. want to supply a special method for reading directories: for example,
  97. when he needs to list remote directories. In this case, the <STRONG>-dircmd</STRONG>
  98. option can be used. The specified callback accepts two arguments: the
  99. first is the name of the directory to be listed; the second is a
  100. Boolean value indicating whether hidden sub-directories should be
  101. listed. This callback returns a list of names of the sub-directories of
  102. this directory. For example:
  103. <PRE>
  104.     sub read_dir {
  105.         my( $dir, $showhidden ) = @_;
  106.         return( qw/DOS NORTON WINDOWS/ ) if $dir eq "C:\\";
  107.         return();
  108.     }</PRE>
  109. <P></P>
  110. <DT><STRONG><A NAME="item_Name%3A_showHidden">Name:        <STRONG>showHidden</STRONG></A></STRONG><BR>
  111. <DD>
  112. <DT><STRONG><A NAME="item_Class%3A_ShowHidden">Class:        <STRONG>ShowHidden</STRONG></A></STRONG><BR>
  113. <DD>
  114. <DT><STRONG><A NAME="item_Switch%3A_%2Dshowhidden">Switch:        <STRONG>-showhidden</STRONG></A></STRONG><BR>
  115. <DD>
  116. Specifies whether hidden directories should be shown. By default, a
  117. directory name starting with a period ``.'' is considered as a hidden
  118. directory. This rule can be overridden by supplying an alternative
  119. <STRONG>-dircmd</STRONG> option.
  120. <P></P>
  121. <DT><STRONG><A NAME="item_Name%3A_directory">Name:        <STRONG>directory</STRONG></A></STRONG><BR>
  122. <DD>
  123. <DT><STRONG><A NAME="item_Class%3A_Directory">Class:        <STRONG>Directory</STRONG></A></STRONG><BR>
  124. <DD>
  125. <DT><STRONG><A NAME="item_Switch%3A_%2Ddirectory">Switch:        <STRONG>-directory</STRONG></A></STRONG><BR>
  126. <DD>
  127. <DT><STRONG><A NAME="item_Alias%3A_%2Dvalue">Alias:        <STRONG>-value</STRONG></A></STRONG><BR>
  128. <DD>
  129. Specifies the name of the current directory to be displayed in the
  130. DirTree widget.
  131. <P></P></DL>
  132. <P>
  133. <HR>
  134. <H1><A NAME="description">DESCRIPTION</A></H1>
  135. <P>The <STRONG>DirTree</STRONG> constructor method creates a new window (given by the $dirtree
  136. argument) and makes it into a DirTree widget.  Additional options,
  137. described above, may be specified on the command line or in the
  138. option database to configure aspects of the DirTree such as its
  139. cursor and relief.  The DirTree widget displays a list view of a
  140. directory, its previous directories and its sub-directories. The
  141. user can choose one of the directories displayed in the list or
  142. change to another directory.</P>
  143. <P>
  144. <HR>
  145. <H1><A NAME="widget methods">WIDGET METHODS</A></H1>
  146. <P>The <STRONG>DirTree</STRONG> method creates a widget object.
  147. This object supports the <STRONG>configure</STRONG> and <STRONG>cget</STRONG> methods
  148. described in <A HREF="../../../site/lib/Tk/options.html">the Tk::options manpage</A> which can be used to enquire and
  149. modify the options described above.
  150. The widget also inherits all the methods provided by the generic
  151. <A HREF="../../../site/lib/Tk/Widget.html">Tk::Widget</A> class.</P>
  152. <P>The following additional methods are available for DirTree widgets:</P>
  153. <DL>
  154. <DT><STRONG><A NAME="item_chdir"><EM>$dirtree</EM>-><STRONG>chdir</STRONG>(<EM>dir</EM>)</A></STRONG><BR>
  155. <DD>
  156. Change the current directory to <EM>dir</EM>.
  157. <P></P></DL>
  158. <P>
  159. <HR>
  160. <H1><A NAME="bindings">BINDINGS</A></H1>
  161. <P>The mouse and keyboard bindings of the DirTree widget are the same as
  162. the bindings of the <A HREF="../../../site/lib/Tk/Tree.html">Tree</A> widget.</P>
  163. <P>
  164. <HR>
  165. <H1><A NAME="keywords">KEYWORDS</A></H1>
  166. <P>directory, tree, tix</P>
  167. <P>
  168. <HR>
  169. <H1><A NAME="see also">SEE ALSO</A></H1>
  170. <P><A HREF="../../../site/lib/Tk/Tree.html">Tk::Tree</A>
  171. <A HREF="../../../site/lib/Tk/HList.html">Tk::HList</A></P>
  172. <P>
  173. <HR>
  174. <H1><A NAME="author">AUTHOR</A></H1>
  175. <P>Perl/TK version by Chris Dean <<A HREF="mailto:ctdean@cogit.com">ctdean@cogit.com</A>>.  Original Tcl/Tix
  176. version by Ioi Kim Lam.</P>
  177. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  178. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  179. <STRONG><P CLASS=block> Tk::DirTree - Create and manipulate DirTree widgets</P></STRONG>
  180. </TD></TR>
  181. </TABLE>
  182.  
  183. </BODY>
  184.  
  185. </HTML>
  186.