File Coverage

blib/lib/Gtk2/Ex/History/Button.pm

Criterion	Covered	Total	%
statement	10	12	83.3
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	14	16	87.5

# Copyright 2007, 2008, 2009, 2010, 2011 Kevin Ryde

# This file is part of Gtk2-Ex-History.
#
# Gtk2-Ex-History is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free
# Software Foundation; either version 3, or (at your option) any later
# version.
#
# Gtk2-Ex-History 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 General Public License
# for more details.
#
# You should have received a copy of the GNU General Public License along
# with Gtk2-Ex-History.  If not, see .

package Gtk2::Ex::History::Button;
use 5.008;
use strict;
use warnings;
use Gtk2 1.220;

use Gtk2::Ex::History;
use Glib::Ex::ConnectProperties 13;  # v.13 for model-rows

# uncomment this to run the ### lines
#use Smart::Comments;

our $VERSION = 8;

use Glib::Object::Subclass
  'Gtk2::Button',
  signals => { clicked => \&_do_clicked,
               button_press_event  => \&_do_button_press_event },
  properties => [ Glib::ParamSpec->object
                  ('history',
                   'History object',
                   'The history object to act on.',
                   'Gtk2::Ex::History',
                   Glib::G_PARAM_READWRITE),

                  Glib::ParamSpec->enum
                  ('way',
                   'Which way',
                   'Which way to go in the history when clicked, either back or forward.',
                   'Gtk2::Ex::History::Way',
                   'back',
                   Glib::G_PARAM_READWRITE),
                ];

sub INIT_INSTANCE {
  my ($self) = @_;
  # for some reason these setting don't take effect here but must be done in
  # SET_PROPERTY below
  $self->set_label ("gtk-go-back"); # default
  $self->set_use_stock (1);
}

sub SET_PROPERTY {
  my ($self, $pspec, $newval) = @_;
  my $pname = $pspec->get_name;
  $self->{$pname} = $newval;  # per default GET_PROPERTY

  #  if ($pname eq 'history' || $pname eq 'way') { ...

  # should only need to update the icon when setting 'way', but as of gtk
  # 2.18 the icon in INIT_INSTANCE doesn't take effect -- something about
  # "constructor" -- so as a workaround apply the stock icon when setting
  # 'history' too
  #
  my $way = $self->get('way');
  $self->set_label ("gtk-go-$way");
  $self->set_use_stock (1);

  # the history model, either the back or forward one
  my $history = $self->{'history'};
  $self->{'connp'} = $history && Glib::Ex::ConnectProperties->dynamic
    ([$history->model($way), 'model-rows#not-empty'],
     [$self, 'sensitive']);
}

# 'clicked' class closure
sub _do_clicked {
  my ($self) = @_;
  ### History-Button clicked: $self->get('way')
  my $history = $self->{'history'} || return;
  my $way = $self->get('way');
  $history->$way;
  return shift->signal_chain_from_overridden(@_);
}

# 'button-press-event' class closure
#
# Might like this popup to work even when there's no items in the model and
# the button is therefore insensitive, but the button-press-event doesn't
# come through when insensitive.
#
sub _do_button_press_event {
  my ($self, $event) = @_;
  ### History-Button button-press-event: $event->button
  if ($event->button == 3 && (my $history = $self->{'history'})) {
    require Gtk2::Ex::History::Menu;
    Gtk2::Ex::History::Menu->new_popup (history => $history,
                                        way     => $self->get('way'),
                                        event   => $event);
  }
  return shift->signal_chain_from_overridden(@_);
}

1;
__END__