NAME

Gtk2::Ex::QuadButton::Scroll -- buttons up, down, left, right scrolling adjustment objects

SYNOPSIS

 use Gtk2::Ex::QuadButton::Scroll;
 my $qb = Gtk2::Ex::QuadButton::Scroll->new
            (vadjustment => $vadj,
             hadjustment => $hadj,
             vinverted => 1);

WIDGET HIERARCHY

Gtk2::Ex::QuadButton::Scroll is a subclass of Gtk2::Ex::QuadButton,

    Gtk2::Widget
      Gtk2::DrawingArea
        Gtk2::Ex::QuadButton
          Gtk2::Ex::QuadButton::Scroll

DESCRIPTION

This is a QuadButton which applies the up, left, etc clicks to given vertical and horizontal Gtk2::Adjustment objects. Those adjusters will usually be to control some sort of display widget.

"Inverted" settings swap the up/down or left/right direction of the clicks, for a display widget which goes up the page instead of down, or left instead of right.

FUNCTIONS

$qb = Gtk2::Ex::QuadButton::Scroll->new (key=>value,...)

Create and return a new QuadButton::Scroll widget. Optional key/value pairs set initial properties per Glib::Object->new.

    my $qb = Gtk2::Ex::QuadButton::Scroll->new;

PROPERTIES

hadjustment (Gtk2::Adjustment object, default undef)
vadjustment (Gtk2::Adjustment object, default undef)

The adjustment objects to change when the users clicks the button up, right, etc. If undef then clicks in the respective horizontal or vertical direction do nothing.

hinverted (Gtk2::Adjustment object, default undef)
vinverted (Gtk2::Adjustment object, default undef)

Swap the direction the respective adjustments are moved. Normally a left click decreases hadjustment and a right click increases it, but with hinverted it's the other way around. Similarly vinverted for vadjustment.

The sense of this inverting is the as the Gtk2::Scrollbar inverted property, so if you set inverted on a scrollbar then do the same to this QuadButton scroller.

SEE ALSO

Gtk2::Ex::QuadButton, Gtk2::Adjustment, Gtk2::Scrollbar

HOME PAGE

http://user42.tuxfamily.org/gtk2-ex-quadbutton/index.html

LICENSE

Copyright 2010, 2011 Kevin Ryde

Gtk2-Ex-QuadButton 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-QuadButton 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-QuadButton. If not, see http://www.gnu.org/licenses/.