1Gtk2::Ex::Dialogs::ErroUrsMesrg(C3o)ntributed Perl DocumGetnkt2a:t:iEoxn::Dialogs::ErrorMsg(3)
2
3
4

NAME

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

SYNOPSIS

9        use Gtk2::Ex::Dialogs::ErrorMsg ( destroy_with_parent => TRUE,
10                                          modal => TRUE,
11                                          no_separator => FALSE );
12
13        # do some stuff like creating your app's main $window then,
14        # to ensure that all messages use the right parent, set it:
15        $Gtk2::Ex::Dialogs::ErrorMsg::parent_window = $window;
16
17        # now popup a new dialog ( blocking the main loop if there is one )
18        new_and_run Gtk2::Ex::Dialogs::ErrorMsg ( "Simple error message." );
19
20        # now popup a somwhat useful dialog that doesn't block any main loop
21        # but on the other side of the coin, if there is no main loop the
22        # dialog will be completely unresponsive.
23        new_and_show Gtk2::Ex::Dialogs::ErrorMsg ( "Use when there is a main loop." );
24

DESCRIPTION

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

OPTIONS

31       All public methods (and the entire class) support the following
32       options:
33
34       title => STRING
35           The title of the dialog window. Defaults to "Error".
36
37       text => STRING
38           The text to be displayed. This is the core purpose of the module
39           and is the only mandatory argument.
40
41       icon => /path/to/image || stock-id || Gtk2::Gdk::Pixbuf || Gtk2::Image
42           The dialog-sized image to place to the left of the text. Note:
43           there are five aliased stock-ids which correspond to the five
44           gtk-dialog-* ids, "warning", "question", "info", "error" and
45           "authentication". Defaults to the stock-id of "gtk-dialog-error".
46
47       parent_window => Gtk2::Window
48           Reference to the main application window.
49
50       destroy_with_parent => BOOL
51           When the parent_window is destroyed, what do we do? Defaults to
52           FALSE.
53
54       modal => BOOL
55           Does this message make the parent_window freeze while the message
56           exists.  Defaults to FALSE.
57
58       no_separator => BOOL
59           Draw the horizontal separator between the content area and the
60           button area below. Defaults to FALSE.
61

PUBLIC METHODS

63       OBJECT = new ( OPTIONS | STRING )
64           Create a new Gtk2::Dialog with only an "OK" button, some text and
65           an optional icon to the left of the text. The icon can be any of
66           the following: a stock-id string, a Gtk2::Image, Gtk2::Gdk::Pixbuf
67           or the full path to an image. Return a Gtk2::Ex::Dialogs::ErrorMsg
68           object. In the special case of being passed only one argument, all
69           options are set to defaults and the one argument is used as the
70           text option.
71
72       new_and_run ( OPTIONS | STRING )
73           Supports all the same arguments as new(). This will create a new
74           Gtk2::Ex::Dialogs::Message, show_all(), run() and then destroy the
75           dialog immediately.
76
77       new_and_show ( OPTIONS )
78           Supports all the same arguments as new(). This will create a new
79           Gtk2::Ex::Dialogs::Message, show_all() and process any pending gtk
80           events. This functionality is only of any practical use when the is
81           a Gtk2 main loop running. If there is no main loop running the
82           dialog will be visible but completely unresponsive to the end-user.
83

SEE ALSO

85        Gtk2::Dialog
86        Gtk2::MessageDialog
87        Gtk2::Ex::Dialogs
88        Gtk2::Ex::Dialogs::ChooseDirectory
89        Gtk2::Ex::Dialogs::ChooseFile
90        Gtk2::Ex::Dialogs::ChoosePreviewFile
91        Gtk2::Ex::Dialogs::ErrorMsg
92        Gtk2::Ex::Dialogs::Message
93

BUGS

95       Please report any bugs to the mailing list.
96

MAILING LIST

98        http://opendoorsoftware.com/lists/gtk2-ex-list
99        gtk2-ex-list@opendoorsoftware.com
100

AUTHORS

102        Kevin C. Krinke, <kckrinke@opendoorsoftware.com>
103        James Greenhalgh, <jgreenhalgh@opendoorsoftware.com>
104

106        Gtk2::Ex::Dialogs::ErrorMsg - Provides a simple error message dialog.
107        Copyright (C) 2005 Open Door Software Inc. <ods@opendoorsoftware.com>
108
109        This library is free software; you can redistribute it and/or
110        modify it under the terms of the GNU Lesser General Public
111        License as published by the Free Software Foundation; either
112        version 2.1 of the License, or (at your option) any later version.
113
114        This library is distributed in the hope that it will be useful,
115        but WITHOUT ANY WARRANTY; without even the implied warranty of
116        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
117        Lesser General Public License for more details.
118
119        You should have received a copy of the GNU Lesser General Public
120        License along with this library; if not, write to the Free Software
121        Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
122
123
124
125perl v5.12.0                      2006-01-11    Gtk2::Ex::Dialogs::ErrorMsg(3)
Impressum