/ 
math-image-47
River stage zero No dependents
/ App::MathImage::Gtk2::Ex::Splash

NAME

App::MathImage::Gtk2::Ex::Splash -- toplevel splash widget

SYNOPSIS

use App::MathImage::Gtk2::Ex::Splash;
my $splash = App::MathImage::Gtk2::Ex::Splash->new
               (filename => '/my/image.png');
$splash->present;
# do some things
$splash->destroy;

WIDGET HIERARCHY

App::MathImage::Gtk2::Ex::Splash is a subclass of Gtk2::Window, but don't rely on more than Gtk2::Widget just yet.

Gtk2::Widget
  Gtk2::Container
    Gtk2::Bin
      Gtk2::Window
        App::MathImage::Gtk2::Ex::Splash

DESCRIPTION

This is a splash window widget designed to show an image in a temporary toplevel centred on the screen. It can be used at program startup if some initializations might be slow, or it can be used for a general purpose flash or splash.

The window is non-interactive, so it doesn't take the keyboard focus away from whatever the user is doing. (Is that true in a focus follows mouse window manager mode though?) It does consume mouse button clicks though.

The image is drawn as the window background, so it requires no redraws from the application program if blocked etc for a time.

FUNCTIONS

$splash = App::MathImage::Gtk2::Ex::Splash->new (key=>value,...)

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

my $splash = App::MathImage::Gtk2::Ex::Splash->new;

PROPERTIES

pixmap (Gtk2::Gdk::Pixmap object, default undef)
pixbuf (Gtk2::Gdk::Pixmap object, default undef)
filename (string, default undef)

The image to display.

A filename is read with Gtk2::Gdk::Pixbuf so can be any file format supported by GdkPixbuf. PNG and JPEG are supported in all Gtk2 versions.

The usual Gtk2::Window screen property determines the screen the window is displayed on.

SEE ALSO

Gtk2::Window

HOME PAGE

http://user42.tuxfamily.org/math-image/index.html

LICENSE

Copyright 2010, 2011 Kevin Ryde

Math-Image 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.

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