1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
|
#
# This file is part of Config-Model-TkUI
#
# This software is Copyright (c) 2008-2021 by Dominique Dumont.
#
# This is free software, licensed under:
#
# The GNU Lesser General Public License, Version 2.1, February 1999
#
package Config::Model::Tk::AnyViewer 1.379;
use strict;
use warnings;
use Carp;
use Tk::Photo;
use Tk::ROText;
use Tk::Dialog;
use Config::Model 2.139;
use Config::Model::TkUI;
use Log::Log4perl qw(get_logger :levels);
use Tk::Pod::Text;
use vars qw/$icon_path/;
my $logger = get_logger("Tk");
my @fbe1 = qw/-fill both -expand 1/;
my @fxe1 = qw/-fill x -expand 1/;
my @fb = qw/-fill both /;
my @fx = qw/-fill x /;
my @e1 = qw/ -expand 1/;
my %img;
*icon_path = *Config::Model::TkUI::icon_path;
sub add_header {
my ( $cw, $type, $item ) = @_;
unless (%img) {
$img{edit} = $cw->Photo( -file => $icon_path . 'wizard.png' );
$img{view} = $cw->Photo( -file => $icon_path . 'viewmag.png' );
}
my $idx;
$idx = $item->index_value if $item->can('index_value');
my $elt_name = $item->composite_name;
my $parent = $item->parent;
my $class =
defined $parent
? $item->parent->config_class_name
: $item->config_class_name;
$cw->{config_class_name} = $class;
my $label = "$type: ";
$label .= $item->location_short || "Class $class";
my $f = $cw->Frame;
$f->Label( -image => $img{ lc($type) }, -anchor => 'w' )->pack( -side => 'left' );
$f->Label( -text => $label, -anchor => 'e' )->pack( -side => 'left', @fx );
return $f;
}
my @top_frame_args = qw/-relief raised -borderwidth 4/;
my @low_frame_args = qw/-relief sunken -borderwidth 1/;
my $padx = 20;
sub add_info_button {
my $cw = shift;
my $frame = shift || $cw;
my $elt_name = $cw->cme_object->element_name;
my @items = $cw->cme_object->get_info;
my $title = "Info on " . $cw->{config_class_name};
$title .= ':' . $elt_name if $elt_name;
my $dialog = $cw->Dialog(
-title => $title,
-text => join( "\n", $title, @items ),
);
my $button = $frame->Button(
-text => "info ...",
-command => sub { $dialog->Show; } );
return $button; # to be packed by caller
}
# returns the help widget (Label or ROText) which must be packed by caller
sub add_help {
my $cw = shift;
my $help_label = shift;
my $help = shift || '';
my $force_text_widget = shift || ''; # pod or text
my $help_frame = $cw->Frame();
return $help_frame unless $force_text_widget or $help;
$help_frame->Label( -text => $help_label, )->pack( -anchor => 'w' );
my $widget;
chomp $help;
# if ( $force_text_widget eq 'pod' or $help =~ /\n=\w+|[A-Z]</ ) {
if ( $force_text_widget or $help =~ /\n/ or length($help) > 50 ) {
$widget = $help_frame->PodText( -height => 6, -scrollbars => 'oe' );
$widget->base_font_size(12);
$widget->pack(@fbe1);
$cw->update_help( $widget, $help );
}
# elsif ($force_text_widget or $help =~ /\n/ or length($help) > 50) {
# $widget = $help_frame->Scrolled('ROText',
# -scrollbars => 'ow',
# -wrap => 'word',
# -font => $text_font ,
# -relief => 'ridge',
# -height => 4,
# );
#
# $widget ->pack( @fbe1 ) ->insert('end',$help,'help') ;
# $widget
# ->tagConfigure(qw/help -lmargin1 2 -lmargin2 2 -rmargin 2/);
# }
elsif ( $help =~ /\w/ ) {
$widget = $help_frame->Label(
-text => $help,
-justify => 'left',
-anchor => 'w',
-padx => $padx,
)->pack( -fill => 'x' );
}
return wantarray ? ( $help_frame, $widget ) : $help_frame;
}
sub update_help {
my ( $cw, $w, $help ) = @_;
# work around RT #67306
my $t = $cw->toplevel->cget('-title');
$w->text("\n\n=pod\n\n\n=encoding utf8\n\n$help\n\n=cut\n\n");
$w->toplevel->title($t);
}
sub add_summary {
my ( $cw, $elt_obj ) = @_;
my $p = $elt_obj->parent;
my $name = $elt_obj->element_name;
return $cw->add_help( Summary => $p->get_help( summary => $name ) );
}
sub add_description {
my ( $cw, $elt_obj ) = @_;
my $p = $elt_obj->parent;
my $name = $elt_obj->element_name;
return $cw->add_help( Description => $p->get_help( description => $name ) );
}
sub add_warning {
my ( $cw, $elt_obj, $usage ) = @_;
my $frame = $cw->Frame; # packed by caller
my $inner_frame = $frame->Frame; # packed by update_warning
my $label_button_frame = $inner_frame->Frame->pack(@fxe1);
$label_button_frame->Label( -text => 'Issues', )
->pack( -anchor => 'w', -side => 'left', -fill => 'x' );
if ( $usage eq 'edit' ) {
my $nb_fixes = $elt_obj->has_fixes || 0;
my $fix_widget = $label_button_frame->Button(
-text => "Apply $nb_fixes fixes",
-state => $nb_fixes ? 'normal' : 'disabled'
);
$fix_widget->pack( -anchor => 'e', -side => 'right' );
$cw->Advertise( fix_widget => $fix_widget );
}
my $warn_widget = $inner_frame->Scrolled(
'ROText',
-scrollbars => 'ow',
-wrap => 'word',
-relief => 'ridge',
-height => 4,
);
my $err = $elt_obj->error_msg || '';
$warn_widget->pack(@fbe1)->insert( 'end', $err, 'error' );
$warn_widget->tagConfigure(qw/error -lmargin1 2 -lmargin2 2 -rmargin 2 -background red/);
my $msg = $elt_obj->warning_msg || '';
$msg .= "with " . $elt_obj->has_fixes . " fixes" if $msg;
$warn_widget->pack(@fbe1)->insert( 'end', $msg, 'warning' );
$warn_widget->tagConfigure(qw/warning -lmargin1 2 -lmargin2 2 -rmargin 2 -background orange/);
$logger->debug( "creating warning widget"
. ( $err ? " with errors" : '' )
. ( $msg ? " with warnings" : '' ) );
$cw->Advertise( warn_widget => $warn_widget );
$cw->Advertise( warn_frame => $inner_frame );
$cw->update_warning($elt_obj);
return $frame;
}
sub update_warning {
my ( $cw, $elt_obj ) = @_;
my $wf = $cw->Subwidget('warn_frame');
my $ww = $cw->Subwidget('warn_widget');
my $fw = $cw->Subwidget('fix_widget');
$ww->delete( '0.0', 'end' );
$elt_obj->check;
my $err = $elt_obj->error_msg || '';
$ww->insert( 'end', $err, 'error' ) if $err;
my $msg = $elt_obj->warning_msg || '';
if ( ref($msg) eq 'HASH' ) {
$msg = join( '', map { join( "\n\t", @{ $msg->{$_} } ) } sort keys %$msg );
}
$ww->insert( 'end', $msg, 'warning' ) if $msg;
$logger->debug( "updating warning widget"
. ( $err ? " with errors" : '' )
. ( $msg ? " with warnings" : '' ) );
if ( $msg or $err ) {
$wf->pack(@fbe1);
if ( $msg and defined $fw ) {
my $nb_fixes = $elt_obj->has_fixes;
$fw->configure(
-text => "Apply $nb_fixes fixes",
-command => sub {
$elt_obj->apply_fixes;
$cw->reset_value;
$cw->update_warning($elt_obj);
$cw->{store_cb}->();
},
-state => $nb_fixes ? 'normal' : 'disabled'
);
}
}
else {
$wf->packForget;
}
}
# returns a widget that must be packed
sub add_annotation {
my ( $cw, $obj ) = @_;
return $cw->add_help( 'Note', $obj->annotation );
}
sub add_editor_button {
my ( $cw, $path ) = @_;
my $sub = sub {
$cw->parent->parent->parent->parent->create_element_widget( edit => $path );
};
return $cw->Button( -text => 'Edit ...', -command => $sub );
}
# do nothing by default
sub reload { }
1;
|