NAME

VcsTools::HistEdit - Tk composite widget to edit a Vcs History

SYNOPSIS

$widget->HistoryEditor( name => 'dummy', 
                        revision=> '1.1', 
                        'format' => $logDataFormat,
                        callback => sub{$self->setInfo(@_)}, 
                        'info' => $self->{info} ) ;

No more synopsis given. This widget must be used by VcsTools::Version.

DESCRIPTION

This composite Tk Widget is used to edit the log information of a Vcs file.

The fields of the editor are set according to the 'format' parameter passed during the widget creation.

Each field feature a 'recall' button which will recall the last archived value of the field. You may click several times on the 'recall' button to get older values.

Constructor

HistoryEditor('name'=> '...', ...)

Parameters are :

• name: optional name

• revision : revision number of the edited version

• callback: sub to be called when the user clicks the "archive" button.

  The user's routine will get the info hash ref as first parameter.

• info : info hash ref that will be edited (optionnal)

• format : data format array reference.

DATA FORMAT

Each element of the array is a hash ref. This hash ref contains :

• name : name of the field as seen by the yser.

• var : variable name used in internal hash (default = name), and through the VcsTools objects.

• type : is either line, enum or array or text (see below)

• values : array ref containing the possible values of enum type (ignored for other types)

• mode : specifies if the value can be modified (r|w) (default 'w')

• help : The help information can either be a string that will be displayed with a Tk::Dialog or a pointer to a Pod file that will be displayed with a Tk::pod window.

  In case of pod information, the help hash must be like : { 'class' => 'Your::Class', 'section' => 'DECRIPTION' # optionnal }

DATA TYPES

• line: The editor uses an Entry widget to edit this type.

• enum: The editor uses a RadioButton widget to edit this type. The possible values of the Buttons are set by the 'values' parameter of the data format.

• array: The editor uses an Entry widget to edit this type. Array element will be separated by a comma or a white space.

• text: The editor uses an Text widget to edit this type.

AUTHOR

Dominique Dumont, Dominique_Dumont@grenoble.hp.com

Copyright (c) 1998 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.

SEE ALSO

perl(1), Tk(3), Puppet::Any(3), VcsTools::DataSpec::HpTnd(3), VcsTools::Version(3)