Kevin Ryde > Gtk2-Ex-History > Gtk2::Ex::History::MenuToolButton

Download:
Gtk2-Ex-History-8.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 8   Source  

NAME ^

Gtk2::Ex::History::MenuToolButton -- toolbar button for history "back" or "forward"

SYNOPSIS ^

 use Gtk2::Ex::History::MenuToolButton;
 my $item = Gtk2::Ex::History::MenuToolButton->new
              (history => $my_history,
               way => 'forward');
 $toolbar->add ($item);

OBJECT HIERARCHY ^

Gtk2::Ex::History::MenuToolButton is a subclass of Gtk2::MenuToolButton.

    Gtk2::Widget
      Gtk2::Container
        Gtk2::Bin
          Gtk2::ToolItem
            Gtk2::ToolButton
              Gtk2::MenuToolButton
                Gtk2::Ex::History::MenuToolButton

DESCRIPTION ^

This is a toolbar button which invokes either back or forward on a Gtk2::Ex::History object. The arrow part of the button presents a menu of the history in that direction.

    +-------------+---+
    |             |   |
    | ==> Forward | V |
    |             |   |
    +-------------+---+
                  +---------------+
                  | Some Thing    |
                  | Another Place |
                  | Future Most   |
                  +---------------+

A plain Gtk2::Ex::History::Button can be put in a Gtk2::ToolItem and used in a toolbar for a similar result. The difference is whether you prefer the menu popup with an arrow or with mouse button-3. The arrow has the advantage of a visual indication that there's something available.

FUNCTIONS ^

$item = Gtk2::Ex::History::MenuToolButton->new (key => value, ...)

Create and return a new history button. Optional key/value pairs can be given to set initial properties, as per Glib::Object->new.

The history property should be set to say what to display and act on, and way for back or forward.

    my $item = Gtk2::Ex::History::MenuToolButton->new
                  (history => $history,
                   way => 'forward');

PROPERTIES ^

history (Gtk2::Ex::History object, default undef)

The history object to act on.

way (enum Gtk2::Ex::History::Way, default 'back')

The direction to go, either "back" or "forward".

The stock-id property (per Gtk2::ToolButton) is set from this, either gtk-go-back or gtk-go-forward.

SEE ALSO ^

Gtk2::Ex::History, Gtk2::Ex::History::Menu, Gtk2::Ex::History::Button, Gtk2::Ex::History::Action, Gtk2::MenuToolButton

HOME PAGE ^

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

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

syntax highlighting: