summaryrefslogtreecommitdiff
path: root/grc/gui/ParamsDialog.py
blob: ccf19d1a27fce3f56c0462c65e13561576201ad6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
"""
Copyright 2007, 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

from Dialogs import TextDisplay
from Constants import MIN_DIALOG_WIDTH, MIN_DIALOG_HEIGHT

def get_title_label(title):
	"""
	Get a title label for the params window.
	The title will be bold, underlined, and left justified.
	@param title the text of the title
	@return a gtk object
	"""
	label = gtk.Label()
	label.set_markup('\n<b><span underline="low">%s</span>:</b>\n'%title)
	hbox = gtk.HBox()
	hbox.pack_start(label, False, False, padding=11)
	return hbox

class ParamsDialog(gtk.Dialog):
	"""A dialog box to set block parameters."""

	def __init__(self, block):
		"""
		SignalBlockParamsDialog contructor.
		@param block the signal block
		"""
		gtk.Dialog.__init__(self,
			title='Properties: %s'%block.get_name(),
			buttons=(gtk.STOCK_CLOSE, gtk.RESPONSE_CLOSE),
		)
		self.block = block
		self.set_size_request(MIN_DIALOG_WIDTH, MIN_DIALOG_HEIGHT)
		vbox = gtk.VBox()
		#Add the title label
		vbox.pack_start(get_title_label('Parameters'), False)
		#Create the scrolled window to hold all the parameters
		scrolled_window = gtk.ScrolledWindow()
		scrolled_window.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
		scrolled_window.add_with_viewport(vbox)
		self.vbox.pack_start(scrolled_window, True)
		#Error Messages for the block
		self._error_box = gtk.VBox()
		self._error_messages_text_display = TextDisplay()
		self._error_box.pack_start(gtk.Label(), False, False, 7) #spacing
		self._error_box.pack_start(get_title_label('Error Messages'), False)
		self._error_box.pack_start(self._error_messages_text_display, False)
		#Docs for the block
		self._docs_box = err_box = gtk.VBox()
		self._docs_text_display = TextDisplay()
		self._docs_box.pack_start(gtk.Label(), False, False, 7) #spacing
		self._docs_box.pack_start(get_title_label('Documentation'), False)
		self._docs_box.pack_start(self._docs_text_display, False)
		#Add all the parameters
		for param in self.block.get_params():
			vbox.pack_start(param.get_input_object(self._handle_changed), False)
		#Add the error and docs box
		vbox.pack_start(self._error_box, False)
		vbox.pack_start(self._docs_box, False)
		#connect and show
		self.connect('key_press_event', self._handle_key_press)
		self.show_all()
		#initial update
		for param in self.block.get_params(): param.update()
		self._update()

	def _update(self):
		"""
		Update the error messages box.
		Hide the box if there are no errors.
		Update the documentation block.
		Hide the box if there are no docs.
		"""
		self.block.validate()
		#update the errors box
		if self.block.is_valid(): self._error_box.hide()
		else: self._error_box.show()
		messages = '\n\n'.join(self.block.get_error_messages())
		self._error_messages_text_display.set_text(messages)
		#update the docs box
		if self.block.get_doc(): self._docs_box.show()
		else: self._docs_box.hide()
		self._docs_text_display.set_text(self.block.get_doc())

	def _handle_key_press(self, widget, event):
		"""
		Handle key presses from the keyboard.
		Call the ok response when enter is pressed.
		@return false to forward the keypress
		"""
		keyname = gtk.gdk.keyval_name(event.keyval)
		if keyname == 'Return': self.response(gtk.RESPONSE_OK)
		return False #forward the keypress

	def _handle_changed(self, param):
		"""
		A change occured, update any dependent parameters:
		The enum inside the variable type may have changed and,
		the variable param will need an external update.
		@param param the graphical parameter that initiated the callback
		"""
		#update dependent params
		if param.is_enum():
			for other_param in param.get_parent().get_params():
				if param.get_key() is not other_param.get_key() and (
				param.get_key() in other_param._type or \
				param.get_key() in other_param._hide): other_param.update()
		#update
		self._update()
		return True

	def run(self):
		"""
		Call run().
		@return true if a change occured.
		"""
		original_data = list()
		for param in self.block.get_params():
			original_data.append(param.get_value())
		gtk.Dialog.run(self)
		self.destroy()
		new_data = list()
		for param in self.block.get_params():
			new_data.append(param.get_value())
		return original_data != new_data