ost_dirtree(3) [debian man page]

ost::DirTree(3) 					     Library Functions Manual						   ost::DirTree(3)

NAME

       ost::DirTree -

       A generic class to walk a hierarchical directory structure.

SYNOPSIS

       #include <file.h>

   Public Member Functions
       DirTree (const char *prefix, unsigned maxdepth)
	   Construct a directory tree walk starting at the specified prefix.
       DirTree (unsigned maxdepth)
	   Construct an un-opened directory tree of a known maximum depth.
       virtual ~DirTree ()
       void open (const char *prefix)
	   Open a directory tree path.
       void close (void)
	   Close the directory path.
       char * getPath (void)
	   Extract the next full pathname from the directory walk.
       unsigned perform (const char *prefix)
	   This is used to step through the filter virtual for an entire subtree, and is used for cases where a derived DirTree class performs
	   it's primary operations through filter rather than externally by calling getPath().

   Protected Member Functions
       virtual bool filter (const char *file, struct stat *ino)
	   Virtual method to filter results.

Detailed Description
       A generic class to walk a hierarchical directory structure.

       Author:
	   David Sugar dyfet@ostel.com Directory tree walking.

Constructor &; Destructor Documentation
   ost::DirTree::DirTree (const char *prefix, unsignedmaxdepth)
       Construct a directory tree walk starting at the specified prefix. A maximum subdirectory depth is also specified.

	@param prefix to start walk.
	@param maxdepth subdirectory depth to examine.

   ost::DirTree::DirTree (unsignedmaxdepth)
       Construct an un-opened directory tree of a known maximum depth. Parameters:
	   maxdepth subdirectory subdirectory depth.

   virtual ost::DirTree::~DirTree () [virtual]
Member Function Documentation
   void ost::DirTree::close (void)
       Close the directory path.

   virtual bool ost::DirTree::filter (const char *file, struct stat *ino) [protected],	[virtual]
       Virtual method to filter results. Virtual override methods should call baseclass method to assure . and .. names are stripped out.

       Returns:
	   true if current filename is accepted.

       Parameters:
	   file path to examine
	   ino info of type, date, etc.

   char* ost::DirTree::getPath (void)
       Extract the next full pathname from the directory walk. When returning directories, a '/' is appended. The returned string is a buffer of
       MAX_PATH size.

       Returns:
	   path of next subdirectory entry or NULL.

   void ost::DirTree::open (const char *prefix)
       Open a directory tree path. Parameters:
	   prefix directory path to open.

   unsigned ost::DirTree::perform (const char *prefix)
       This is used to step through the filter virtual for an entire subtree, and is used for cases where a derived DirTree class performs it's
       primary operations through filter rather than externally by calling getPath(). Returns:
	   number of files and directories examined.

       Parameters:
	   prefix directory path to examine.

Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012						   ost::DirTree(3)

DirTree(3pm)						User Contributed Perl Documentation					      DirTree(3pm)

NAME

       Tk::DirTree - Create and manipulate DirTree widgets

SYNOPSIS

	   use Tk::DirTree;

	   $dirtree = $parent->DirTree(?options?);

SUPER-CLASS
       The DirTree class is derived from the Tree class and inherits all the methods, options and subwidgets of its super-class.

STANDARD OPTIONS

       Tree supports all the standard options of a Tree widget.  See Tk::options for details on the standard options.

WIDGET-SPECIFIC OPTIONS
       Name:	      browseCmd
       Class:	      BrowseCmd
       Switch:	      -browsecmd
	   Specifies a callback to call whenever the user browses on a directory (usually by single-clicking on the name of the directory). The
	   callback is called with one argument, the complete pathname of the directory.

       Name:	      command
       Class:	      Command
       Switch:	      -command
	   Specifies the callback to be called when the user activates on a directory (usually by double-clicking on the name of the directory).
	   The callback is called with one argument, the complete pathname of the directory.

       Name:	      dircmd
       Class:	      DirCmd
       Switch:	      -dircmd
	   Specifies the callback to be called when a directory listing is needed for a particular directory. If this option is not specified, by
	   default the DirTree widget will attempt to read the directory as a Unix directory. On special occasions, the application programmer may
	   want to supply a special method for reading directories: for example, when he needs to list remote directories. In this case, the
	   -dircmd option can be used. The specified callback accepts two arguments: the first is the name of the directory to be listed; the
	   second is a Boolean value indicating whether hidden sub-directories should be listed. This callback returns a list of names of the sub-
	   directories of this directory. For example:

	       sub read_dir {
		   my( $dir, $showhidden ) = @_;
		   return( qw/DOS NORTON WINDOWS/ ) if $dir eq "C:\";
		   return();
	       }

       Name:	      showHidden
       Class:	      ShowHidden
       Switch:	      -showhidden
	   Specifies whether hidden directories should be shown. By default, a directory name starting with a period "." is considered as a hidden
	   directory. This rule can be overridden by supplying an alternative -dircmd option.

       Name:	      directory
       Class:	      Directory
       Switch:	      -directory
       Alias:	      -value
	   Specifies the name of the current directory to be displayed in the DirTree widget.

DESCRIPTION

       The DirTree constructor method creates a new window (given by the $dirtree argument) and makes it into a DirTree widget.  Additional
       options, described above, may be specified on the command line or in the option database to configure aspects of the DirTree such as its
       cursor and relief.  The DirTree widget displays a list view of a directory, its previous directories and its sub-directories. The user can
       choose one of the directories displayed in the list or change to another directory.

WIDGET METHODS

       The DirTree method creates a widget object.  This object supports the configure and cget methods described in Tk::options which can be used
       to enquire and modify the options described above.  The widget also inherits all the methods provided by the generic Tk::Widget class.

       The following additional methods are available for DirTree widgets:

       $dirtree->chdir(dir)
	   Change the current directory to dir.

OTHER METHODS

       These methods have to be documented or made private:

       OpenCmd
       Populate
       add_to_tree
       dirnames
       fullpath
       has_subdir
       opencmd
       set_dir

BINDINGS

       The mouse and keyboard bindings of the DirTree widget are the same as the bindings of the Tree widget.

KEYWORDS

       directory, tree, tix

SEE ALSO

       Tk::Tree Tk::HList

AUTHOR

       Perl/TK version by Chris Dean <ctdean@cogit.com>.  Original Tcl/Tix version by Ioi Kim Lam.

perl v5.14.2							    2010-05-29							      DirTree(3pm)