NAME

Config::Model::TkUI - Tk GUI to edit config data through Config::Model

SYNOPSIS

 use Config::Model::TkUI;

 # init trace
 Log::Log4perl->easy_init($WARN);

 # create configuration instance
 my $model = Config::Model -> new ;
 my $inst = $model->instance (root_class_name => 'a_config_class',
                              instance_name   => 'test');
 my $root = $inst -> config_root ;

 # Tk part
 my $mw = MainWindow-> new ;
 $mw->withdraw ;
 $mw->ConfigModelUI (-root => $root) ;

 MainLoop ;

DESCRIPTION

This class provides a GUI for Config::Model.

With this class, Config::Model and an actual configuration model (like Config::Model::Xorg), you get a tool to edit configuration files (e.g. /etc/X11/xorg.conf).

Be default, only items with beginner experience are shown. You can change the experience level in Options -> experience menu.

USAGE

Left side tree

Click on '+' and '-' boxes to open or close content
Left-click on item to open a viewer widget.
Right-click on any item to open an editor widget
Use Ctrl-C to copy configuration data in an internal buffer
Use Ctrl-V to copy configuration data from the internal buffer to the configuration tree. Beware, there's no "undo" operation.
Pasting cut buffer into:
- a leaf element will store the content of the buffer into the element.
- a list element will split the content of the buffer with /\n/ or /,/ and push the resulting array at the end of the list element.
- a hash element will use the content of the cut buffer to create a new key in the hash element.

Search

Hit Ctrl-F or use menu Edit -> Search to open a search widget at the bottom of the window.

Enter a keyword in the entry widget and click on Next button.

The keyword will be searched in the configuration tree, in element name, in element value and in documentation.

Editor widget

The right side of the widget is either a viewer or an editor. When clicking on store in the editor, the new data is stored in the tree represented on the left side of TkUI. The new data will be stored in the configuration file only when File-save> menu is invoked.

Wizard

A wizard can be launched either with File -> Wizard menu entry or with Run Wizard button.

The wizard will scan the configuration tree and stop on all items flagged as important in the model. It will also stop on all erroneous items (mostly missing mandatory values).

TODO

- Document widget options. (-root_model and -store_sub, -quit) - add tabular view ? - expand the whole tree at once - add plug-in mechanism so that dedicated widget can be used for some config Class (Could be handy for Xorg::ServerLayout)

AUTHOR

Dominique Dumont, (ddumont at cpan dot org)

LICENSE

    Copyright (c) 2008-2011 Dominique Dumont.

    This file is part of Config-Model.

    Config-Model is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser Public License as
    published by the Free Software Foundation; either version 2.1 of
    the License, or (at your option) any later version.

    Config-Model is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser Public License for more details.

    You should have received a copy of the GNU Lesser Public License
    along with Config-Model; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
    02110-1301 USA

FEEDBACK and HELP wanted

This project needs feedback from its users. Please send your feedbacks, comments and ideas to :

  config-mode-users at lists.sourceforge.net

This projects also needs help to improve its user interfaces:

Look and feel of Perl/Tk interface can be improved
A nicer logo (maybe a penguin with a wrench...) would be welcomed
Config::Model could use a web interface
May be also an interface based on Gtk or Wx for better integration in Desktop

If you want to help, please send a mail to:

  config-mode-devel at lists.sourceforge.net