| 1 | package Tk::AppWindow::Ext::Panels; | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | Tk::AppWindow::Ext::Panels - manage the layout of your application | ||
| 6 | |||
| 7 | =cut | ||
| 8 | |||
| 9 | use strict; | ||
| 10 | use warnings; | ||
| 11 | use vars qw($VERSION); | ||
| 12 | $VERSION="0.20"; | ||
| 13 | use Tk; | ||
| 14 | require Tk::Adjuster; | ||
| 15 | require Tk::Pane; | ||
| 16 | |||
| 17 | use base qw( Tk::AppWindow::BaseClasses::Extension ); | ||
| 18 | |||
| 19 | =head1 SYNOPSIS | ||
| 20 | |||
| 21 | my $app = new Tk::AppWindow(@options, | ||
| 22 | -extensions => ['Panels'], | ||
| 23 | ); | ||
| 24 | $app->MainLoop; | ||
| 25 | |||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | Adds a layout of B<Frame> objects to the main window. | ||
| 30 | You can specify which frames should have a slider. | ||
| 31 | Each Frame can be in a shown or hidden state. | ||
| 32 | |||
| 33 | =head1 CONFIG VARIABLES | ||
| 34 | |||
| 35 | =over 4 | ||
| 36 | |||
| 37 | =item B<-panelgeometry> I<hookable> | ||
| 38 | |||
| 39 | Specifies the geometry manager used for the panel layout. Possible | ||
| 40 | values are 'pack' and 'grid'. Default value 'pack'. | ||
| 41 | |||
| 42 | =item B<-panellayout> I<hookable> | ||
| 43 | |||
| 44 | Specify the structure of your layout. | ||
| 45 | |||
| 46 | The keys used below are all home to the geometry manager used. Plus a | ||
| 47 | few more. These are: | ||
| 48 | |||
| 49 | =over 4 | ||
| 50 | |||
| 51 | =item B<-canhide> | ||
| 52 | |||
| 53 | Specify if a panel is capable of hiding and showing. By default 0. | ||
| 54 | |||
| 55 | =item B<-adjuster> | ||
| 56 | |||
| 57 | If specified the panel is adjustable. The value is transferred to the | ||
| 58 | B<-side> option of the adjuster. | ||
| 59 | |||
| 60 | =back | ||
| 61 | |||
| 62 | Default value: | ||
| 63 | |||
| 64 | [ | ||
| 65 | CENTER => { | ||
| 66 | -in => 'MAIN', | ||
| 67 | -side => 'top', | ||
| 68 | -fill => 'both', | ||
| 69 | -expand => 1, | ||
| 70 | }, | ||
| 71 | WORK => { | ||
| 72 | -in => 'CENTER', | ||
| 73 | -side => 'left', | ||
| 74 | -fill => 'both', | ||
| 75 | -expand => 1, | ||
| 76 | }, | ||
| 77 | TOP => { | ||
| 78 | -in => 'MAIN', | ||
| 79 | -side => 'top', | ||
| 80 | -before => 'CENTER', | ||
| 81 | -fill => 'x', | ||
| 82 | -canhide => 1, | ||
| 83 | }, | ||
| 84 | BOTTOM => { | ||
| 85 | -in => 'MAIN', | ||
| 86 | -after => 'CENTER', | ||
| 87 | -side => 'top', | ||
| 88 | -fill => 'x', | ||
| 89 | -canhide => 1, | ||
| 90 | }, | ||
| 91 | LEFT => { | ||
| 92 | -in => 'CENTER', | ||
| 93 | -before => 'WORK', | ||
| 94 | -side => 'left', | ||
| 95 | -fill => 'y', | ||
| 96 | -canhide => 1, | ||
| 97 | -adjuster => 'left', | ||
| 98 | }, | ||
| 99 | RIGHT => { | ||
| 100 | -in => 'CENTER', | ||
| 101 | -after => 'WORK', | ||
| 102 | -side => 'left', | ||
| 103 | -fill => 'y', | ||
| 104 | -canhide => 1, | ||
| 105 | -adjuster => 'right', | ||
| 106 | }, | ||
| 107 | ] | ||
| 108 | |||
| 109 | =item B<-workspace> I<hookable> | ||
| 110 | |||
| 111 | Specifies the central workspace of your application. | ||
| 112 | Default value is WORK. | ||
| 113 | |||
| 114 | =back | ||
| 115 | |||
| 116 | =cut | ||
| 117 | |||
| 118 | sub new { | ||
| 119 | my $class = shift; | ||
| 120 | my $self = $class->SUPER::new(@_); | ||
| 121 | $self->addPreConfig( | ||
| 122 | -showadjusteratcreate => ['PASSIVE', undef, undef, 1], | ||
| 123 | ); | ||
| 124 | my $args = $self->GetArgsRef; | ||
| 125 | my $panelgeometry = delete $args->{'-panelgeometry'}; | ||
| 126 | $panelgeometry = 'pack' unless defined $panelgeometry; | ||
| 127 | |||
| 128 | $self->{ADJUSTACTIVE} = {}; | ||
| 129 | $self->{ADJUSTERS} = {}; | ||
| 130 | $self->{ADJUSTGEO} = {}; | ||
| 131 | $self->{ADJUSTINFO} = {}; | ||
| 132 | $self->{GEOINFO} = {}; | ||
| 133 | $self->{LAYOUT} = undef; | ||
| 134 | $self->{PANELS} = {}; | ||
| 135 | $self->{PANELGEOMETRY} = $panelgeometry; | ||
| 136 | $self->{VISIBLE} = {}; | ||
| 137 | |||
| 138 | $self->configInit( | ||
| 139 | -panelgeometry => ['PanelGeometry', $self, $panelgeometry], | ||
| 140 | -panellayout => ['PanelLayOut', $self, [ | ||
| 141 | CENTER => { | ||
| 142 | -in => 'MAIN', | ||
| 143 | -side => 'top', | ||
| 144 | -fill => 'both', | ||
| 145 | -expand => 1, | ||
| 146 | }, | ||
| 147 | WORK => { | ||
| 148 | -in => 'CENTER', | ||
| 149 | -side => 'left', | ||
| 150 | -fill => 'both', | ||
| 151 | -expand => 1, | ||
| 152 | }, | ||
| 153 | TOP => { | ||
| 154 | -in => 'MAIN', | ||
| 155 | -side => 'top', | ||
| 156 | -before => 'CENTER', | ||
| 157 | -fill => 'x', | ||
| 158 | -canhide => 1, | ||
| 159 | }, | ||
| 160 | BOTTOM => { | ||
| 161 | -in => 'MAIN', | ||
| 162 | -after => 'CENTER', | ||
| 163 | -side => 'top', | ||
| 164 | -fill => 'x', | ||
| 165 | -canhide => 1, | ||
| 166 | }, | ||
| 167 | LEFT => { | ||
| 168 | -in => 'CENTER', | ||
| 169 | -before => 'WORK', | ||
| 170 | -side => 'left', | ||
| 171 | -fill => 'y', | ||
| 172 | -canhide => 1, | ||
| 173 | -paneloptions => [-width => 150], | ||
| 174 | -adjuster => 'left', | ||
| 175 | }, | ||
| 176 | RIGHT => { | ||
| 177 | -in => 'CENTER', | ||
| 178 | -after => 'WORK', | ||
| 179 | -side => 'left', | ||
| 180 | -fill => 'y', | ||
| 181 | -canhide => 1, | ||
| 182 | -paneloptions => [-width => 150], | ||
| 183 | -adjuster => 'right', | ||
| 184 | }, | ||
| 185 | |||
| 186 | ]], | ||
| 187 | -workspace => ['WorkSpace', $self->GetAppWindow, 'WORK'], | ||
| 188 | ); | ||
| 189 | |||
| 190 | |||
| 191 | return $self; | ||
| 192 | } | ||
| 193 | |||
| 194 | =head1 METHODS | ||
| 195 | |||
| 196 | =over 4 | ||
| 197 | |||
| 198 | |||
| 199 | =cut | ||
| 200 | |||
| 201 | sub adjusterActive { | ||
| 202 | my $self = shift; | ||
| 203 | my $panel = shift; | ||
| 204 | $self->{ADJUSTACTIVE}->{$panel} = shift if @_; | ||
| 205 | my $active = $self->{ADJUSTACTIVE}->{$panel}; | ||
| 206 | return 1 unless defined $active; | ||
| 207 | return $active; | ||
| 208 | } | ||
| 209 | |||
| 210 | sub adjusterAssign { | ||
| 211 | my ($self , $name, $panel, $adjuster, $row, $col) = @_; | ||
| 212 | $self->{ADJUSTINFO}->{$name} = { | ||
| 213 | -widget => $panel, | ||
| 214 | -side => $adjuster, | ||
| 215 | }; | ||
| 216 | my $geoinf = $self->{GEOINFO}->{$name}; | ||
| 217 | if ($self->PanelGeometry eq 'grid') { | ||
| 218 | my $prow = $geoinf->{'-row'}; | ||
| 219 | my $pcolumn = $geoinf->{'-column'}; | ||
| 220 | my $sticky; | ||
| 221 | if ($adjuster eq 'left') { | ||
| 222 | $sticky = 'ns'; | ||
| 223 | } elsif ($adjuster eq 'right') { | ||
| 224 | $sticky = 'ns'; | ||
| 225 | } elsif ($adjuster eq 'top') { | ||
| 226 | $sticky = 'ew'; | ||
| 227 | } elsif ($adjuster eq 'bottom') { | ||
| 228 | $sticky = 'ew'; | ||
| 229 | } | ||
| 230 | unless (defined $row) { | ||
| 231 | if ($adjuster eq 'left') { | ||
| 232 | $row = $prow; | ||
| 233 | } elsif ($adjuster eq 'right') { | ||
| 234 | $row = $prow; | ||
| 235 | } elsif ($adjuster eq 'top') { | ||
| 236 | $row = $prow + 1 | ||
| 237 | } elsif ($adjuster eq 'bottom') { | ||
| 238 | $row = $prow - 1 | ||
| 239 | } | ||
| 240 | } | ||
| 241 | unless (defined $col) { | ||
| 242 | if ($adjuster eq 'left') { | ||
| 243 | $col = $pcolumn + 1; | ||
| 244 | } elsif ($adjuster eq 'right') { | ||
| 245 | $col = $pcolumn - 1; | ||
| 246 | } elsif ($adjuster eq 'top') { | ||
| 247 | $col = $pcolumn; | ||
| 248 | } elsif ($adjuster eq 'bottom') { | ||
| 249 | $col = $pcolumn; | ||
| 250 | } | ||
| 251 | } | ||
| 252 | $self->{ADJUSTGEO}->{$name} = { | ||
| 253 | -sticky => $sticky, | ||
| 254 | -row => $row, | ||
| 255 | -column => $col, | ||
| 256 | }; | ||
| 257 | } else { | ||
| 258 | $self->{ADJUSTGEO}->{$name} = $geoinf; | ||
| 259 | } | ||
| 260 | } | ||
| 261 | |||
| 262 | sub adjusterClear { | ||
| 263 | my ($self, $panel) = @_; | ||
| 264 | my $adj = $self->{ADJUSTERS}->{$panel}; | ||
| 265 | $self->geoForget($adj) if defined $adj; | ||
| 266 | } | ||
| 267 | |||
| 268 | sub adjusterDefine { | ||
| 269 | my $self = shift; | ||
| 270 | my $panel = shift; | ||
| 271 | $self->{ADJUSTINFO}->{$panel} = { @_} | ||
| 272 | } | ||
| 273 | |||
| 274 | sub adjusterSet { | ||
| 275 | my ($self , $panel) = @_; | ||
| 276 | my $adjgeo = $self->{ADJUSTGEO}->{$panel}; | ||
| 277 | my $adjustinfo = $self->{ADJUSTINFO}->{$panel}; | ||
| 278 | if (defined $adjustinfo) { | ||
| 279 | my $adj = $self->{ADJUSTERS}->{$panel}; | ||
| 280 | unless (defined $adj) { | ||
| 281 | my $parent = $self->Subwidget($panel)->parent; | ||
| 282 | $adj = $parent->Adjuster(%$adjustinfo); | ||
| 283 | $self->{ADJUSTERS}->{$panel} = $adj; | ||
| 284 | } | ||
| 285 | $self->geoShow($adj, %$adjgeo); | ||
| 286 | } | ||
| 287 | } | ||
| 288 | |||
| 289 | sub adjusterStatus { | ||
| 290 | my ($self, $panel) = @_; | ||
| 291 | return exists $self->{ADJUSTERS}->{$panel} | ||
| 292 | } | ||
| 293 | |||
| 294 | sub adjusterWidget { | ||
| 295 | my ($self , $panel, $widget) = @_; | ||
| 296 | my $adjustinfo = $self->{ADJUSTINFO}->{$panel}; | ||
| 297 | $adjustinfo->{'-widget'} = $widget if defined $widget; | ||
| 298 | return $adjustinfo->{'-widget'}; | ||
| 299 | } | ||
| 300 | |||
| 301 | sub geoForget { | ||
| 302 | my $self = shift; | ||
| 303 | my $widget = shift; | ||
| 304 | my $gm = $self->PanelGeometry; | ||
| 305 | $gm = $gm . 'Forget'; | ||
| 306 | $widget->$gm; | ||
| 307 | } | ||
| 308 | |||
| 309 | sub geoShow { | ||
| 310 | my $self = shift; | ||
| 311 | my $widget = shift; | ||
| 312 | my $gm = $self->PanelGeometry; | ||
| 313 | my %options = @_; | ||
| 314 | my $weight = delete $options{'-weight'}; | ||
| 315 | if (defined $weight) { | ||
| 316 | my $par = $widget->parent; | ||
| 317 | my $sticky = $options{'-sticky'}; | ||
| 318 | if (defined $sticky) { | ||
| 319 | if (($sticky =~ /e/) and ($sticky =~ /w/)) { | ||
| 320 | my $col = $options{'-column'}; | ||
| 321 | $par->gridColumnconfigure($col, '-weight', $weight); | ||
| 322 | } | ||
| 323 | if (($sticky =~ /n/) and ($sticky =~ /s/)) { | ||
| 324 | my $row = $options{'-row'}; | ||
| 325 | $par->gridRowconfigure($row, '-weight', $weight); | ||
| 326 | } | ||
| 327 | } | ||
| 328 | } | ||
| 329 | $widget->$gm(%options); | ||
| 330 | } | ||
| 331 | |||
| 332 | sub layout { return $_[0]->{LAYOUT}} | ||
| 333 | |||
| 334 | sub MenuItems { | ||
| 335 | my $self = shift; | ||
| 336 | my @items = ( | ||
| 337 | # type menupath label cmd icon keyb config variable | ||
| 338 | [ 'menu', undef, "~View"], | ||
| 339 | ); | ||
| 340 | my @list = $self->panelList; | ||
| 341 | for (@list) { | ||
| 342 | push @items, [ 'menu_check', 'View::', "Show ~$_", undef, $self->panelOptName($_), undef, 0, 1], | ||
| 343 | } | ||
| 344 | return @items | ||
| 345 | } | ||
| 346 | |||
| 347 | sub menuRefresh { | ||
| 348 | my $self = shift; | ||
| 349 | my $mnu = $self->extGet('MenuBar'); | ||
| 350 | $mnu->ReConfigure if (defined $mnu) and (not $self->configMode); | ||
| 351 | } | ||
| 352 | |||
| 353 | =item panelAssignI<($name, ?$panel?)> | ||
| 354 | |||
| 355 | Returns the panel assigned to I<$name>. | ||
| 356 | |||
| 357 | If I<$panel> is specified assigns I<$name> to <$panel> | ||
| 358 | and creates a menu entry for I<$name>> in the View menu. | ||
| 359 | |||
| 360 | =cut | ||
| 361 | |||
| 362 | sub panelAssign { | ||
| 363 | my ($self, $name, $panel) = @_; | ||
| 364 | my $p = $self->{PANELS}; | ||
| 365 | if (defined $panel) { | ||
| 366 | $p->{$name} = $panel; | ||
| 367 | $self->{VISIBLE}->{$name} = 1; | ||
| 368 | my $opt = $self->panelOptName($name); | ||
| 369 | $self->configInit($opt => ['panelVisible', $self, $panel, 1]); | ||
| 370 | $self->menuRefresh; | ||
| 371 | } | ||
| 372 | return $p->{$name}; | ||
| 373 | } | ||
| 374 | |||
| 375 | =item B<panelDelete>I<($name)> | ||
| 376 | |||
| 377 | Deletes I<$name> from the list of assigned panels and | ||
| 378 | removes its menu entry in the View menu. | ||
| 379 | |||
| 380 | =cut | ||
| 381 | |||
| 382 | sub panelDelete { | ||
| 383 | my ($self, $name) = @_; | ||
| 384 | delete $self->{PANELS}->{$name}; | ||
| 385 | delete $self->{VISIBLE}->{$name}; | ||
| 386 | my $opt = $self->panelOptName($name); | ||
| 387 | $self->configRemove($opt); | ||
| 388 | $self->menuRefresh; | ||
| 389 | } | ||
| 390 | |||
| 391 | sub PanelGeometry { | ||
| 392 | my $self = shift; | ||
| 393 | $self->{PANELGEOMETRY} = shift if @_; | ||
| 394 | return $self->{PANELGEOMETRY} | ||
| 395 | } | ||
| 396 | |||
| 397 | |||
| 398 | |||
| 399 | =item B<panelGet>I<($name)> | ||
| 400 | |||
| 401 | Returns the name of the assigned panel to $name | ||
| 402 | |||
| 403 | =cut | ||
| 404 | |||
| 405 | sub panelGet { | ||
| 406 | my ($self, $name) = @_; | ||
| 407 | return $self->{PANELS}->{$name}; | ||
| 408 | } | ||
| 409 | |||
| 410 | =item B<panelHide>I<($panel)> | ||
| 411 | |||
| 412 | panelHide $panel and its adjuster if any. | ||
| 413 | |||
| 414 | =cut | ||
| 415 | |||
| 416 | sub panelHide { | ||
| 417 | my ($self, $panel) = @_; | ||
| 418 | unless ($self->panelIsHidden($panel)) { | ||
| 419 | $self->geoForget($self->Subwidget($panel)); | ||
| 420 | $self->adjusterClear($panel); | ||
| 421 | } | ||
| 422 | } | ||
| 423 | |||
| 424 | =item B<panelIsHidden>I<($panel)> | ||
| 425 | |||
| 426 | Returns the state of $panel. 1 if hidden, 0 if not. | ||
| 427 | |||
| 428 | =cut | ||
| 429 | |||
| 430 | sub panelIsHidden { | ||
| 431 | my ($self, $panel) = @_; | ||
| 432 | my $mapped = $self->Subwidget($panel)->ismapped; | ||
| 433 | return not $mapped ; | ||
| 434 | } | ||
| 435 | |||
| 436 | sub PanelLayOut { | ||
| 437 | my ($self, $layout) = @_; | ||
| 438 | return unless defined $layout; | ||
| 439 | $self->{LAYOUT} = $layout; | ||
| 440 | my $panelgeometry = $self->configGet('-panelgeometry'); | ||
| 441 | my @l = @$layout; | ||
| 442 | while (@l) { | ||
| 443 | my $name = shift @l; | ||
| 444 | my $options = shift @l; | ||
| 445 | |||
| 446 | my $in = delete $options->{'-in'}; | ||
| 447 | die "Error in '$name'. Option -in must be specified" unless defined $in; | ||
| 448 | |||
| 449 | my $canhide = delete $options->{'-canhide'}; | ||
| 450 | $canhide = 0 unless defined $canhide; | ||
| 451 | |||
| 452 | my $parent; | ||
| 453 | if ($in eq 'MAIN') { | ||
| 454 | $parent = $self->GetAppWindow; | ||
| 455 | } else { | ||
| 456 | $parent = $self->Subwidget($in) | ||
| 457 | } | ||
| 458 | die "Error in '$name'. Panel $in does not exist" unless defined $parent; | ||
| 459 | |||
| 460 | my $before = delete $options->{'-before'}; | ||
| 461 | if (defined $before) { | ||
| 462 | my $neighbor = $self->Subwidget($before); | ||
| 463 | die "Error in '$name'. Panel $neighbor does not exist" unless defined $neighbor; | ||
| 464 | $options->{'-before'} = $neighbor; | ||
| 465 | } | ||
| 466 | |||
| 467 | my $after = delete $options->{'-after'}; | ||
| 468 | if (defined $after) { | ||
| 469 | my $neighbor = $self->Subwidget($after); | ||
| 470 | die "Error in '$name'. Panel $neighbor does not exist" unless defined $neighbor; | ||
| 471 | $options->{'-after'} = $neighbor; | ||
| 472 | } | ||
| 473 | |||
| 474 | my $paneloptions = delete $options->{'-paneloptions'}; | ||
| 475 | $paneloptions = [] unless defined $paneloptions; | ||
| 476 | |||
| 477 | my $adjuster = delete $options->{'-adjuster'}; | ||
| 478 | my $adjrow = delete $options->{'-adjusterrow'}; | ||
| 479 | my $adjcolumn = delete $options->{'-adjustercolumn'}; | ||
| 480 | |||
| 481 | my $panel = $parent->Frame(@$paneloptions); | ||
| 482 | |||
| 483 | $self->Advertise($name, $panel); | ||
| 484 | |||
| 485 | $self->{GEOINFO}->{$name} = $options; | ||
| 486 | $self->adjusterAssign($name, $panel, $adjuster, $adjrow, $adjcolumn) if defined $adjuster; | ||
| 487 | $self->geoShow($panel, %$options) unless $canhide; | ||
| 488 | } | ||
| 489 | } | ||
| 490 | |||
| 491 | =item B<panelList> | ||
| 492 | |||
| 493 | Returns a list of assigned panels | ||
| 494 | |||
| 495 | =cut | ||
| 496 | |||
| 497 | sub panelList { | ||
| 498 | my $self = shift; | ||
| 499 | my $p = $self->{PANELS}; | ||
| 500 | return sort keys %$p | ||
| 501 | } | ||
| 502 | |||
| 503 | sub panelOptName { | ||
| 504 | my ($self, $name) = @_; | ||
| 505 | return "-$name" . 'visible'; | ||
| 506 | } | ||
| 507 | |||
| 508 | =item B<panelShow>I<($panel)> | ||
| 509 | |||
| 510 | Show $panel and its adjuster if any. | ||
| 511 | |||
| 512 | =cut | ||
| 513 | |||
| 514 | sub panelShow { | ||
| 515 | my ($self, $name) = @_; | ||
| 516 | if ($self->panelIsHidden($name)) { | ||
| 517 | my $panel = $self->Subwidget($name); | ||
| 518 | my $packinfo = $self->{GEOINFO}->{$name}; | ||
| 519 | $self->geoShow($panel, %$packinfo); | ||
| 520 | $self->adjusterSet($name) if $self->adjusterActive($name); | ||
| 521 | } | ||
| 522 | } | ||
| 523 | |||
| 524 | sub panelVisible { | ||
| 525 | my $self = shift; | ||
| 526 | my $panel = shift; | ||
| 527 | if (@_) { | ||
| 528 | my $status = shift; | ||
| 529 | if ($self->configMode) { | ||
| 530 | } elsif ($status eq 1) { | ||
| 531 | $self->panelShow($panel); | ||
| 532 | } elsif ($status eq 0) { | ||
| 533 | $self->panelHide($panel); | ||
| 534 | } | ||
| 535 | $self->{VISIBLE}->{$panel} = $status; | ||
| 536 | } | ||
| 537 | return $self->{VISIBLE}->{$panel} | ||
| 538 | } | ||
| 539 | |||
| 540 | =back | ||
| 541 | |||
| 542 | =head1 AUTHOR | ||
| 543 | |||
| 544 | Hans Jeuken (hanje at cpan dot org) | ||
| 545 | |||
| 546 | =head1 BUGS | ||
| 547 | |||
| 548 | Unknown. If you find any, please contact the author. | ||
| 549 | |||
| 550 | =head1 SEE ALSO | ||
| 551 | |||
| 552 | =over 4 | ||
| 553 | |||
| 554 | =item L<Tk::AppWindow> | ||
| 555 | |||
| 556 | =item L<Tk::AppWindow::BaseClasses::Extension> | ||
| 557 | |||
| 558 | =back | ||
| 559 | |||
| 560 | =cut | ||
| 561 | |||
| 562 | 1; | ||
| 563 | |||
| 564 | |||
| 565 | |||
| 566 |