home *** CD-ROM | disk | FTP | other *** search
-
- <HTML>
- <HEAD>
- <TITLE>Tk::ObjScanner - Tk composite widget object scanner</TITLE>
- <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
- <LINK REV="made" HREF="mailto:">
- </HEAD>
-
- <BODY>
- <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
- <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
- <STRONG><P CLASS=block> Tk::ObjScanner - Tk composite widget object scanner</P></STRONG>
- </TD></TR>
- </TABLE>
-
- <A NAME="__index__"></A>
- <!-- INDEX BEGIN -->
-
- <UL>
-
- <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
-
- <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
- <LI><A HREF="#description">DESCRIPTION</A></LI>
- <LI><A HREF="#constructor parameters">Constructor parameters</A></LI>
- <LI><A HREF="#widgetspecific methods">WIDGET-SPECIFIC METHODS</A></LI>
- <UL>
-
- <LI><A HREF="#updatelistbox">updateListBox</A></LI>
- </UL>
-
- <LI><A HREF="#caveats">CAVEATS</A></LI>
- <LI><A HREF="#author">AUTHOR</A></LI>
- <LI><A HREF="#see also">SEE ALSO</A></LI>
- </UL>
- <!-- INDEX END -->
-
- <HR>
- <P>
- <H1><A NAME="name">NAME</A></H1>
- <P>Tk::ObjScanner - Tk composite widget object scanner</P>
- <P>
- <HR>
- <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
- <UL>
- <LI>Linux</LI>
- <LI>Solaris</LI>
- <LI>Windows</LI>
- </UL>
- <HR>
- <H1><A NAME="synopsis">SYNOPSIS</A></H1>
- <PRE>
- use Tk::ObjScanner;
- </PRE>
- <PRE>
-
- my $scanner = $mw->ObjScanner( caller => $object,
- [title=>"windows"]) -> pack ;</PRE>
- <P>
- <HR>
- <H1><A NAME="description">DESCRIPTION</A></H1>
- <P>The scanner provide a GUI to scan the attributes of an object. It can
- also be used to scan the elements of a hash or an array.</P>
- <P>The scanner is a composite widget made of a <A HREF="../../../site/lib/Tk/HList.html">the Tk::HList manpage</A> and a text
- window (actually a <A HREF="../../../TK/ROText.html">the TK::ROText manpage</A>). This widget acts as a scanner to
- the object (or hash ref) passed with the 'caller' parameter. The
- scanner will retrieve all keys of the hash/object and insert them in
- the HList.</P>
- <P>When the user double clicks on a key, the corresponding value will be added
- in the HList.</P>
- <P>If the value is a scalar, the scalar will be displayed in the text window.
- (Which is handy if the value is a multi-line string)</P>
- <P>
- <HR>
- <H1><A NAME="constructor parameters">Constructor parameters</A></H1>
- <UL>
- <LI>
- caller: The ref of the object or hash or array to scan (mandatory).
- <P></P>
- <LI>
- title: the title of the menu created by the scanner (optionnal)
- <P></P>
- <LI>
- destroyable: If set, a menu entry will allow the user to deatroy the scanner
- widget. (optional, default 1) . You may want to set this parameter to 0 if
- the destroy can be managed by a higher level object.
- <P></P></UL>
- <P>
- <HR>
- <H1><A NAME="widgetspecific methods">WIDGET-SPECIFIC METHODS</A></H1>
- <P>
- <H2><A NAME="updatelistbox">updateListBox</A></H2>
- <P>Update the keys of the listbox. This method may be handy if the
- scanned object wants to update the listbox of the scanner
- when the scanned object gets new attributes.</P>
- <P>
- <HR>
- <H1><A NAME="caveats">CAVEATS</A></H1>
- <P>ObjScanner may fail if an object involves a lot of internal perl
- magic. In this case, I'd be glad to hear about and I'll try to fix
- the problem.</P>
- <P>ObjScanner does not detect recursive data structures. It will just
- keep on displaying the tree until the user gets tired of clicking on
- the HList items.</P>
- <P>
- <HR>
- <H1><A NAME="author">AUTHOR</A></H1>
- <P>Dominique Dumont, <A HREF="mailto:Dominique_Dumont@grenoble.hp.com">Dominique_Dumont@grenoble.hp.com</A></P>
- <P>Copyright (c) 1997-1999 Dominique Dumont. All rights reserved.
- This program is free software; you can redistribute it and/or
- modify it under the same terms as Perl itself.</P>
- <P>
- <HR>
- <H1><A NAME="see also">SEE ALSO</A></H1>
- <P>perl(1), Tk(3), Tk::HList(3)</P>
- <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
- <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
- <STRONG><P CLASS=block> Tk::ObjScanner - Tk composite widget object scanner</P></STRONG>
- </TD></TR>
- </TABLE>
-
- </BODY>
-
- </HTML>
-