README
1UI-Dialog
2=========
3
4UI::Dialog is a OOPerl wrapper for the various dialog applications. These
5dialog backends are currently supported: Zenity, GDialog, XDialog, KDialog,
6CDialog, and Whiptail. There is also an ASCII backend provided as a last
7resort interface for the console based dialog variants. UI::Dialog is a
8class that provides a strict interface to these various backend modules.
9By using UI:Dialog (with it's imposed limitations on the widgets) you can
10ensure that your Perl program will function with any available interfaces.
11
12UI::Dialog supports priority ordering of the backend detection process. So
13if you'd prefer that Xdialog should be used first if available, simply
14designate the desired order when creating the new object. The default order
15for detecting and utilization of the backends are as follows:
16 (with DISPLAY env): Zenity, GDialog, XDialog, KDialog
17 (without DISPLAY): CDialog, Whiptail, ASCII
18
19
20INSTALLATION
21------------
22
23To install this module type the following:
24
25 perl Makefile.PL
26 make
27 make test
28 make install
29
30
31SPECIAL NOTES
32-------------
33
34This release of UI::Dialog fundamentally changes how some internal mechanics
35function, namely the new `trust-input` behaviour for handling argument input
36(not user-input but rather programmer input). Every backend needed to have
37core functionality altered for this release and while the author has tried
38their best to test all the backends as thoroughly as possible; this has
39proven to require more time than they could invest.
40
41Developers should not need to adjust their use of UI::Dialog unless they
42need to enable the `trust-input` feature. See `examples/trust-input.pl` for
43example usage (or check the unit-tests, most have been updated for this
44specific feature).
45
46In the end, this release considers the XDialog backend to be "untested"
47and it is entirely possible that this backend is fundamentally broken at
48this time. XDialog is untested because it's unbuildable on Debian Jessie.
49This is a whole different problem, well beyond the scope of this release.
50
51In addition to XDialog, KDialog is also considered untested and potentially
52broken in fundamental ways.
53
54If you use either of these backends, or are just willing to help, please
55try the backends out (with this release of UI::Dialog) however you can.
56
57Detailed bugreports are very welcome. Unit tests, patches and anything
58else that can help the project along are even more appreciated. Please
59use the GitHub issue tracker[0] (or CPAN request tracker[1]) to provide
60your reports.
61
62 [0] https://github.com/kckrinke/ui-dialog/issues
63 [1] https://rt.cpan.org/Public/Dist/Display.html?Name=UI-Dialog
64
65These backends are of value and priority to UI::Dialog and given feedback,
66a followup bugfix release of UI::Dialog will be pushed out in a higher
67priority fashion. However, given little or no feedback, the assumption will
68be that either nobody uses these backends (highly doubted) or that they
69are functional as-is and not needing any fixes.
70
71
72PROVIDES
73--------
74
75 This module provides these classes, each with it's own perldoc:
76
77 UI::Dialog
78 UI::Dialog::Backend
79 UI::Dialog::Backend::ASCII
80 UI::Dialog::Backend::CDialog
81 UI::Dialog::Backend::GDialog
82 UI::Dialog::Backend::KDialog
83 UI::Dialog::Backend::Nautilus
84 UI::Dialog::Backend::NotifySend
85 UI::Dialog::Backend::Whiptail
86 UI::Dialog::Backend::XDialog
87 UI::Dialog::Backend::XOSD
88 UI::Dialog::Backend::Zenity
89 UI::Dialog::Console
90 UI::Dialog::GNOME
91 UI::Dialog::KDE
92 UI::Dialog::Screen::Menu
93 UI::Dialog::Screen::Druid
94
95
96COPYRIGHT AND LICENCE
97---------------------
98
99 Copyright (C) 2004-2016 Kevin C. Krinke <kevin@krinke.ca>
100
101 This library is free software; you can redistribute it and/or
102 modify it under the terms of the GNU Lesser General Public
103 License as published by the Free Software Foundation; either
104 version 2.1 of the License, or (at your option) any later version.
105
106 This library is distributed in the hope that it will be useful,
107 but WITHOUT ANY WARRANTY; without even the implied warranty of
108 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
109 Lesser General Public License for more details.
110
111 You should have received a copy of the GNU Lesser General Public
112 License along with this library; if not, write to the Free Software
113 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
114