Gtk2::Ex::FormFactory::CheckButtonGroup - A group of checkbuttons

  Gtk2::Ex::FormFactory::CheckButtonGroup->new (
    max_columns        => Maximum number of columns,
    max_rows           => Maximum number of rows,
    column_labels      => Array of column label strings,
    row_labels	       => Array of row label strings,

    attr_max_columns   => Object attribute for number of columns,
    attr_max_rows      => Object attribute for number of rows,
    attr_column_labels => Object attribute for column labels,
    attr_row_labels    => Object attribute for row labels,

    homogeneous	       => Force homogeneous layout of underlying table?
    ...
    Gtk2::Ex::FormFactory::Widget attributes
  );

  Gtk2::Ex::FormFactory::Intro

  Gtk2::Ex::FormFactory::Widget
  +--- Gtk2::Ex::FormFactory::CheckButtonGroup

  Gtk2::Ex::FormFactory::Layout
  Gtk2::Ex::FormFactory::Rules
  Gtk2::Ex::FormFactory::Context
  Gtk2::Ex::FormFactory::Proxy

 Jörn Reder <joern at zyn dot de>

package Gtk2::Ex::FormFactory::CheckButtonGroup;

use Carp;
use strict;

use base qw( Gtk2::Ex::FormFactory::Widget );
use POSIX qw(ceil);

sub get_type { "check_button_group" }

sub get_max_columns		{ shift->{max_columns}			}
sub get_max_rows		{ shift->{max_rows}			}
sub get_attr_max_columns	{ shift->{attr_max_columns}		}
sub get_attr_max_rows		{ shift->{attr_max_rows}		}
sub get_column_labels		{ shift->{column_labels}		}
sub get_attr_column_labels	{ shift->{attr_column_labels}		}
sub get_row_labels		{ shift->{row_labels}			}
sub get_attr_row_labels		{ shift->{attr_row_labels}		}
sub get_homogeneous		{ shift->{homogeneous}			}

sub set_max_columns		{ shift->{max_columns}		= $_[1]	}
sub set_max_rows		{ shift->{max_rows}		= $_[1]	}
sub set_attr_max_columns	{ shift->{attr_max_columns}	= $_[1]	}
sub set_attr_max_rows		{ shift->{attr_max_rows}	= $_[1]	}
sub set_column_labels		{ shift->{column_labels}	= $_[1]	}
sub set_attr_column_labels	{ shift->{attr_column_labels}	= $_[1]	}
sub set_row_labels		{ shift->{row_labels}		= $_[1]	}
sub set_attr_row_labels		{ shift->{attr_row_labels}	= $_[1]	}
sub set_homogeneous		{ shift->{homogeneous}		= $_[1]	}

sub get_gtk_check_buttons	{ shift->{gtk_check_buttons}		}
sub get_gtk_table		{ shift->{gtk_table}			}

sub set_gtk_check_buttons	{ shift->{gtk_check_buttons}	= $_[1]	}
sub set_gtk_table		{ shift->{gtk_table}		= $_[1]	}

sub get_last_toggled_value	{ shift->{last_toggled_value}		}
sub set_last_toggled_value	{ shift->{last_toggled_value}	= $_[1]	}

sub get_in_selection_update	{ shift->{in_selection_update}		}
sub set_in_selection_update	{ shift->{in_selection_update}	= $_[1]	}

sub new {
	my $class = shift;
	my %par = @_;
	my  ($max_columns, $max_rows, $attr_max_columns, $attr_max_rows) =
	@par{'max_columns','max_rows','attr_max_columns','attr_max_rows'};
	my  ($column_labels, $attr_column_labels, $row_labels) =
	@par{'column_labels','attr_column_labels','row_labels'};
	my  ($attr_row_labels, $homogeneous) =
	@par{'attr_row_labels','homogeneous'};

	my $self = $class->SUPER::new(@_);

	$max_rows = 1 if ($max_rows == 0 && $max_columns == 0) &&
			 !($attr_max_rows || $attr_max_columns);
	
	$homogeneous = 1 if not defined $homogeneous;
	
	$self->set_max_columns 		($max_columns);
	$self->set_max_rows 		($max_rows);
	$self->set_attr_max_columns	($attr_max_columns);
	$self->set_attr_max_rows 	($attr_max_rows);
	$self->set_column_labels  	($column_labels); 
	$self->set_attr_column_labels 	($attr_column_labels);
	$self->set_row_labels 		($row_labels);
	$self->set_attr_row_labels 	($attr_row_labels);
	$self->set_homogeneous 		($homogeneous);

	return $self;
}

sub cleanup {
	my $self = shift;
	
	$self->SUPER::cleanup(@_);
	
	$self->set_gtk_check_buttons(undef);
	$self->set_gtk_table(undef);

	1;
}

