view release on metacpan or  search on metacpan

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

        $Gtk2::Ex::Dialogs::Message::icon                          = $value;
        $Gtk2::Ex::Dialogs::Question::icon                         = $value;
    } elsif ( $method eq 'set_modal' ) {
        $Gtk2::Ex::Dialogs::modal                                  = $value;
        $Gtk2::Ex::Dialogs::ChooseDirectory::modal                 = $value;
        $Gtk2::Ex::Dialogs::ChooseFile::modal                      = $value;
        $Gtk2::Ex::Dialogs::ChoosePreviewFile::modal               = $value;
        $Gtk2::Ex::Dialogs::ErrorMsg::modal                        = $value;
        $Gtk2::Ex::Dialogs::Message::modal                         = $value;
        $Gtk2::Ex::Dialogs::Question::modal                        = $value;
    } elsif ( $method eq 'set_no_separator' ) {
        $Gtk2::Ex::Dialogs::no_separator                           = $value;
        $Gtk2::Ex::Dialogs::ErrorMsg::no_separator                 = $value;
        $Gtk2::Ex::Dialogs::Message::no_separator                  = $value;
        $Gtk2::Ex::Dialogs::Question::no_separator                 = $value;
    } elsif ( $method eq 'set_parent_window' ) {
        $Gtk2::Ex::Dialogs::parent_window                          = $value;
        $Gtk2::Ex::Dialogs::ChooseDirectory::parent_window         = $value;
        $Gtk2::Ex::Dialogs::ChooseFile::parent_window              = $value;
        $Gtk2::Ex::Dialogs::ChoosePreviewFile::parent_window       = $value;
        $Gtk2::Ex::Dialogs::ErrorMsg::parent_window                = $value;
        $Gtk2::Ex::Dialogs::Message::parent_window                 = $value;
        $Gtk2::Ex::Dialogs::Question::parent_window                = $value;
    } elsif ( $method eq 'set_destroy_with_parent' ) {
        $Gtk2::Ex::Dialogs::destroy_with_parent                    = $value;
        $Gtk2::Ex::Dialogs::ChooseDirectory::destroy_with_parent   = $value;
        $Gtk2::Ex::Dialogs::ChooseFile::destroy_with_parent        = $value;
        $Gtk2::Ex::Dialogs::ChoosePreviewFile::destroy_with_parent = $value;
        $Gtk2::Ex::Dialogs::ErrorMsg::destroy_with_parent          = $value;
        $Gtk2::Ex::Dialogs::Message::destroy_with_parent           = $value;
        $Gtk2::Ex::Dialogs::Question::destroy_with_parent          = $value;
    } elsif ( $method eq 'set_default_yes' ) {
        $Gtk2::Ex::Dialogs::default_yes                            = $value;
        $Gtk2::Ex::Dialogs::Question::default_yes                  = $value;
    } elsif ( $method eq 'set_must_exist' ) {
        $Gtk2::Ex::Dialogs::must_exist                             = $value;
        $Gtk2::Ex::Dialogs::ChooseDirectory::must_exist            = $value;
        $Gtk2::Ex::Dialogs::ChooseFile::must_exist                 = $value;
        $Gtk2::Ex::Dialogs::ChoosePreviewFile::must_exist          = $value;
    } else {
        croak( $class . " does not have a method called " . $AUTOLOAD . "()." );
    }

    return( $value );
}

=head1 NAME

Gtk2::Ex::Dialogs - Useful tools for Gnome2/Gtk2 Perl GUI design.

=head1 SYNOPSIS

 use Gtk2::Ex::Dialogs ( 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->set_parent_window( $window );

 # now popup a new dialog
 my $r = ask Gtk2::Ex::Dialogs::Question ( "Is Perl only hacker's glue?" );
 if ( $r ) {
   # end-user thinks so
 } else {
   # end-user does not think so
 }

 # now popup a new dialog ( blocking the main loop if there is one )
 new_and_run
  Gtk2::Ex::Dialogs::Message ( title => "Dialog Title",
                               text => "This is a simple message" );

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

=head1 DESCRIPTION

This module provides the Gtk2::Ex::Dialogs::Message, Gtk2::Ex::Dialogs::ErrorMsg and
Gtk2::Ex::Dialogs::Question classes to the main application while setting the initial
defaults to those specified upon using Gtk2::Ex::Dialogs.

=head1 OPTIONS

Gtk2::Ex::Dialogs supports the following options:

=over

=item B<title> => STRING

The title of the dialog window. Defaults to an empty string.

=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
"gtk-dialog-question".

=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.

=item B<default_yes> => BOOL

Autofocus on the "YES" button. Defaults to FALSE.

=item B<must_exist> => BOOL

The end-user must supply a path to an existing file or directory. Should the
end-user provide a non-existant path, the dialog will be respawned until an
existing file is chosen. Defaults to FALSE.

=back