view release on metacpan or  search on metacpan

lib/Gtk2/Ex/History/Dialog.pm  view on Meta::CPAN

C<Gtk2::Ex::History::Dialog> is a subclass of C<Gtk2::Dialog>.

    Gtk2::Widget
      Gtk2::Container
        Gtk2::Bin
          Gtk2::Window
            Gtk2::Dialog
              Gtk2::Ex::History::Dialog

=head1 DESCRIPTION

A C<Gtk2::Ex::History::Dialog> displays the "current", "back" and "forward"
places of a C<Gtk2::Ex::History> object.

    +--------------------------------------------------+
    | Current: Thing now displayed                     |
    | +--------------------+    +--------------------+ |
    | | Back               |    | Forward            | |
    | +--------------------+    +--------------------+ |
    | | Thing last visited |    | Thing forward      | |
    | | The thing before   |    | Further forward    | |
    | | An old thing       |    |                    | |
    | +--------------------+    +--------------------+ |
    +--------------------------------------------------+
    |                                           Close  |
    +--------------------------------------------------+

Clicking on a back or forward item moves to make it current.  Clicking on
the Back and Forward headings moves by one in that direction.  Drag and drop
can rearrange items.  Dropping on the "current" moves to make that item
current, extracting it from the back or forward.

=head1 FUNCTIONS

=over 4

=item C<< $dialog = Gtk2::Ex::History::Dialog->new (key => value, ...) >>

Create and return a new history dialog.  Optional key/value pairs set
initial properties as per C<< Glib::Object->new >>.  The C<history> property
is what to display.

    my $dialog = Gtk2::Ex::History::Dialog->new
                 (history => $my_history);

=back

=head1 PROPERTIES

=over 4

=item C<history> (C<Gtk2::Ex::History> object, default C<undef>)

The history object to display and act on.

=back

=head1 SEE ALSO

L<Gtk2::Ex::History>,
L<Gtk2::Ex::History::Menu>,
L<Gtk2::Dialog>

=head1 HOME PAGE

L<http://user42.tuxfamily.org/gtk2-ex-history/index.html>

=head1 LICENSE

Gtk2-Ex-History is Copyright 2010, 2011 Kevin Ryde

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 L<http://www.gnu.org/licenses/>.

=cut