Imported Upstream version 3.2.2

[debian/gnuradio] / grc / gui / Dialogs.py

diff --git a/grc/gui/Dialogs.py b/grc/gui/Dialogs.py
new file mode 100644 (file)
index 0000000..8d764e2
--- /dev/null
+++ b/grc/gui/Dialogs.py
@@ -0,0 +1,105 @@
+"""
+Copyright 2008, 2009 Free Software Foundation, Inc.
+This file is part of GNU Radio
+
+GNU Radio Companion 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; either version 2
+of the License, or (at your option) any later version.
+
+GNU Radio Companion 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
+"""
+
+import pygtk
+pygtk.require('2.0')
+import gtk
+import Preferences
+import Utils
+
+class TextDisplay(gtk.TextView):
+       """A non editable gtk text view."""
+
+       def __init__(self, text=''):
+               """
+               TextDisplay constructor.
+               @param text the text to display (string)
+               """
+               text_buffer = gtk.TextBuffer()
+               text_buffer.set_text(text)
+               self.set_text = text_buffer.set_text
+               self.insert = lambda line: text_buffer.insert(text_buffer.get_end_iter(), line)
+               gtk.TextView.__init__(self, text_buffer)
+               self.set_editable(False)
+               self.set_cursor_visible(False)
+               self.set_wrap_mode(gtk.WRAP_WORD_CHAR)
+
+def MessageDialogHelper(type, buttons, title=None, markup=None):
+       """
+       Create a modal message dialog and run it.
+       @param type the type of message: gtk.MESSAGE_INFO, gtk.MESSAGE_WARNING, gtk.MESSAGE_QUESTION or gtk.MESSAGE_ERROR
+       @param buttons the predefined set of buttons to use:
+               gtk.BUTTONS_NONE, gtk.BUTTONS_OK, gtk.BUTTONS_CLOSE, gtk.BUTTONS_CANCEL, gtk.BUTTONS_YES_NO, gtk.BUTTONS_OK_CANCEL
+       @param tittle the title of the window (string)
+       @param markup the message text with pango markup
+       @return the gtk response from run()
+       """
+       message_dialog = gtk.MessageDialog(None, gtk.DIALOG_MODAL, type, buttons)
+       if title: message_dialog.set_title(title)
+       if markup: message_dialog.set_markup(markup)
+       response = message_dialog.run()
+       message_dialog.destroy()
+       return response
+
+class AboutDialog(gtk.AboutDialog):
+       """A cute little about dialog."""
+
+       def __init__(self, platform):
+               """AboutDialog constructor."""
+               gtk.AboutDialog.__init__(self)
+               self.set_name(platform.get_name())
+               self.set_version(platform.get_version())
+               self.set_license(platform.get_license())
+               self.set_copyright(platform.get_license().splitlines()[0])
+               self.set_website(platform.get_website())
+               self.run()
+               self.destroy()
+
+def HelpDialog(): MessageDialogHelper(
+       type=gtk.MESSAGE_INFO,
+       buttons=gtk.BUTTONS_CLOSE,
+       title='Help',
+       markup="""\
+<b>Usage Tips</b>
+
+<u>Add block</u>: drag and drop or double click a block in the block selection window.
+<u>Rotate block</u>: Select a block, press left/right on the keyboard.
+<u>Change type</u>: Select a block, press up/down on the keyboard.
+<u>Edit parameters</u>: double click on a block in the flow graph.
+<u>Make connection</u>: click on the source port of one block, then click on the sink port of another block.
+<u>Remove connection</u>: select the connection and press delete, or drag the connection.
+
+* See the menu for other keyboard shortcuts.""")
+
+COLORS_DIALOG_MARKUP_TMPL = """\
+<b>Color Mapping</b>
+
+#if $colors
+       #set $max_len = max([len(color[0]) for color in $colors]) + 10
+       #for $title, $color_spec in $colors
+<span background="$color_spec"><tt>$($encode($title).center($max_len))</tt></span>
+       #end for
+#end if
+"""
+
+def ColorsDialog(platform): MessageDialogHelper(
+       type=gtk.MESSAGE_INFO,
+       buttons=gtk.BUTTONS_CLOSE,
+       title='Colors',
+       markup=Utils.parse_template(COLORS_DIALOG_MARKUP_TMPL, colors=platform.get_colors()))