view release on metacpan or  search on metacpan

lib/Gtk2/Ex/Dialogs/ErrorMsg.pm  view on Meta::CPAN

#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#  Lesser General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public
#  License along with this library; if not, write to the Free Software
#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
###############################################################################
use strict;

BEGIN {
	use vars qw( $VERSION );
	$VERSION = '0.11';
}

use Carp;
use Gtk2::Ex::Dialogs::Message;
use Gtk2::Ex::Constants qw( :truth );

sub import {
    my $class = shift();
    my $cfg = undef;

    if ( @_ % 2 == 0 ) {
        $cfg = { @_ };
    } elsif ( @_ % 2 >= 1 ) {
        croak( $class . " class received an uneven argument list." );
    } else {
        $cfg = {};
    }

    $Gtk2::Ex::Dialogs::ErrorMsg::title               =
     $cfg->{title}               || 'Error';
    $Gtk2::Ex::Dialogs::ErrorMsg::text                =
     $cfg->{text}                || '';
    $Gtk2::Ex::Dialogs::ErrorMsg::icon                =
     $cfg->{icon}                || 'gtk-dialog-error';
    $Gtk2::Ex::Dialogs::ErrorMsg::modal               =
     $cfg->{modal}               || FALSE;
    $Gtk2::Ex::Dialogs::ErrorMsg::no_separator        =
     $cfg->{no_separator}        || FALSE;
    $Gtk2::Ex::Dialogs::ErrorMsg::parent_window       =
     $cfg->{parent_window}       || undef;
    $Gtk2::Ex::Dialogs::ErrorMsg::destroy_with_parent =
     $cfg->{destroy_with_parent} || FALSE;
}

=head1 NAME

Gtk2::Ex::Dialogs::ErrorMsg - Provides a simple error message dialog.

=head1 SYNOPSIS

 use Gtk2::Ex::Dialogs::ErrorMsg ( destroy_with_parent => TRUE,
                                   modal => TRUE,
                                   no_separator => FALSE );

 # do some stuff like creating your app's main $window then,
 # to ensure that all messages use the right parent, set it:
 $Gtk2::Ex::Dialogs::ErrorMsg::parent_window = $window;

 # now popup a new dialog ( blocking the main loop if there is one )
 new_and_run Gtk2::Ex::Dialogs::ErrorMsg ( "Simple error message." );

 # now popup a somwhat useful dialog that doesn't block any main loop
 # but on the other side of the coin, if there is no main loop the
 # dialog will be completely unresponsive.
 new_and_show Gtk2::Ex::Dialogs::ErrorMsg ( "Use when there is a main loop." );

=head1 DESCRIPTION

This module provides a simple dialog api that wraps Gtk2::Dialog objectively.
The objective is a clean and simple message dialog (only an "OK" button).

=head1 OPTIONS

All public methods (and the entire class) support the following options:

=over

=item B<title> => STRING

The title of the dialog window. Defaults to "Error".

=item B<text> => STRING

The text to be displayed. This is the core purpose of the module and is the
only mandatory argument.

=item B<icon> => /path/to/image || stock-id || Gtk2::Gdk::Pixbuf || Gtk2::Image

The dialog-sized image to place to the left of the text. Note: there are five
aliased stock-ids which correspond to the five gtk-dialog-* ids, "warning",
"question", "info", "error" and "authentication". Defaults to the stock-id of
"gtk-dialog-error".

=item B<parent_window> => Gtk2::Window

Reference to the main application window.

=item B<destroy_with_parent> => BOOL

When the B<parent_window> is destroyed, what do we do? Defaults to FALSE.

=item B<modal> => BOOL

Does this message make the B<parent_window> freeze while the message exists.
Defaults to FALSE.

=item B<no_separator> => BOOL

Draw the horizontal separator between the content area and the button area
below. Defaults to FALSE.

=back

=head1 PUBLIC METHODS

=over

=item OBJECT = B<new> ( OPTIONS | STRING )

Create a new Gtk2::Dialog with only an "OK" button, some text and an optional
icon to the left of the text. The icon can be any of the following: a stock-id
string, a Gtk2::Image, Gtk2::Gdk::Pixbuf or the full path to an image. Return