Newt-syrup September 2010

newt-syrup@lists.fedorahosted.org

1 participants
4 discussions

Branch 'devel' - 2 commits - ChangeLog setup.py

by Darryl L. Pierce

ChangeLog | 2 ++ setup.py | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) New commits: commit c8be52a0a8234edca5cb4e2c464d4db3c1bad29a Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Fri Sep 10 16:04:25 2010 -0400 Setup changes for version 0.1.2 development. diff --git a/ChangeLog b/ChangeLog index 574fb0c..42062c7 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,4 +1,6 @@ Change Log: + * Version 0.1.2: + * Version 0.1.1: - Added support for color sets. - Added support for using compact buttons. diff --git a/setup.py b/setup.py index 57a339e..af22130 100755 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages setup(name = "newt_syrup", - version = "0.1.1", + version = "0.1.2", packages = find_packages(), author = "Darryl L. Pierce", author_email = "dpierce(a)redhat.com", commit 0d3a9630607bf55b78ff2ffcc1739be24199765a Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Fri Sep 10 15:21:37 2010 -0400 Updated the version to 0.1.1. diff --git a/setup.py b/setup.py index ea4833e..57a339e 100755 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages setup(name = "newt_syrup", - version = "0.1.0", + version = "0.1.1", packages = find_packages(), author = "Darryl L. Pierce", author_email = "dpierce(a)redhat.com",

13 years, 7 months

1
0
0 / 0

Changes to 'refs/tags/newt_syrup-0.1.1'

by Darryl L. Pierce

Tag 'newt_syrup-0.1.1' created by Darryl L. Pierce <dpierce(a)redhat.com> at 2010-09-10 20:02 +0000 Release 0.1.1. -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.10 (GNU/Linux) iEYEABECAAYFAkyKjvgACgkQtddqM0QFuLIeBACgxjsPXXaKB06S6BA50Gmbu5hg uxoAoN4pkCdhLehTRaWkVDWpFKD+QkoO =AGAI -----END PGP SIGNATURE----- Changes since the dawn of time: Darryl L. Pierce (15): Initial commit of the ignore file. Initial checkin of the base source modules. Created SelectionListConfigScreen. Added a files for packaging and distribution. A few more packaging changes. Added support for setting the colors of widgets. Added support for compact buttons. Some house keeping of the repo. Fixed the package init source and examples to use them correctly. Fixed the selection model for the SelectionListConfigScreen. Removing some debugging code. Adds support for using fullscreen applications. More fixes to the fullscreen app support. Added support for dialog boxes. Updated the version to 0.1.1.

13 years, 7 months

1
0
0 / 0

14 commits - AUTHORS ChangeLog COLORS COPYING examples/appliance examples/colorize examples/dialog examples/selections .gitignore MANIFEST.in newt_syrup/configscreen.py newt_syrup/dialogscreen.py newt_syrup/__init__.py newt_syrup/menuscreen.py setup.py

by Darryl L. Pierce

.gitignore | 2 AUTHORS | 6 COLORS | 48 ++++ COPYING | 502 +++++++++++++++++++++++++++++++++++++++++++++ ChangeLog | 10 MANIFEST.in | 10 examples/appliance | 76 ++++++ examples/colorize | 62 +++++ examples/dialog | 26 ++ examples/selections | 60 +++++ newt_syrup/__init__.py | 19 + newt_syrup/configscreen.py | 254 ++++++++++++++++++++++ newt_syrup/dialogscreen.py | 49 ++++ newt_syrup/menuscreen.py | 57 +++++ setup.py | 19 + 15 files changed, 1200 insertions(+) New commits: commit 0d3a9630607bf55b78ff2ffcc1739be24199765a Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Fri Sep 10 15:21:37 2010 -0400 Updated the version to 0.1.1. diff --git a/setup.py b/setup.py index ea4833e..57a339e 100755 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages setup(name = "newt_syrup", - version = "0.1.0", + version = "0.1.1", packages = find_packages(), author = "Darryl L. Pierce", author_email = "dpierce(a)redhat.com", commit f6b6c0981d96d3694af32fd2b2f6db7277e319a1 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Fri Sep 10 15:11:59 2010 -0400 Added support for dialog boxes. Created a new class, named DialogScreen, that takes a title and a message. It then shows those when the dialog is started. Dialog boxes support colorsets in the same way as other screen types. diff --git a/ChangeLog b/ChangeLog index 6cf5860..574fb0c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -4,6 +4,7 @@ Change Log: - Added support for using compact buttons. - Fixed the option model for SelectionListConfigScreen. - Added support for full screen applications. + - Added dialog boxes. * Version 0.1.0: - Added SelectionListConfigScreen. diff --git a/examples/dialog b/examples/dialog new file mode 100755 index 0000000..9415934 --- /dev/null +++ b/examples/dialog @@ -0,0 +1,26 @@ +#!/usr/bin/env python +# +# dialog - Copyright (C) 2010 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from newt_syrup.dialogscreen import * + +if __name__ == "__main__": + dialog = DialogScreen("This is the title", + "And this is an informative message.") + dialog.show() diff --git a/newt_syrup/dialogscreen.py b/newt_syrup/dialogscreen.py new file mode 100644 index 0000000..6b8c9a9 --- /dev/null +++ b/newt_syrup/dialogscreen.py @@ -0,0 +1,49 @@ +# dialogscreens.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from snack import * + +import _snack +import traceback + +class DialogScreen: + """ + Lets the user present a single dialog box with a message. + """ + + def __init__(self, title, message, colorset = None): + self.__title = title + self.__message = message + self.__colorset = colorset + + def show(self): + screen = SnackScreen() + + # apply the colorset + if self.__colorset is not None: + for item in self.__colorset.keys(): + colors = self.__colorset.get(item) + screen.setColor(item, colors[0], colors[1]) + + ButtonChoiceWindow(screen, + self.__title, + self.__message, + buttons = ["Close"]) + screen.popWindow() + screen.finish() + commit e738761e8e01dd57863710a5aae43f0cc5e38c57 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Tue Aug 17 09:15:12 2010 -0400 More fixes to the fullscreen app support. diff --git a/newt_syrup/configscreen.py b/newt_syrup/configscreen.py index c6d0296..f57397e 100644 --- a/newt_syrup/configscreen.py +++ b/newt_syrup/configscreen.py @@ -138,18 +138,19 @@ class ConfigScreen: leftmenu.setField(Label(indicator), 1, current_element) current_element += 1 gridform.add(leftmenu, 1, 0, - anchorTop = 1, + anchorTop = 1, anchorLeft = 1, growx = 0) current_element = 0 for element in elements: # set the title of the page - content.setField(element, 0, current_element) + content.setField(element, 0, current_element, anchorLeft = 1) current_element += 1 (fullwidth, fullheight) = _snack.size() if self.use_full_screen(): content.setField(Label(""), 0, current_element, - padding = (fullwidth - 4, 0, 0, 0), + padding = ((fullwidth / 2) - 2, 0, + (fullwidth / 2) - 2, 0), growx = 1) current_element += 1 @@ -166,15 +167,14 @@ class ConfigScreen: buttons.append(["Finish", FINISH_BUTTON, "F10"]) buttons.append(["Cancel", CANCEL_BUTTON, "ESC"]) buttonbar = ButtonBar(screen, buttons, compact = compact_buttons) - content.setField(buttonbar, 0, current_element, growx = 0) - - # put a big piece at the top - (width, height) = _snack.size() + content.setField(buttonbar, 0, current_element, anchorLeft = 1, growx = 0) if self.use_full_screen(): gridform.add(Label(""), 0, 0, - padding = (0, height - 4, 0, 0), growy = 1) - gridform.add(Label(""), 3, 0, anchorTop = 1) - gridform.add(content, 2, 0, anchorTop = 1) + padding = (0, (fullheight / 2) - 2, + 0, (fullheight / 2) - 2), + growy = 1) + gridform.add(Label(" "), 2, 0, anchorTop = 1) + gridform.add(content, 3, 0, anchorTop = 1) current_element += 1 try: # get the position for the main window commit a78161ea835ffb9d2567c8ff44d73ddc58516516 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Mon Aug 16 11:34:27 2010 -0400 Adds support for using fullscreen applications. If the use_full_screen() method returns True, then an empty label that's as wide as the screen, and an empty label as tall as the screen, are added to the GridForm to pad it out. diff --git a/ChangeLog b/ChangeLog index 9d881a0..6cf5860 100644 --- a/ChangeLog +++ b/ChangeLog @@ -3,6 +3,7 @@ Change Log: - Added support for color sets. - Added support for using compact buttons. - Fixed the option model for SelectionListConfigScreen. + - Added support for full screen applications. * Version 0.1.0: - Added SelectionListConfigScreen. diff --git a/examples/appliance b/examples/appliance new file mode 100755 index 0000000..d4c94fd --- /dev/null +++ b/examples/appliance @@ -0,0 +1,76 @@ +#!/usr/bin/env python +# +# appliance - Copyright (C) 2010 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from newt_syrup.configscreen import * + +MAIN_PAGE = 1 + +class ApplianceConfigScreen(ConfigScreen): + """ + This example presents an application that looks like + an appliance more than an application. + """ + + def __init__(self): + ConfigScreen.__init__(self, "Example Appliance") + + def get_elements_for_page(self, screen, page): + return self.get_elements_for_main_page(screen) + + def use_full_screen(self): + return True + + def use_compact_buttons(self): + return True + + def page_has_next(self, page): + return (page < len(self.get_page_list())) + + def get_page_list(self): + return ["Configure root password", + "Configure security mode", + " ", + "Restart system", + "Backup system components", + " ", + "Configure keyboard", + "View help information", + "View system logs", + " ", + "Quit"] + + def get_elements_for_main_page(self, screen): + elements = Grid(2, 5) + labels = [("This is button 1.", 1, True), + ("This is button 2.", 2, False), + ("This is button 3.", 3, False), + ("This is button 4.", 4, False), + ("This is button 5.", 5, False)] + buttons = RadioBar(screen, labels) + + elements.setField(Label("Some piece of data:"), 0, 0, anchorRight = 1) + elements.setField(Entry(30), 1, 0, anchorLeft = 1) + elements.setField(Label("Some text:"), 0, 1, anchorRight = 1) + elements.setField(buttons, 1, 1, anchorLeft = 1) + return [Label("This Is A Cool Appliance."), elements] + +if __name__ == "__main__": + screen = ApplianceConfigScreen() + screen.start() diff --git a/newt_syrup/configscreen.py b/newt_syrup/configscreen.py index efdba58..c6d0296 100644 --- a/newt_syrup/configscreen.py +++ b/newt_syrup/configscreen.py @@ -17,6 +17,8 @@ # also available at http://www.gnu.org/copyleft/gpl.html. from snack import * + +import _snack import traceback BACK_BUTTON = "back" @@ -42,6 +44,9 @@ class ConfigScreen: self.__colorset = colorset def get_title(self): + """ + Returns the title to be displayed for this application. + """ return self.__title def set_finished(self): @@ -90,6 +95,20 @@ class ConfigScreen: """ False + def get_window_position(self): + """ + Returns the desired window position for the application. + """ + return (0, 0) + + def use_full_screen(self): + """ + Returns whether the application should use full screen windows. + + Default: False + """ + False + def start(self): active = True while active and (self.__finished == False): @@ -101,11 +120,12 @@ class ConfigScreen: screen.setColor(item, colors[0], colors[1]) elements = self.get_elements_for_page(screen, self.__current_page) # TODO: need to set the form height to the number of elements on the page - gridform = GridForm(screen, self.get_title(), 2, 2) + gridform = GridForm(screen, self.get_title(), 4, 1) # Here you would put the list of elements # and programmatically set the indicator as # they're rendered + content = Grid(1, len(elements) + 2) # extra = button bar + padding row pages = self.get_page_list() if len(pages) > 0: leftmenu = Grid(2, len(pages)) @@ -117,13 +137,21 @@ class ConfigScreen: indicator = "<-" leftmenu.setField(Label(indicator), 1, current_element) current_element += 1 - gridform.add(leftmenu, 0, 0, anchorTop = 1, padding = (3, 0, 3, 0)) + gridform.add(leftmenu, 1, 0, + anchorTop = 1, + growx = 0) - content = Grid(1, len(elements) + 1) current_element = 0 for element in elements: + # set the title of the page content.setField(element, 0, current_element) current_element += 1 + (fullwidth, fullheight) = _snack.size() + if self.use_full_screen(): + content.setField(Label(""), 0, current_element, + padding = (fullwidth - 4, 0, 0, 0), + growx = 1) + current_element += 1 # create the navigation buttons buttons = [] @@ -138,12 +166,23 @@ class ConfigScreen: buttons.append(["Finish", FINISH_BUTTON, "F10"]) buttons.append(["Cancel", CANCEL_BUTTON, "ESC"]) buttonbar = ButtonBar(screen, buttons, compact = compact_buttons) - content.setField(buttonbar, 0, current_element, growx = 1) - - gridform.add(content, 1, 0, anchorTop = 1) + content.setField(buttonbar, 0, current_element, growx = 0) + + # put a big piece at the top + (width, height) = _snack.size() + if self.use_full_screen(): + gridform.add(Label(""), 0, 0, + padding = (0, height - 4, 0, 0), growy = 1) + gridform.add(Label(""), 3, 0, anchorTop = 1) + gridform.add(content, 2, 0, anchorTop = 1) current_element += 1 try: - result = gridform.runOnce() + # get the position for the main window + if self.use_full_screen(): + (top, left) = (1, 1) + else: + (top, left) = (None, None) + result = gridform.runOnce(top, left) pressed = buttonbar.buttonPressed(result) if pressed == BACK_BUTTON: self.go_back() commit f45d7e0c94febc7921e2395a2eb3c39c402f9628 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Mon Aug 16 11:13:57 2010 -0400 Removing some debugging code. diff --git a/examples/selections b/examples/selections index 33f0f69..82e1e53 100755 --- a/examples/selections +++ b/examples/selections @@ -39,7 +39,6 @@ class SelectionsScreen(SelectionListConfigScreen): return [Label("So Do I!"), grid] def get_screen_options(self): - print "This was called!" return [("Apples", "apples"), ("Oranges", "oranges"), ("Tangerines", "tangerines"), commit a5c726f25fcfa3657c8a074b619ba95a3f8c6bc8 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Fri Aug 13 09:30:09 2010 -0400 Fixed the selection model for the SelectionListConfigScreen. The get_screen_options() method now returns an array where each element is an array of two elements: the value for the selected option, and the text to display for the option, respectively. diff --git a/ChangeLog b/ChangeLog index a66436c..9d881a0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -2,6 +2,7 @@ Change Log: * Version 0.1.1: - Added support for color sets. - Added support for using compact buttons. + - Fixed the option model for SelectionListConfigScreen. * Version 0.1.0: - Added SelectionListConfigScreen. diff --git a/examples/selections b/examples/selections index bba7f7f..33f0f69 100755 --- a/examples/selections +++ b/examples/selections @@ -40,7 +40,10 @@ class SelectionsScreen(SelectionListConfigScreen): def get_screen_options(self): print "This was called!" - return ["Apples", "Oranges", "Tangerines", "Tomatoes (yes, they're fruit!)"] + return [("Apples", "apples"), + ("Oranges", "oranges"), + ("Tangerines", "tangerines"), + ("Tomatoes", "tomatoes")] def page_has_next(self, page): if page == SELECT_A_FRUIT: return True diff --git a/newt_syrup/configscreen.py b/newt_syrup/configscreen.py index 448d1a6..efdba58 100644 --- a/newt_syrup/configscreen.py +++ b/newt_syrup/configscreen.py @@ -184,7 +184,9 @@ class SelectionListConfigScreen(ConfigScreen): def get_screen_options(self): """ - Returns the list of elements to be displayed on the screen. + Returns the list of elements to be displayed on the screen. Each element + is a pair of elements, the first being the value returned for a selected + option, and the second being the text to display for an option. """ print "Called the parent instead." return [] @@ -197,7 +199,7 @@ class SelectionListConfigScreen(ConfigScreen): self.__has_options = True self.__option_list = Listbox(0) for option in options: - self.__option_list.append(option, option) + self.__option_list.append(option[0], option[1]) result = [self.__option_list] else: self.__has_options = False commit 506901b301190d29d446749c8e0cf4e8019ae809 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Fri Aug 13 09:13:44 2010 -0400 Fixed the package init source and examples to use them correctly. Added __all__ to __init__.py so that all modules are loaded correctly. diff --git a/examples/colorize b/examples/colorize index 9a464e3..8bdaad9 100755 --- a/examples/colorize +++ b/examples/colorize @@ -18,7 +18,7 @@ # MA 02110-1301, USA. A copy of the GNU General Public License is # also available at http://www.gnu.org/copyleft/gpl.html. -from newt_syrup.configscreen import ConfigScreen +from newt_syrup.configscreen import * from snack import * SELECT_SOMETHING = 1 diff --git a/examples/selections b/examples/selections index 469ee60..bba7f7f 100755 --- a/examples/selections +++ b/examples/selections @@ -18,7 +18,7 @@ # MA 02110-1301, USA. A copy of the GNU General Public License is # also available at http://www.gnu.org/copyleft/gpl.html. -from newt_syrup.configscreen import SelectionListConfigScreen +from newt_syrup.configscreen import SelectionListConfigScreen from snack import * SELECT_A_FRUIT = 1 diff --git a/newt_syrup/__init__.py b/newt_syrup/__init__.py index afda660..c3960c1 100644 --- a/newt_syrup/__init__.py +++ b/newt_syrup/__init__.py @@ -15,3 +15,5 @@ # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, # MA 02110-1301, USA. A copy of the GNU General Public License is # also available at http://www.gnu.org/copyleft/gpl.html. + +__all__ = ["configscreen"] commit 501e0282973b2d743fcbc3d1251493ff76b4a46e Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Thu Aug 12 14:15:16 2010 -0400 Some house keeping of the repo. Some files were still in the doc directory. They should instead be in the root directory. So I moved the files and removed the directory. diff --git a/COLORS b/COLORS new file mode 100644 index 0000000..7723280 --- /dev/null +++ b/COLORS @@ -0,0 +1,48 @@ +=== COLORS === + +The following lists the available colors within Newt for widgets: + +black (foreground and background) +red (foreground and background) +green (foreground and background) +brown (foreground and background) +blue (foreground and background) +magenta (foreground and background) +cyan (foreground and background) +lightgray (foreground and background) +gray (foreground only) +brightred (foreground only) +brightgreen (foreground only) +yellow (foreground only) +brightblue (foreground only) +brightmagenta (foreground only) +brightcyan (foreground only) +white (foreground only) + +=== WIDGET NAMES === + +The following lists the names of widgets: + +ROOT +BORDER +WINDOW +SHADOW +TITLE +BUTTON +ACTBUTTON +CHECKBOX +ACTCHECKBOX +ENTRY +LABEL +LISTBOX +ACTLISTBOX +TEXTBOX +ACTTEXTBOX +HELPLINE +ROOTTEXT +EMPTYSCALE +FULLSCALE +DISENTRY +COMPACTBUTTON +ACTSELLISTBOX +SELLISTBOX \ No newline at end of file diff --git a/COPYING b/COPYING index 4362b49..84d374e 100644 --- a/COPYING +++ b/COPYING @@ -111,7 +111,7 @@ modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. - + GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION @@ -216,7 +216,7 @@ instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. - + Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. @@ -267,7 +267,7 @@ Library will still fall under Section 6.) distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. - + 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work @@ -329,7 +329,7 @@ restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. - + 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined @@ -370,7 +370,7 @@ subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. - + 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or @@ -422,7 +422,7 @@ conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. - + 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is @@ -456,7 +456,7 @@ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS - + How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest diff --git a/ChangeLog b/ChangeLog index d61c903..a66436c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ Change Log: - * Added SelectionListConfigScreen. + * Version 0.1.1: + - Added support for color sets. + - Added support for using compact buttons. + * Version 0.1.0: + - Added SelectionListConfigScreen. diff --git a/MANIFEST.in b/MANIFEST.in index 3ea5aad..212e3d9 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,6 @@ include AUTHORS include ChangeLog +include COLORS include COPYING include newt_syrup/__init__.py diff --git a/doc/AUTHORS b/doc/AUTHORS deleted file mode 100644 index 54e40c9..0000000 --- a/doc/AUTHORS +++ /dev/null @@ -1,6 +0,0 @@ -The following people have brought this package to you: - -Project Lead: Darryl L. Pierce <dpierce(a)redhat.com> -Contributors: [none yet] - -Submit patches to get your name listed here! diff --git a/doc/COLORS b/doc/COLORS deleted file mode 100644 index 7723280..0000000 --- a/doc/COLORS +++ /dev/null @@ -1,48 +0,0 @@ -=== COLORS === - -The following lists the available colors within Newt for widgets: - -black (foreground and background) -red (foreground and background) -green (foreground and background) -brown (foreground and background) -blue (foreground and background) -magenta (foreground and background) -cyan (foreground and background) -lightgray (foreground and background) -gray (foreground only) -brightred (foreground only) -brightgreen (foreground only) -yellow (foreground only) -brightblue (foreground only) -brightmagenta (foreground only) -brightcyan (foreground only) -white (foreground only) - -=== WIDGET NAMES === - -The following lists the names of widgets: - -ROOT -BORDER -WINDOW -SHADOW -TITLE -BUTTON -ACTBUTTON -CHECKBOX -ACTCHECKBOX -ENTRY -LABEL -LISTBOX -ACTLISTBOX -TEXTBOX -ACTTEXTBOX -HELPLINE -ROOTTEXT -EMPTYSCALE -FULLSCALE -DISENTRY -COMPACTBUTTON -ACTSELLISTBOX -SELLISTBOX \ No newline at end of file diff --git a/doc/COPYING b/doc/COPYING deleted file mode 100644 index 4362b49..0000000 --- a/doc/COPYING +++ /dev/null @@ -1,502 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - <one line to give the library's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library 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 - 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random Hacker. - - <signature of Ty Coon>, 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! diff --git a/doc/ChangeLog b/doc/ChangeLog deleted file mode 100644 index a66436c..0000000 --- a/doc/ChangeLog +++ /dev/null @@ -1,7 +0,0 @@ -Change Log: - * Version 0.1.1: - - Added support for color sets. - - Added support for using compact buttons. - - * Version 0.1.0: - - Added SelectionListConfigScreen. commit bb078e0863330934131f8d41621ebe54c103d8e0 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Thu Aug 12 14:02:48 2010 -0400 Added support for compact buttons. Added a new function to ConfigScreen. It returns either True or False to indicate whether compact buttons should used, with a default of False. diff --git a/doc/ChangeLog b/doc/ChangeLog index ba6d6bd..a66436c 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,6 +1,7 @@ Change Log: * Version 0.1.1: - Added support for color sets. + - Added support for using compact buttons. * Version 0.1.0: - Added SelectionListConfigScreen. diff --git a/examples/selections b/examples/selections index 4ba41b0..469ee60 100755 --- a/examples/selections +++ b/examples/selections @@ -50,6 +50,9 @@ class SelectionsScreen(SelectionListConfigScreen): if page == SELECTION_MADE: return True return False + def use_compact_buttons(self): + return True + if __name__ == "__main__": screen = SelectionsScreen() screen.start() diff --git a/newt_syrup/configscreen.py b/newt_syrup/configscreen.py index e516056..448d1a6 100644 --- a/newt_syrup/configscreen.py +++ b/newt_syrup/configscreen.py @@ -81,6 +81,15 @@ class ConfigScreen: def get_current_page(self): 0 + def use_compact_buttons(self): + """ + If this returns True, then compact buttons will be used + on all displays. + + The default is to use normal buttons. + """ + False + def start(self): active = True while active and (self.__finished == False): @@ -115,14 +124,22 @@ class ConfigScreen: for element in elements: content.setField(element, 0, current_element) current_element += 1 + # create the navigation buttons buttons = [] - if self.__current_page > 1: buttons.append(["Back", BACK_BUTTON, "F11"]) - if self.page_has_next(self.__current_page): buttons.append(["Next", NEXT_BUTTON, "F12"]) - if self.page_has_finish(self.__current_page): buttons.append(["Finish", FINISH_BUTTON, "F10"]) + compact_buttons = 0 + if self.use_compact_buttons(): + compact_buttons = 1 + if self.__current_page > 1: + buttons.append(["Back", BACK_BUTTON, "F11"]) + if self.page_has_next(self.__current_page): + buttons.append(["Next", NEXT_BUTTON, "F12"]) + if self.page_has_finish(self.__current_page): + buttons.append(["Finish", FINISH_BUTTON, "F10"]) buttons.append(["Cancel", CANCEL_BUTTON, "ESC"]) - buttonbar = ButtonBar(screen, buttons) + buttonbar = ButtonBar(screen, buttons, compact = compact_buttons) content.setField(buttonbar, 0, current_element, growx = 1) + gridform.add(content, 1, 0, anchorTop = 1) current_element += 1 try: commit 7a18a11c04975b9cf5d1be50227eb6f82af4cccc Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Thu Aug 12 09:00:04 2010 -0400 Added support for setting the colors of widgets. Added a new example, named "colorize", which demonstrates this functionality. Also, renamed the examples to remove the .py extension. diff --git a/doc/COLORS b/doc/COLORS new file mode 100644 index 0000000..7723280 --- /dev/null +++ b/doc/COLORS @@ -0,0 +1,48 @@ +=== COLORS === + +The following lists the available colors within Newt for widgets: + +black (foreground and background) +red (foreground and background) +green (foreground and background) +brown (foreground and background) +blue (foreground and background) +magenta (foreground and background) +cyan (foreground and background) +lightgray (foreground and background) +gray (foreground only) +brightred (foreground only) +brightgreen (foreground only) +yellow (foreground only) +brightblue (foreground only) +brightmagenta (foreground only) +brightcyan (foreground only) +white (foreground only) + +=== WIDGET NAMES === + +The following lists the names of widgets: + +ROOT +BORDER +WINDOW +SHADOW +TITLE +BUTTON +ACTBUTTON +CHECKBOX +ACTCHECKBOX +ENTRY +LABEL +LISTBOX +ACTLISTBOX +TEXTBOX +ACTTEXTBOX +HELPLINE +ROOTTEXT +EMPTYSCALE +FULLSCALE +DISENTRY +COMPACTBUTTON +ACTSELLISTBOX +SELLISTBOX \ No newline at end of file diff --git a/doc/ChangeLog b/doc/ChangeLog index d61c903..ba6d6bd 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,6 @@ Change Log: - * Added SelectionListConfigScreen. + * Version 0.1.1: + - Added support for color sets. + * Version 0.1.0: + - Added SelectionListConfigScreen. diff --git a/examples/colorize b/examples/colorize new file mode 100755 index 0000000..9a464e3 --- /dev/null +++ b/examples/colorize @@ -0,0 +1,62 @@ +#!/usr/bin/env python + +# colorize - Copyright (C) 2010 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from newt_syrup.configscreen import ConfigScreen +from snack import * + +SELECT_SOMETHING = 1 + +class ColorizeScreen(ConfigScreen): + def __init__(self): + _colorset = {"ROOT" : ("black", "red"), + "BORDER" : ("black", "yellow"), + "BUTTON" : ("black", "green"), + "ACTBUTTON" : ("white", "green"), + "SHADOW" : ("black", "black"), + "LISTBOX" : ("black", "yellow"), + "WINDOW" : ("black", "yellow"), + "SELLISTBOX" : ("yellow", "black"), + "ACTLISTBOX" : ("yellow", "black"), + "ACTSELLISTBOX" : ("white", "black"), + "LABEL" : ("white", "gray"), + "HELPLINE" : ("white", "black") + } + ConfigScreen.__init__(self, + "Wizard Screen", + colorset = _colorset) + + def get_elements_for_page(self, screen, page): + if page == SELECT_SOMETHING: return self.get_main_page(screen) + + def get_main_page(self, screen): + pages = ("first", "second", "third", "fourth", "fifth", + "sixth", "seventh", "eighth", "ninth", "tenth", + "eleventh", "twelfth", "thirteenth", "fourteenth", "fifteenth", + "sixteenth", "seventeenth", "eighteenth", "nineteenth", "twentieth") + grid = Grid(2, 1) + option_page = Listbox(0, scroll = 1); + for page in pages: + option_page.append("This is the %s page." % page, page) + grid.setField(option_page, 0, 0) + return [Label("Something"), grid] + +if __name__ == "__main__": + screen = ColorizeScreen() + screen.start() diff --git a/examples/selections b/examples/selections new file mode 100755 index 0000000..4ba41b0 --- /dev/null +++ b/examples/selections @@ -0,0 +1,55 @@ +#!/usr/bin/env python + +# selections - Copyright (C) 2010 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from newt_syrup.configscreen import SelectionListConfigScreen +from snack import * + +SELECT_A_FRUIT = 1 +SELECTION_MADE = 2 + +class SelectionsScreen(SelectionListConfigScreen): + def __init__(self): + SelectionListConfigScreen.__init__(self,"Choose Your Favorite Fruit") + + def get_elements_for_page(self, screen, page): + if page == SELECT_A_FRUIT: return self.get_list_page(screen) + elif page == SELECTION_MADE: return self.get_selected_page(screen) + + def get_selected_page(self, screen): + grid = Grid(1, 1) + grid.setField(Label("I love %s too!" % self.get_selected_option()), 0, 0) + self.set_finished() + return [Label("So Do I!"), grid] + + def get_screen_options(self): + print "This was called!" + return ["Apples", "Oranges", "Tangerines", "Tomatoes (yes, they're fruit!)"] + + def page_has_next(self, page): + if page == SELECT_A_FRUIT: return True + return False + + def page_has_finish(self, page): + if page == SELECTION_MADE: return True + return False + +if __name__ == "__main__": + screen = SelectionsScreen() + screen.start() diff --git a/examples/selections.py b/examples/selections.py deleted file mode 100755 index 4ba41b0..0000000 --- a/examples/selections.py +++ /dev/null @@ -1,55 +0,0 @@ -#!/usr/bin/env python - -# selections - Copyright (C) 2010 Red Hat, Inc. -# Written by Darryl L. Pierce <dpierce(a)redhat.com> -# -# This program 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; version 2 of the License. -# -# This program 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 this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, -# MA 02110-1301, USA. A copy of the GNU General Public License is -# also available at http://www.gnu.org/copyleft/gpl.html. - -from newt_syrup.configscreen import SelectionListConfigScreen -from snack import * - -SELECT_A_FRUIT = 1 -SELECTION_MADE = 2 - -class SelectionsScreen(SelectionListConfigScreen): - def __init__(self): - SelectionListConfigScreen.__init__(self,"Choose Your Favorite Fruit") - - def get_elements_for_page(self, screen, page): - if page == SELECT_A_FRUIT: return self.get_list_page(screen) - elif page == SELECTION_MADE: return self.get_selected_page(screen) - - def get_selected_page(self, screen): - grid = Grid(1, 1) - grid.setField(Label("I love %s too!" % self.get_selected_option()), 0, 0) - self.set_finished() - return [Label("So Do I!"), grid] - - def get_screen_options(self): - print "This was called!" - return ["Apples", "Oranges", "Tangerines", "Tomatoes (yes, they're fruit!)"] - - def page_has_next(self, page): - if page == SELECT_A_FRUIT: return True - return False - - def page_has_finish(self, page): - if page == SELECTION_MADE: return True - return False - -if __name__ == "__main__": - screen = SelectionsScreen() - screen.start() diff --git a/newt_syrup/configscreen.py b/newt_syrup/configscreen.py index 4fd6525..e516056 100644 --- a/newt_syrup/configscreen.py +++ b/newt_syrup/configscreen.py @@ -25,12 +25,21 @@ CANCEL_BUTTON = "cancel" FINISH_BUTTON = "finish" class ConfigScreen: - '''Enables the creation of navigable, multi-paged configuration screens.''' + ''' + Enables the creation of navigable, multi-paged configuration screens. + + colorset - The colors to be used for items displayed. This is a dictionary + where the key value specifies the widget, and the value is an + array of two values: the foreground color and the background + color, respectively. See the COLORS file for details on what + colors, and widget names, are available + ''' - def __init__(self, title): + def __init__(self, title, colorset = None): self.__title = title self.__current_page = 1 self.__finished = False + self.__colorset = colorset def get_title(self): return self.__title @@ -76,6 +85,11 @@ class ConfigScreen: active = True while active and (self.__finished == False): screen = SnackScreen() + # apply any colorsets that were provided. + if self.__colorset is not None: + for item in self.__colorset.keys(): + colors = self.__colorset.get(item) + screen.setColor(item, colors[0], colors[1]) elements = self.get_elements_for_page(screen, self.__current_page) # TODO: need to set the form height to the number of elements on the page gridform = GridForm(screen, self.get_title(), 2, 2) @@ -148,8 +162,8 @@ class SelectionListConfigScreen(ConfigScreen): in order to map the core selection to the appropriate page. ''' - def __init__(self, title): - ConfigScreen.__init__(self, title) + def __init__(self, title, colorset = None): + ConfigScreen.__init__(self, title, colorset) def get_screen_options(self): """ commit da48829f6a19f744058143afc2bc9266f197d0d9 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Wed Aug 4 11:02:17 2010 -0400 A few more packaging changes. Moved the library files into a separate subdirectory and modified the MANIFEST to reflect those changes. diff --git a/MANIFEST.in b/MANIFEST.in index 8567abc..3ea5aad 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,9 @@ -include AUTHORS ChangeLog COPYING +include AUTHORS +include ChangeLog +include COPYING -include *.py -recursive-include examples * \ No newline at end of file +include newt_syrup/__init__.py +include newt_syrup/configscreen.py +include newt_syrup/menuscreen.py + +include examples/selections.py diff --git a/__init__.py b/__init__.py deleted file mode 100644 index afda660..0000000 --- a/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ -# __init__.py - Copyright (C) 2009 Red Hat, Inc. -# Written by Darryl L. Pierce <dpierce(a)redhat.com> -# -# This program 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; version 2 of the License. -# -# This program 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 this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, -# MA 02110-1301, USA. A copy of the GNU General Public License is -# also available at http://www.gnu.org/copyleft/gpl.html. diff --git a/configscreen.py b/configscreen.py deleted file mode 100644 index 4fd6525..0000000 --- a/configscreen.py +++ /dev/null @@ -1,182 +0,0 @@ -# configscreen.py - Copyright (C) 2009 Red Hat, Inc. -# Written by Darryl L. Pierce <dpierce(a)redhat.com> -# -# This program 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; version 2 of the License. -# -# This program 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 this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, -# MA 02110-1301, USA. A copy of the GNU General Public License is -# also available at http://www.gnu.org/copyleft/gpl.html. - -from snack import * -import traceback - -BACK_BUTTON = "back" -NEXT_BUTTON = "next" -CANCEL_BUTTON = "cancel" -FINISH_BUTTON = "finish" - -class ConfigScreen: - '''Enables the creation of navigable, multi-paged configuration screens.''' - - def __init__(self, title): - self.__title = title - self.__current_page = 1 - self.__finished = False - - def get_title(self): - return self.__title - - def set_finished(self): - self.__finished = True - - def get_elements_for_page(self, screen, page): - return [] - - def page_has_next(self, page): - return False - - def page_has_finish(self, page): - return False - - def get_back_page(self, page): - if page > 1: return page - 1 - return page - - def go_back(self): - self.__current_page = self.get_back_page(self.__current_page) - - def get_next_page(self, page): - return page + 1 - - def go_next(self): - self.__current_page = self.get_next_page(self.__current_page) - - def validate_input(self, page, errors): - return True - - def process_input(self, page): - return - - def get_page_list(self): - return [] - - def get_current_page(self): - 0 - - def start(self): - active = True - while active and (self.__finished == False): - screen = SnackScreen() - elements = self.get_elements_for_page(screen, self.__current_page) - # TODO: need to set the form height to the number of elements on the page - gridform = GridForm(screen, self.get_title(), 2, 2) - - # Here you would put the list of elements - # and programmatically set the indicator as - # they're rendered - pages = self.get_page_list() - if len(pages) > 0: - leftmenu = Grid(2, len(pages)) - current_element = 0 - for page in pages: - leftmenu.setField(Label(page), 0, current_element, anchorLeft = 1) - indicator = " " - if current_element == self.__current_page - 1: - indicator = "<-" - leftmenu.setField(Label(indicator), 1, current_element) - current_element += 1 - gridform.add(leftmenu, 0, 0, anchorTop = 1, padding = (3, 0, 3, 0)) - - content = Grid(1, len(elements) + 1) - current_element = 0 - for element in elements: - content.setField(element, 0, current_element) - current_element += 1 - # create the navigation buttons - buttons = [] - if self.__current_page > 1: buttons.append(["Back", BACK_BUTTON, "F11"]) - if self.page_has_next(self.__current_page): buttons.append(["Next", NEXT_BUTTON, "F12"]) - if self.page_has_finish(self.__current_page): buttons.append(["Finish", FINISH_BUTTON, "F10"]) - buttons.append(["Cancel", CANCEL_BUTTON, "ESC"]) - buttonbar = ButtonBar(screen, buttons) - content.setField(buttonbar, 0, current_element, growx = 1) - gridform.add(content, 1, 0, anchorTop = 1) - current_element += 1 - try: - result = gridform.runOnce() - pressed = buttonbar.buttonPressed(result) - if pressed == BACK_BUTTON: - self.go_back() - elif pressed == NEXT_BUTTON or pressed == FINISH_BUTTON: - errors = [] - if self.validate_input(self.__current_page, errors): - self.process_input(self.__current_page) - self.go_next() - else: - error_text = "" - for error in errors: - error_text += "%s\n" % error - ButtonChoiceWindow(screen, - "There Were Errors", - error_text, - buttons = ["OK"]) - elif pressed == CANCEL_BUTTON: - active = False - except Exception, error: - ButtonChoiceWindow(screen, - "An Exception Has Occurred", - str(error) + "\n" + traceback.format_exc(), - buttons = ["OK"]) - screen.popWindow() - screen.finish() - -class SelectionListConfigScreen(ConfigScreen): - ''' - Provides a class that can be used to give the user an initial list. - The system then branches based on the selection the user makes. - - The developer will still need to override the get_elements_for_page method - in order to map the core selection to the appropriate page. - ''' - - def __init__(self, title): - ConfigScreen.__init__(self, title) - - def get_screen_options(self): - """ - Returns the list of elements to be displayed on the screen. - """ - print "Called the parent instead." - return [] - - def get_list_page(self, screen): - options = self.get_screen_options() - result = None - - if len(options) > 0: - self.__has_options = True - self.__option_list = Listbox(0) - for option in options: - self.__option_list.append(option, option) - result = [self.__option_list] - else: - self.__has_options = False - grid = Grid(1, 1) - grid.setField(Label("There are no options available."), 0, 0) - result = [grid] - return result - - def get_selected_option(self): - return self.__option_list.current() - - def has_selectable_options(self): - return self.__has_options diff --git a/menuscreen.py b/menuscreen.py deleted file mode 100644 index 1700e8c..0000000 --- a/menuscreen.py +++ /dev/null @@ -1,57 +0,0 @@ -# mainmenu.py - Copyright (C) 2009 Red Hat, Inc. -# Written by Darryl L. Pierce <dpierce(a)redhat.com> -# -# This program 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; version 2 of the License. -# -# This program 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 this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, -# MA 02110-1301, USA. A copy of the GNU General Public License is -# also available at http://www.gnu.org/copyleft/gpl.html. - -from snack import * -import traceback - -import utils -import logging - -EXIT_MENU = 99 - -class MenuScreen: - def __init__(self, title): - self.__title = title - - def start(self): - finished = False - while finished == False: - screen = SnackScreen() - menu = Listbox(height = 0, width = 0, returnExit = 1) - for menu_item in self.get_menu_items(): - menu.append(menu_item[0], menu_item[1]) - menu.append("Exit Menu", EXIT_MENU) - gridform = GridForm(screen, self.__title, 1, 4) - gridform.add(menu, 0, 0) - result = gridform.run(); - screen.popWindow() - screen.finish() - - try: - if result.current() == EXIT_MENU: finished = True - else: self.handle_selection(result.current()) - except Exception, error: - screen = SnackScreen() - logging.info("An exception occurred: %s" % str(error)) - ButtonChoiceWindow(screen, - "An Exception Has Occurred", - str(error) + "\n" + traceback.format_exc(), - buttons = ["OK"]) - screen.popWindow() - screen.finish() - finished = True diff --git a/newt_syrup/__init__.py b/newt_syrup/__init__.py new file mode 100644 index 0000000..afda660 --- /dev/null +++ b/newt_syrup/__init__.py @@ -0,0 +1,17 @@ +# __init__.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. diff --git a/newt_syrup/configscreen.py b/newt_syrup/configscreen.py new file mode 100644 index 0000000..4fd6525 --- /dev/null +++ b/newt_syrup/configscreen.py @@ -0,0 +1,182 @@ +# configscreen.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from snack import * +import traceback + +BACK_BUTTON = "back" +NEXT_BUTTON = "next" +CANCEL_BUTTON = "cancel" +FINISH_BUTTON = "finish" + +class ConfigScreen: + '''Enables the creation of navigable, multi-paged configuration screens.''' + + def __init__(self, title): + self.__title = title + self.__current_page = 1 + self.__finished = False + + def get_title(self): + return self.__title + + def set_finished(self): + self.__finished = True + + def get_elements_for_page(self, screen, page): + return [] + + def page_has_next(self, page): + return False + + def page_has_finish(self, page): + return False + + def get_back_page(self, page): + if page > 1: return page - 1 + return page + + def go_back(self): + self.__current_page = self.get_back_page(self.__current_page) + + def get_next_page(self, page): + return page + 1 + + def go_next(self): + self.__current_page = self.get_next_page(self.__current_page) + + def validate_input(self, page, errors): + return True + + def process_input(self, page): + return + + def get_page_list(self): + return [] + + def get_current_page(self): + 0 + + def start(self): + active = True + while active and (self.__finished == False): + screen = SnackScreen() + elements = self.get_elements_for_page(screen, self.__current_page) + # TODO: need to set the form height to the number of elements on the page + gridform = GridForm(screen, self.get_title(), 2, 2) + + # Here you would put the list of elements + # and programmatically set the indicator as + # they're rendered + pages = self.get_page_list() + if len(pages) > 0: + leftmenu = Grid(2, len(pages)) + current_element = 0 + for page in pages: + leftmenu.setField(Label(page), 0, current_element, anchorLeft = 1) + indicator = " " + if current_element == self.__current_page - 1: + indicator = "<-" + leftmenu.setField(Label(indicator), 1, current_element) + current_element += 1 + gridform.add(leftmenu, 0, 0, anchorTop = 1, padding = (3, 0, 3, 0)) + + content = Grid(1, len(elements) + 1) + current_element = 0 + for element in elements: + content.setField(element, 0, current_element) + current_element += 1 + # create the navigation buttons + buttons = [] + if self.__current_page > 1: buttons.append(["Back", BACK_BUTTON, "F11"]) + if self.page_has_next(self.__current_page): buttons.append(["Next", NEXT_BUTTON, "F12"]) + if self.page_has_finish(self.__current_page): buttons.append(["Finish", FINISH_BUTTON, "F10"]) + buttons.append(["Cancel", CANCEL_BUTTON, "ESC"]) + buttonbar = ButtonBar(screen, buttons) + content.setField(buttonbar, 0, current_element, growx = 1) + gridform.add(content, 1, 0, anchorTop = 1) + current_element += 1 + try: + result = gridform.runOnce() + pressed = buttonbar.buttonPressed(result) + if pressed == BACK_BUTTON: + self.go_back() + elif pressed == NEXT_BUTTON or pressed == FINISH_BUTTON: + errors = [] + if self.validate_input(self.__current_page, errors): + self.process_input(self.__current_page) + self.go_next() + else: + error_text = "" + for error in errors: + error_text += "%s\n" % error + ButtonChoiceWindow(screen, + "There Were Errors", + error_text, + buttons = ["OK"]) + elif pressed == CANCEL_BUTTON: + active = False + except Exception, error: + ButtonChoiceWindow(screen, + "An Exception Has Occurred", + str(error) + "\n" + traceback.format_exc(), + buttons = ["OK"]) + screen.popWindow() + screen.finish() + +class SelectionListConfigScreen(ConfigScreen): + ''' + Provides a class that can be used to give the user an initial list. + The system then branches based on the selection the user makes. + + The developer will still need to override the get_elements_for_page method + in order to map the core selection to the appropriate page. + ''' + + def __init__(self, title): + ConfigScreen.__init__(self, title) + + def get_screen_options(self): + """ + Returns the list of elements to be displayed on the screen. + """ + print "Called the parent instead." + return [] + + def get_list_page(self, screen): + options = self.get_screen_options() + result = None + + if len(options) > 0: + self.__has_options = True + self.__option_list = Listbox(0) + for option in options: + self.__option_list.append(option, option) + result = [self.__option_list] + else: + self.__has_options = False + grid = Grid(1, 1) + grid.setField(Label("There are no options available."), 0, 0) + result = [grid] + return result + + def get_selected_option(self): + return self.__option_list.current() + + def has_selectable_options(self): + return self.__has_options diff --git a/newt_syrup/menuscreen.py b/newt_syrup/menuscreen.py new file mode 100644 index 0000000..1700e8c --- /dev/null +++ b/newt_syrup/menuscreen.py @@ -0,0 +1,57 @@ +# mainmenu.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from snack import * +import traceback + +import utils +import logging + +EXIT_MENU = 99 + +class MenuScreen: + def __init__(self, title): + self.__title = title + + def start(self): + finished = False + while finished == False: + screen = SnackScreen() + menu = Listbox(height = 0, width = 0, returnExit = 1) + for menu_item in self.get_menu_items(): + menu.append(menu_item[0], menu_item[1]) + menu.append("Exit Menu", EXIT_MENU) + gridform = GridForm(screen, self.__title, 1, 4) + gridform.add(menu, 0, 0) + result = gridform.run(); + screen.popWindow() + screen.finish() + + try: + if result.current() == EXIT_MENU: finished = True + else: self.handle_selection(result.current()) + except Exception, error: + screen = SnackScreen() + logging.info("An exception occurred: %s" % str(error)) + ButtonChoiceWindow(screen, + "An Exception Has Occurred", + str(error) + "\n" + traceback.format_exc(), + buttons = ["OK"]) + screen.popWindow() + screen.finish() + finished = True commit 7cf2dc0e2fb00dc618df5c7a7ace4869f9100308 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Tue Aug 3 09:57:20 2010 -0400 Added a files for packaging and distribution. Created a python-setuptool script for creating the bundle. Added a MANIFEST.in file to ensure all documentation files are included. diff --git a/.gitignore b/.gitignore index e69de29..2887c60 100644 --- a/.gitignore +++ b/.gitignore @@ -0,0 +1,2 @@ +*~ +*pyc diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..54e40c9 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,6 @@ +The following people have brought this package to you: + +Project Lead: Darryl L. Pierce <dpierce(a)redhat.com> +Contributors: [none yet] + +Submit patches to get your name listed here! diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..4362b49 --- /dev/null +++ b/COPYING @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..d61c903 --- /dev/null +++ b/ChangeLog @@ -0,0 +1,3 @@ +Change Log: + * Added SelectionListConfigScreen. + diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..8567abc --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,4 @@ +include AUTHORS ChangeLog COPYING + +include *.py +recursive-include examples * \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..afda660 --- /dev/null +++ b/__init__.py @@ -0,0 +1,17 @@ +# __init__.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. diff --git a/configscreen.py b/configscreen.py new file mode 100644 index 0000000..4fd6525 --- /dev/null +++ b/configscreen.py @@ -0,0 +1,182 @@ +# configscreen.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from snack import * +import traceback + +BACK_BUTTON = "back" +NEXT_BUTTON = "next" +CANCEL_BUTTON = "cancel" +FINISH_BUTTON = "finish" + +class ConfigScreen: + '''Enables the creation of navigable, multi-paged configuration screens.''' + + def __init__(self, title): + self.__title = title + self.__current_page = 1 + self.__finished = False + + def get_title(self): + return self.__title + + def set_finished(self): + self.__finished = True + + def get_elements_for_page(self, screen, page): + return [] + + def page_has_next(self, page): + return False + + def page_has_finish(self, page): + return False + + def get_back_page(self, page): + if page > 1: return page - 1 + return page + + def go_back(self): + self.__current_page = self.get_back_page(self.__current_page) + + def get_next_page(self, page): + return page + 1 + + def go_next(self): + self.__current_page = self.get_next_page(self.__current_page) + + def validate_input(self, page, errors): + return True + + def process_input(self, page): + return + + def get_page_list(self): + return [] + + def get_current_page(self): + 0 + + def start(self): + active = True + while active and (self.__finished == False): + screen = SnackScreen() + elements = self.get_elements_for_page(screen, self.__current_page) + # TODO: need to set the form height to the number of elements on the page + gridform = GridForm(screen, self.get_title(), 2, 2) + + # Here you would put the list of elements + # and programmatically set the indicator as + # they're rendered + pages = self.get_page_list() + if len(pages) > 0: + leftmenu = Grid(2, len(pages)) + current_element = 0 + for page in pages: + leftmenu.setField(Label(page), 0, current_element, anchorLeft = 1) + indicator = " " + if current_element == self.__current_page - 1: + indicator = "<-" + leftmenu.setField(Label(indicator), 1, current_element) + current_element += 1 + gridform.add(leftmenu, 0, 0, anchorTop = 1, padding = (3, 0, 3, 0)) + + content = Grid(1, len(elements) + 1) + current_element = 0 + for element in elements: + content.setField(element, 0, current_element) + current_element += 1 + # create the navigation buttons + buttons = [] + if self.__current_page > 1: buttons.append(["Back", BACK_BUTTON, "F11"]) + if self.page_has_next(self.__current_page): buttons.append(["Next", NEXT_BUTTON, "F12"]) + if self.page_has_finish(self.__current_page): buttons.append(["Finish", FINISH_BUTTON, "F10"]) + buttons.append(["Cancel", CANCEL_BUTTON, "ESC"]) + buttonbar = ButtonBar(screen, buttons) + content.setField(buttonbar, 0, current_element, growx = 1) + gridform.add(content, 1, 0, anchorTop = 1) + current_element += 1 + try: + result = gridform.runOnce() + pressed = buttonbar.buttonPressed(result) + if pressed == BACK_BUTTON: + self.go_back() + elif pressed == NEXT_BUTTON or pressed == FINISH_BUTTON: + errors = [] + if self.validate_input(self.__current_page, errors): + self.process_input(self.__current_page) + self.go_next() + else: + error_text = "" + for error in errors: + error_text += "%s\n" % error + ButtonChoiceWindow(screen, + "There Were Errors", + error_text, + buttons = ["OK"]) + elif pressed == CANCEL_BUTTON: + active = False + except Exception, error: + ButtonChoiceWindow(screen, + "An Exception Has Occurred", + str(error) + "\n" + traceback.format_exc(), + buttons = ["OK"]) + screen.popWindow() + screen.finish() + +class SelectionListConfigScreen(ConfigScreen): + ''' + Provides a class that can be used to give the user an initial list. + The system then branches based on the selection the user makes. + + The developer will still need to override the get_elements_for_page method + in order to map the core selection to the appropriate page. + ''' + + def __init__(self, title): + ConfigScreen.__init__(self, title) + + def get_screen_options(self): + """ + Returns the list of elements to be displayed on the screen. + """ + print "Called the parent instead." + return [] + + def get_list_page(self, screen): + options = self.get_screen_options() + result = None + + if len(options) > 0: + self.__has_options = True + self.__option_list = Listbox(0) + for option in options: + self.__option_list.append(option, option) + result = [self.__option_list] + else: + self.__has_options = False + grid = Grid(1, 1) + grid.setField(Label("There are no options available."), 0, 0) + result = [grid] + return result + + def get_selected_option(self): + return self.__option_list.current() + + def has_selectable_options(self): + return self.__has_options diff --git a/doc/AUTHORS b/doc/AUTHORS new file mode 100644 index 0000000..54e40c9 --- /dev/null +++ b/doc/AUTHORS @@ -0,0 +1,6 @@ +The following people have brought this package to you: + +Project Lead: Darryl L. Pierce <dpierce(a)redhat.com> +Contributors: [none yet] + +Submit patches to get your name listed here! diff --git a/doc/COPYING b/doc/COPYING new file mode 100644 index 0000000..4362b49 --- /dev/null +++ b/doc/COPYING @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/examples/selections.py b/examples/selections.py index 9ff6eb1..4ba41b0 100755 --- a/examples/selections.py +++ b/examples/selections.py @@ -18,7 +18,7 @@ # MA 02110-1301, USA. A copy of the GNU General Public License is # also available at http://www.gnu.org/copyleft/gpl.html. -from configscreen import SelectionListConfigScreen +from newt_syrup.configscreen import SelectionListConfigScreen from snack import * SELECT_A_FRUIT = 1 diff --git a/menuscreen.py b/menuscreen.py new file mode 100644 index 0000000..1700e8c --- /dev/null +++ b/menuscreen.py @@ -0,0 +1,57 @@ +# mainmenu.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from snack import * +import traceback + +import utils +import logging + +EXIT_MENU = 99 + +class MenuScreen: + def __init__(self, title): + self.__title = title + + def start(self): + finished = False + while finished == False: + screen = SnackScreen() + menu = Listbox(height = 0, width = 0, returnExit = 1) + for menu_item in self.get_menu_items(): + menu.append(menu_item[0], menu_item[1]) + menu.append("Exit Menu", EXIT_MENU) + gridform = GridForm(screen, self.__title, 1, 4) + gridform.add(menu, 0, 0) + result = gridform.run(); + screen.popWindow() + screen.finish() + + try: + if result.current() == EXIT_MENU: finished = True + else: self.handle_selection(result.current()) + except Exception, error: + screen = SnackScreen() + logging.info("An exception occurred: %s" % str(error)) + ButtonChoiceWindow(screen, + "An Exception Has Occurred", + str(error) + "\n" + traceback.format_exc(), + buttons = ["OK"]) + screen.popWindow() + screen.finish() + finished = True diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..ea4833e --- /dev/null +++ b/setup.py @@ -0,0 +1,19 @@ +#!/usr/bin/env python + +from setuptools import setup, find_packages + +setup(name = "newt_syrup", + version = "0.1.0", + packages = find_packages(), + author = "Darryl L. Pierce", + author_email = "dpierce(a)redhat.com", + description = "Newt Syrup is an app framework built on top of Newt", + long_description = "Newt Syrup is an app framework built on top of Newt.", + license = "LGPLv2", + url = "http://newt-syrup.fedorahosted.org/", + + install_requires = ['newt-python >= 0.52.11'], + + package_data = { + 'doc': ['*'] + }) diff --git a/src/__init__.py b/src/__init__.py deleted file mode 100644 index cc8be22..0000000 --- a/src/__init__.py +++ /dev/null @@ -1,19 +0,0 @@ -# __init__.py - Copyright (C) 2009 Red Hat, Inc. -# Written by Darryl L. Pierce <dpierce(a)redhat.com> -# -# This program 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; version 2 of the License. -# -# This program 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 this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, -# MA 02110-1301, USA. A copy of the GNU General Public License is -# also available at http://www.gnu.org/copyleft/gpl.html. - -from nodeadmin import NodeAdmin diff --git a/src/configscreen.py b/src/configscreen.py deleted file mode 100644 index 4fd6525..0000000 --- a/src/configscreen.py +++ /dev/null @@ -1,182 +0,0 @@ -# configscreen.py - Copyright (C) 2009 Red Hat, Inc. -# Written by Darryl L. Pierce <dpierce(a)redhat.com> -# -# This program 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; version 2 of the License. -# -# This program 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 this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, -# MA 02110-1301, USA. A copy of the GNU General Public License is -# also available at http://www.gnu.org/copyleft/gpl.html. - -from snack import * -import traceback - -BACK_BUTTON = "back" -NEXT_BUTTON = "next" -CANCEL_BUTTON = "cancel" -FINISH_BUTTON = "finish" - -class ConfigScreen: - '''Enables the creation of navigable, multi-paged configuration screens.''' - - def __init__(self, title): - self.__title = title - self.__current_page = 1 - self.__finished = False - - def get_title(self): - return self.__title - - def set_finished(self): - self.__finished = True - - def get_elements_for_page(self, screen, page): - return [] - - def page_has_next(self, page): - return False - - def page_has_finish(self, page): - return False - - def get_back_page(self, page): - if page > 1: return page - 1 - return page - - def go_back(self): - self.__current_page = self.get_back_page(self.__current_page) - - def get_next_page(self, page): - return page + 1 - - def go_next(self): - self.__current_page = self.get_next_page(self.__current_page) - - def validate_input(self, page, errors): - return True - - def process_input(self, page): - return - - def get_page_list(self): - return [] - - def get_current_page(self): - 0 - - def start(self): - active = True - while active and (self.__finished == False): - screen = SnackScreen() - elements = self.get_elements_for_page(screen, self.__current_page) - # TODO: need to set the form height to the number of elements on the page - gridform = GridForm(screen, self.get_title(), 2, 2) - - # Here you would put the list of elements - # and programmatically set the indicator as - # they're rendered - pages = self.get_page_list() - if len(pages) > 0: - leftmenu = Grid(2, len(pages)) - current_element = 0 - for page in pages: - leftmenu.setField(Label(page), 0, current_element, anchorLeft = 1) - indicator = " " - if current_element == self.__current_page - 1: - indicator = "<-" - leftmenu.setField(Label(indicator), 1, current_element) - current_element += 1 - gridform.add(leftmenu, 0, 0, anchorTop = 1, padding = (3, 0, 3, 0)) - - content = Grid(1, len(elements) + 1) - current_element = 0 - for element in elements: - content.setField(element, 0, current_element) - current_element += 1 - # create the navigation buttons - buttons = [] - if self.__current_page > 1: buttons.append(["Back", BACK_BUTTON, "F11"]) - if self.page_has_next(self.__current_page): buttons.append(["Next", NEXT_BUTTON, "F12"]) - if self.page_has_finish(self.__current_page): buttons.append(["Finish", FINISH_BUTTON, "F10"]) - buttons.append(["Cancel", CANCEL_BUTTON, "ESC"]) - buttonbar = ButtonBar(screen, buttons) - content.setField(buttonbar, 0, current_element, growx = 1) - gridform.add(content, 1, 0, anchorTop = 1) - current_element += 1 - try: - result = gridform.runOnce() - pressed = buttonbar.buttonPressed(result) - if pressed == BACK_BUTTON: - self.go_back() - elif pressed == NEXT_BUTTON or pressed == FINISH_BUTTON: - errors = [] - if self.validate_input(self.__current_page, errors): - self.process_input(self.__current_page) - self.go_next() - else: - error_text = "" - for error in errors: - error_text += "%s\n" % error - ButtonChoiceWindow(screen, - "There Were Errors", - error_text, - buttons = ["OK"]) - elif pressed == CANCEL_BUTTON: - active = False - except Exception, error: - ButtonChoiceWindow(screen, - "An Exception Has Occurred", - str(error) + "\n" + traceback.format_exc(), - buttons = ["OK"]) - screen.popWindow() - screen.finish() - -class SelectionListConfigScreen(ConfigScreen): - ''' - Provides a class that can be used to give the user an initial list. - The system then branches based on the selection the user makes. - - The developer will still need to override the get_elements_for_page method - in order to map the core selection to the appropriate page. - ''' - - def __init__(self, title): - ConfigScreen.__init__(self, title) - - def get_screen_options(self): - """ - Returns the list of elements to be displayed on the screen. - """ - print "Called the parent instead." - return [] - - def get_list_page(self, screen): - options = self.get_screen_options() - result = None - - if len(options) > 0: - self.__has_options = True - self.__option_list = Listbox(0) - for option in options: - self.__option_list.append(option, option) - result = [self.__option_list] - else: - self.__has_options = False - grid = Grid(1, 1) - grid.setField(Label("There are no options available."), 0, 0) - result = [grid] - return result - - def get_selected_option(self): - return self.__option_list.current() - - def has_selectable_options(self): - return self.__has_options diff --git a/src/menuscreen.py b/src/menuscreen.py deleted file mode 100644 index 1700e8c..0000000 --- a/src/menuscreen.py +++ /dev/null @@ -1,57 +0,0 @@ -# mainmenu.py - Copyright (C) 2009 Red Hat, Inc. -# Written by Darryl L. Pierce <dpierce(a)redhat.com> -# -# This program 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; version 2 of the License. -# -# This program 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 this program; if not, write to the Free Software -# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, -# MA 02110-1301, USA. A copy of the GNU General Public License is -# also available at http://www.gnu.org/copyleft/gpl.html. - -from snack import * -import traceback - -import utils -import logging - -EXIT_MENU = 99 - -class MenuScreen: - def __init__(self, title): - self.__title = title - - def start(self): - finished = False - while finished == False: - screen = SnackScreen() - menu = Listbox(height = 0, width = 0, returnExit = 1) - for menu_item in self.get_menu_items(): - menu.append(menu_item[0], menu_item[1]) - menu.append("Exit Menu", EXIT_MENU) - gridform = GridForm(screen, self.__title, 1, 4) - gridform.add(menu, 0, 0) - result = gridform.run(); - screen.popWindow() - screen.finish() - - try: - if result.current() == EXIT_MENU: finished = True - else: self.handle_selection(result.current()) - except Exception, error: - screen = SnackScreen() - logging.info("An exception occurred: %s" % str(error)) - ButtonChoiceWindow(screen, - "An Exception Has Occurred", - str(error) + "\n" + traceback.format_exc(), - buttons = ["OK"]) - screen.popWindow() - screen.finish() - finished = True commit 6e2d2508838b81f12cca5db592e6e490319ee368 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Mon Aug 2 07:41:36 2010 -0400 Created SelectionListConfigScreen. This class takes a list of selectable options and presents them to the user as the initial screen. Also included an example app for writing a selection screen. diff --git a/doc/ChangeLog b/doc/ChangeLog new file mode 100644 index 0000000..d61c903 --- /dev/null +++ b/doc/ChangeLog @@ -0,0 +1,3 @@ +Change Log: + * Added SelectionListConfigScreen. + diff --git a/examples/selections.py b/examples/selections.py new file mode 100755 index 0000000..9ff6eb1 --- /dev/null +++ b/examples/selections.py @@ -0,0 +1,55 @@ +#!/usr/bin/env python + +# selections - Copyright (C) 2010 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from configscreen import SelectionListConfigScreen +from snack import * + +SELECT_A_FRUIT = 1 +SELECTION_MADE = 2 + +class SelectionsScreen(SelectionListConfigScreen): + def __init__(self): + SelectionListConfigScreen.__init__(self,"Choose Your Favorite Fruit") + + def get_elements_for_page(self, screen, page): + if page == SELECT_A_FRUIT: return self.get_list_page(screen) + elif page == SELECTION_MADE: return self.get_selected_page(screen) + + def get_selected_page(self, screen): + grid = Grid(1, 1) + grid.setField(Label("I love %s too!" % self.get_selected_option()), 0, 0) + self.set_finished() + return [Label("So Do I!"), grid] + + def get_screen_options(self): + print "This was called!" + return ["Apples", "Oranges", "Tangerines", "Tomatoes (yes, they're fruit!)"] + + def page_has_next(self, page): + if page == SELECT_A_FRUIT: return True + return False + + def page_has_finish(self, page): + if page == SELECTION_MADE: return True + return False + +if __name__ == "__main__": + screen = SelectionsScreen() + screen.start() diff --git a/src/configscreen.py b/src/configscreen.py index bb7f978..4fd6525 100644 --- a/src/configscreen.py +++ b/src/configscreen.py @@ -17,8 +17,6 @@ # also available at http://www.gnu.org/copyleft/gpl.html. from snack import * -from halworker import HALWorker -from libvirtworker import * import traceback BACK_BUTTON = "back" @@ -33,22 +31,10 @@ class ConfigScreen: self.__title = title self.__current_page = 1 self.__finished = False - self.__hal = HALWorker() - self.__libvirt = LibvirtWorker() - self.__vm_config = VirtManagerConfig() def get_title(self): return self.__title - def get_hal(self): - return self.__hal - - def get_libvirt(self): - return self.__libvirt - - def get_virt_manager_config(self): - return self.__vm_config - def set_finished(self): self.__finished = True @@ -153,143 +139,44 @@ class ConfigScreen: screen.popWindow() screen.finish() -class DomainListConfigScreen(ConfigScreen): - '''Provides a base class for all config screens that require a domain list.''' +class SelectionListConfigScreen(ConfigScreen): + ''' + Provides a class that can be used to give the user an initial list. + The system then branches based on the selection the user makes. + + The developer will still need to override the get_elements_for_page method + in order to map the core selection to the appropriate page. + ''' def __init__(self, title): ConfigScreen.__init__(self, title) - def get_domain_list_page(self, screen, defined=True, created=True): - domains = self.get_libvirt().list_domains(defined, created) + def get_screen_options(self): + """ + Returns the list of elements to be displayed on the screen. + """ + print "Called the parent instead." + return [] + + def get_list_page(self, screen): + options = self.get_screen_options() result = None - if len(domains) > 0: - self.__has_domains = True - self.__domain_list = Listbox(0) - for name in domains: - self.__domain_list.append(name, name) - result = [self.__domain_list] + if len(options) > 0: + self.__has_options = True + self.__option_list = Listbox(0) + for option in options: + self.__option_list.append(option, option) + result = [self.__option_list] else: - self.__has_domains = False + self.__has_options = False grid = Grid(1, 1) - grid.setField(Label("There are no domains available."), 0, 0) + grid.setField(Label("There are no options available."), 0, 0) result = [grid] return result - def get_selected_domain(self): - return self.__domain_list.current() - - def has_selectable_domains(self): - return self.__has_domains - -class NetworkListConfigScreen(ConfigScreen): - '''Provides a base class for all config screens that require a network list.''' - - def __init__(self, title): - ConfigScreen.__init__(self, title) - - def get_network_list_page(self, screen, defined=True, created=True): - networks = self.get_libvirt().list_networks(defined, created) - result = None - - if len(networks) > 0: - self.__has_networks = True - self.__network_list = Listbox(0) - for name in networks: - self.__network_list.append(name, name) - result = self.__network_list - else: - self.__has_networks = False - result = Label("There are no networks available.") - grid = Grid(1, 1) - grid.setField(result, 0, 0) - return [Label("Network List"), - grid] - - def get_selected_network(self): - return self.__network_list.current() - - def has_selectable_networks(self): - return self.__has_networks - -class StorageListConfigScreen(ConfigScreen): - '''Provides a base class for any configuration screen that deals with storage pool lists.''' - - def __init__(self, title): - ConfigScreen.__init__(self, title) - - def get_storage_pool_list_page(self, screen, defined=True, created=True): - pools = self.get_libvirt().list_storage_pools(defined=defined, created=created) - if len(pools) > 0: - self.__has_pools = True - self.__pools_list = Listbox(0) - for pool in pools: - self.__pools_list.append(pool, pool) - result = self.__pools_list - else: - self.__has_pools = False - result = Label("There are no storage pools available.") - grid = Grid(1, 1) - grid.setField(result, 0, 0) - return [Label("Storage Pool List"), - grid] - - def get_selected_pool(self): - return self.__pools_list.current() - - def has_selectable_pools(self): - return self.__has_pools - - def get_storage_volume_list_page(self, screen): - '''Requires that self.__pools_list have a selected element.''' - pool = self.get_libvirt().get_storage_pool(self.get_selected_pool()) - if len(pool.listVolumes()) > 0: - self.__has_volumes = True - self.__volumes_list = Listbox(0) - for volname in pool.listVolumes(): - volume = pool.storageVolLookupByName(volname) - self.__volumes_list.append("%s (%0.2f GB)" % (volume.name(), volume.info()[2] / 1024**3), volume.name()) - result = self.__volumes_list - else: - self.__has_volumes = False - result = Label("There are no storage volumes available.") - grid = Grid(1, 1) - grid.setField(result, 0, 0) - return [Label("Storage Volume List"), - grid] - - def get_selected_volume(self): - return self.__volumes_list.current() - - def has_selectable_volumes(self): - return self.__has_volumes - -class HostListConfigScreen(ConfigScreen): - '''Provides a base class for working with lists of libvirt hosts.''' - - def __init__(self, title): - ConfigScreen.__init__(self, title) - - def get_connection_list_page(self, screen): - connections = self.get_virt_manager_config().get_connection_list() - result = None - - if len(connections) > 0: - self.__has_connections = True - self.__connection_list = Listbox(0) - for connection in connections: - self.__connection_list.append(connection, connection) - result = self.__connection_list - else: - self.__has_connections = False - result = Label("There are no defined connections.") - grid = Grid(1, 1) - grid.setField(result, 0, 0) - return [Label("Host List"), - grid] - - def get_selected_connection(self): - return self.__connection_list.current() + def get_selected_option(self): + return self.__option_list.current() - def has_selectable_connections(self): - return self.__has_connections + def has_selectable_options(self): + return self.__has_options commit 77682f65c7f412fa4d7cea8b518109e3f8d5d8b0 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Mon Aug 2 07:35:59 2010 -0400 Initial checkin of the base source modules. The sources were taken from the ovirt-node project where I originally developed the code. diff --git a/src/__init__.py b/src/__init__.py new file mode 100644 index 0000000..cc8be22 --- /dev/null +++ b/src/__init__.py @@ -0,0 +1,19 @@ +# __init__.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from nodeadmin import NodeAdmin diff --git a/src/configscreen.py b/src/configscreen.py new file mode 100644 index 0000000..bb7f978 --- /dev/null +++ b/src/configscreen.py @@ -0,0 +1,295 @@ +# configscreen.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from snack import * +from halworker import HALWorker +from libvirtworker import * +import traceback + +BACK_BUTTON = "back" +NEXT_BUTTON = "next" +CANCEL_BUTTON = "cancel" +FINISH_BUTTON = "finish" + +class ConfigScreen: + '''Enables the creation of navigable, multi-paged configuration screens.''' + + def __init__(self, title): + self.__title = title + self.__current_page = 1 + self.__finished = False + self.__hal = HALWorker() + self.__libvirt = LibvirtWorker() + self.__vm_config = VirtManagerConfig() + + def get_title(self): + return self.__title + + def get_hal(self): + return self.__hal + + def get_libvirt(self): + return self.__libvirt + + def get_virt_manager_config(self): + return self.__vm_config + + def set_finished(self): + self.__finished = True + + def get_elements_for_page(self, screen, page): + return [] + + def page_has_next(self, page): + return False + + def page_has_finish(self, page): + return False + + def get_back_page(self, page): + if page > 1: return page - 1 + return page + + def go_back(self): + self.__current_page = self.get_back_page(self.__current_page) + + def get_next_page(self, page): + return page + 1 + + def go_next(self): + self.__current_page = self.get_next_page(self.__current_page) + + def validate_input(self, page, errors): + return True + + def process_input(self, page): + return + + def get_page_list(self): + return [] + + def get_current_page(self): + 0 + + def start(self): + active = True + while active and (self.__finished == False): + screen = SnackScreen() + elements = self.get_elements_for_page(screen, self.__current_page) + # TODO: need to set the form height to the number of elements on the page + gridform = GridForm(screen, self.get_title(), 2, 2) + + # Here you would put the list of elements + # and programmatically set the indicator as + # they're rendered + pages = self.get_page_list() + if len(pages) > 0: + leftmenu = Grid(2, len(pages)) + current_element = 0 + for page in pages: + leftmenu.setField(Label(page), 0, current_element, anchorLeft = 1) + indicator = " " + if current_element == self.__current_page - 1: + indicator = "<-" + leftmenu.setField(Label(indicator), 1, current_element) + current_element += 1 + gridform.add(leftmenu, 0, 0, anchorTop = 1, padding = (3, 0, 3, 0)) + + content = Grid(1, len(elements) + 1) + current_element = 0 + for element in elements: + content.setField(element, 0, current_element) + current_element += 1 + # create the navigation buttons + buttons = [] + if self.__current_page > 1: buttons.append(["Back", BACK_BUTTON, "F11"]) + if self.page_has_next(self.__current_page): buttons.append(["Next", NEXT_BUTTON, "F12"]) + if self.page_has_finish(self.__current_page): buttons.append(["Finish", FINISH_BUTTON, "F10"]) + buttons.append(["Cancel", CANCEL_BUTTON, "ESC"]) + buttonbar = ButtonBar(screen, buttons) + content.setField(buttonbar, 0, current_element, growx = 1) + gridform.add(content, 1, 0, anchorTop = 1) + current_element += 1 + try: + result = gridform.runOnce() + pressed = buttonbar.buttonPressed(result) + if pressed == BACK_BUTTON: + self.go_back() + elif pressed == NEXT_BUTTON or pressed == FINISH_BUTTON: + errors = [] + if self.validate_input(self.__current_page, errors): + self.process_input(self.__current_page) + self.go_next() + else: + error_text = "" + for error in errors: + error_text += "%s\n" % error + ButtonChoiceWindow(screen, + "There Were Errors", + error_text, + buttons = ["OK"]) + elif pressed == CANCEL_BUTTON: + active = False + except Exception, error: + ButtonChoiceWindow(screen, + "An Exception Has Occurred", + str(error) + "\n" + traceback.format_exc(), + buttons = ["OK"]) + screen.popWindow() + screen.finish() + +class DomainListConfigScreen(ConfigScreen): + '''Provides a base class for all config screens that require a domain list.''' + + def __init__(self, title): + ConfigScreen.__init__(self, title) + + def get_domain_list_page(self, screen, defined=True, created=True): + domains = self.get_libvirt().list_domains(defined, created) + result = None + + if len(domains) > 0: + self.__has_domains = True + self.__domain_list = Listbox(0) + for name in domains: + self.__domain_list.append(name, name) + result = [self.__domain_list] + else: + self.__has_domains = False + grid = Grid(1, 1) + grid.setField(Label("There are no domains available."), 0, 0) + result = [grid] + return result + + def get_selected_domain(self): + return self.__domain_list.current() + + def has_selectable_domains(self): + return self.__has_domains + +class NetworkListConfigScreen(ConfigScreen): + '''Provides a base class for all config screens that require a network list.''' + + def __init__(self, title): + ConfigScreen.__init__(self, title) + + def get_network_list_page(self, screen, defined=True, created=True): + networks = self.get_libvirt().list_networks(defined, created) + result = None + + if len(networks) > 0: + self.__has_networks = True + self.__network_list = Listbox(0) + for name in networks: + self.__network_list.append(name, name) + result = self.__network_list + else: + self.__has_networks = False + result = Label("There are no networks available.") + grid = Grid(1, 1) + grid.setField(result, 0, 0) + return [Label("Network List"), + grid] + + def get_selected_network(self): + return self.__network_list.current() + + def has_selectable_networks(self): + return self.__has_networks + +class StorageListConfigScreen(ConfigScreen): + '''Provides a base class for any configuration screen that deals with storage pool lists.''' + + def __init__(self, title): + ConfigScreen.__init__(self, title) + + def get_storage_pool_list_page(self, screen, defined=True, created=True): + pools = self.get_libvirt().list_storage_pools(defined=defined, created=created) + if len(pools) > 0: + self.__has_pools = True + self.__pools_list = Listbox(0) + for pool in pools: + self.__pools_list.append(pool, pool) + result = self.__pools_list + else: + self.__has_pools = False + result = Label("There are no storage pools available.") + grid = Grid(1, 1) + grid.setField(result, 0, 0) + return [Label("Storage Pool List"), + grid] + + def get_selected_pool(self): + return self.__pools_list.current() + + def has_selectable_pools(self): + return self.__has_pools + + def get_storage_volume_list_page(self, screen): + '''Requires that self.__pools_list have a selected element.''' + pool = self.get_libvirt().get_storage_pool(self.get_selected_pool()) + if len(pool.listVolumes()) > 0: + self.__has_volumes = True + self.__volumes_list = Listbox(0) + for volname in pool.listVolumes(): + volume = pool.storageVolLookupByName(volname) + self.__volumes_list.append("%s (%0.2f GB)" % (volume.name(), volume.info()[2] / 1024**3), volume.name()) + result = self.__volumes_list + else: + self.__has_volumes = False + result = Label("There are no storage volumes available.") + grid = Grid(1, 1) + grid.setField(result, 0, 0) + return [Label("Storage Volume List"), + grid] + + def get_selected_volume(self): + return self.__volumes_list.current() + + def has_selectable_volumes(self): + return self.__has_volumes + +class HostListConfigScreen(ConfigScreen): + '''Provides a base class for working with lists of libvirt hosts.''' + + def __init__(self, title): + ConfigScreen.__init__(self, title) + + def get_connection_list_page(self, screen): + connections = self.get_virt_manager_config().get_connection_list() + result = None + + if len(connections) > 0: + self.__has_connections = True + self.__connection_list = Listbox(0) + for connection in connections: + self.__connection_list.append(connection, connection) + result = self.__connection_list + else: + self.__has_connections = False + result = Label("There are no defined connections.") + grid = Grid(1, 1) + grid.setField(result, 0, 0) + return [Label("Host List"), + grid] + + def get_selected_connection(self): + return self.__connection_list.current() + + def has_selectable_connections(self): + return self.__has_connections diff --git a/src/menuscreen.py b/src/menuscreen.py new file mode 100644 index 0000000..1700e8c --- /dev/null +++ b/src/menuscreen.py @@ -0,0 +1,57 @@ +# mainmenu.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from snack import * +import traceback + +import utils +import logging + +EXIT_MENU = 99 + +class MenuScreen: + def __init__(self, title): + self.__title = title + + def start(self): + finished = False + while finished == False: + screen = SnackScreen() + menu = Listbox(height = 0, width = 0, returnExit = 1) + for menu_item in self.get_menu_items(): + menu.append(menu_item[0], menu_item[1]) + menu.append("Exit Menu", EXIT_MENU) + gridform = GridForm(screen, self.__title, 1, 4) + gridform.add(menu, 0, 0) + result = gridform.run(); + screen.popWindow() + screen.finish() + + try: + if result.current() == EXIT_MENU: finished = True + else: self.handle_selection(result.current()) + except Exception, error: + screen = SnackScreen() + logging.info("An exception occurred: %s" % str(error)) + ButtonChoiceWindow(screen, + "An Exception Has Occurred", + str(error) + "\n" + traceback.format_exc(), + buttons = ["OK"]) + screen.popWindow() + screen.finish() + finished = True

13 years, 7 months

1
0
0 / 0

Branch 'devel' - ChangeLog examples/dialog newt_syrup/dialogscreen.py

by Darryl L. Pierce

ChangeLog | 1 examples/dialog | 26 +++++++++++++++++++++++ newt_syrup/dialogscreen.py | 49 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 76 insertions(+) New commits: commit f6b6c0981d96d3694af32fd2b2f6db7277e319a1 Author: Darryl L. Pierce <dpierce(a)redhat.com> Date: Fri Sep 10 15:11:59 2010 -0400 Added support for dialog boxes. Created a new class, named DialogScreen, that takes a title and a message. It then shows those when the dialog is started. Dialog boxes support colorsets in the same way as other screen types. diff --git a/ChangeLog b/ChangeLog index 6cf5860..574fb0c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -4,6 +4,7 @@ Change Log: - Added support for using compact buttons. - Fixed the option model for SelectionListConfigScreen. - Added support for full screen applications. + - Added dialog boxes. * Version 0.1.0: - Added SelectionListConfigScreen. diff --git a/examples/dialog b/examples/dialog new file mode 100755 index 0000000..9415934 --- /dev/null +++ b/examples/dialog @@ -0,0 +1,26 @@ +#!/usr/bin/env python +# +# dialog - Copyright (C) 2010 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from newt_syrup.dialogscreen import * + +if __name__ == "__main__": + dialog = DialogScreen("This is the title", + "And this is an informative message.") + dialog.show() diff --git a/newt_syrup/dialogscreen.py b/newt_syrup/dialogscreen.py new file mode 100644 index 0000000..6b8c9a9 --- /dev/null +++ b/newt_syrup/dialogscreen.py @@ -0,0 +1,49 @@ +# dialogscreens.py - Copyright (C) 2009 Red Hat, Inc. +# Written by Darryl L. Pierce <dpierce(a)redhat.com> +# +# This program 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; version 2 of the License. +# +# This program 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 this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, +# MA 02110-1301, USA. A copy of the GNU General Public License is +# also available at http://www.gnu.org/copyleft/gpl.html. + +from snack import * + +import _snack +import traceback + +class DialogScreen: + """ + Lets the user present a single dialog box with a message. + """ + + def __init__(self, title, message, colorset = None): + self.__title = title + self.__message = message + self.__colorset = colorset + + def show(self): + screen = SnackScreen() + + # apply the colorset + if self.__colorset is not None: + for item in self.__colorset.keys(): + colors = self.__colorset.get(item) + screen.setColor(item, colors[0], colors[1]) + + ButtonChoiceWindow(screen, + self.__title, + self.__message, + buttons = ["Close"]) + screen.popWindow() + screen.finish() +

13 years, 7 months

1
0
0 / 0

← Newer
1
Older →

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

Newt-syrup September 2010