sub object_to_widget {
	my $self = shift;
	
	#-- $checkboxes = [ [0, "Sun"], [1 ,"Mon"], [2,"Tue"], ... ]
	my $checkboxes = $self->get_proxy->get_attr_list(
		$self->get_attr, $self->get_name
	);

	#-- $selected_href = { 0 => 1, 2 => 1 }  - Sun and Tue are selected
	my $selected_href = $self->get_object_value;
	
	my $hbox = $self->get_gtk_widget;
	my @children = $hbox->get_children;
	$hbox->remove($_) for @children;

	my ($rows, $columns);
	my $max_rows      = $self->get_max_rows;
	my $max_columns   = $self->get_max_columns;
	my $row_labels    = $self->get_row_labels;
	my $column_labels = $self->get_column_labels;

	my $cnt = @{$checkboxes};

	if ( $self->get_attr_max_rows ) {
		$max_rows = $self->get_proxy->get_attr($self->get_attr_max_rows);
	} elsif ( $self->get_attr_max_columns ) {
		$max_columns = $self->get_proxy->get_attr($self->get_attr_max_columns);
	}

	if ( $self->get_attr_row_labels ) {
		$row_labels = $self->get_proxy->get_attr($self->get_attr_row_labels);
	}
	
	if ( $self->get_attr_column_labels ) {
		$column_labels = $self->get_proxy->get_attr($self->get_attr_column_labels);
	}

	if ( $max_rows ) {
		$rows = $max_rows;
		$rows = $cnt if $rows > $cnt;
		$columns = ceil($cnt / $rows);
	} else {
		$columns = $max_columns;
		$columns = $cnt if $columns > $cnt;
		$rows = ceil($cnt / $columns);
	}

	my %gtk_check_buttons;
	my $gtk_table = Gtk2::Table->new ($rows, $columns);
	$gtk_table->set ( homogeneous => $self->get_homogeneous );
	
	++$columns if $row_labels;
	++$rows    if $column_labels;
	
	my $i = 0;
	for ( my $c=0; $c < $columns && $i < $cnt; ++$c ) {
		for ( my $r=0; $r < $rows && $i < $cnt; ++$r ) {
			next if $column_labels && $c == 0 && $r == 0;
			if ( $row_labels && $c==0 && $r > 0 ) {
			    my $gtk_label = Gtk2::Label->new($row_labels->[$r-1]);
			    $gtk_table->attach_defaults($gtk_label, $c, $c+1, $r, $r+1);
			    next;
			}
			if ( $column_labels && $r==0 && $c > 0 ) {
			    my $gtk_label = Gtk2::Label->new($column_labels->[$c-1]);
			    $gtk_table->attach_defaults($gtk_label, $c, $c+1, $r, $r+1);
			    next;
			}
			my $checkbox = $checkboxes->[$i];
			my $gtk_check_button = Gtk2::CheckButton->new($checkbox->[1]);
			$gtk_check_buttons{$checkbox->[0]} = $gtk_check_button;
			$gtk_check_button->set_active(1) if $selected_href->{$checkbox->[0]};
			$gtk_table->attach_defaults($gtk_check_button, $c, $c+1, $r, $r+1);
			++$i;
		}
	}

	$hbox->pack_start($gtk_table, 0, 1, 0);
	$hbox->show_all;

	$self->set_gtk_check_buttons(\%gtk_check_buttons);
	$self->set_gtk_table($gtk_table);

	$self->connect_changed_signal_for_all_buttons;

	1;
}

sub update_selection {
	my $self = shift;
	
	$self->set_in_selection_update(1);
	
	my $selected_href     = $self->get_object_value;
	my $gtk_check_buttons = $self->get_gtk_check_buttons;
	
	while ( my ($value, $gtk_check_button) = each %{$gtk_check_buttons} ) {
		$gtk_check_button->set_active( $selected_href->{$value} );
	}
	
	$self->set_in_selection_update(0);

	1;
}

sub widget_to_object {
	my $self = shift;
	
	return if $self->get_in_selection_update;

	my $gtk_check_buttons = $self->get_gtk_check_buttons;
	my %selected;
	
	while ( my ($value, $gtk_check_button) = each %{$gtk_check_buttons} ) {
		$selected{$value} = 1 if $gtk_check_button->get_active;
	}
	
	$self->set_object_value(\%selected);

	1;
}

sub connect_changed_signal_for_all_buttons {
	my $self = shift;
	
	my $gtk_check_buttons = $self->get_gtk_check_buttons;
	
	while ( my ($value, $gtk_check_button) = each %{$gtk_check_buttons} ) {
		$gtk_check_button->signal_connect ( toggled => sub {
			return 1 if $self->get_in_selection_update;
			$self->set_last_toggled_value($value);
			$self->widget_value_changed;
			1;
		} );
	}

	1;
}

1;

__END__