Merging r11186:11273 from grc branch.
[debian/gnuradio] / grc / blocks / variable_text_box.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##Variable Text Box:
5 ##      a gui text box form
6 ###################################################
7  -->
8 <block>
9         <name>Variable Text Box</name>
10         <key>variable_text_box</key>
11         <import>from gnuradio.wxgui import forms</import>
12         <var_make>self.$(id) = $(id) = $value</var_make>
13         <make>self.$(id)_text_box = forms.text_box(
14         parent=self.GetWin(),
15         value=self.$id,
16         callback=self.set_$(id),
17         #if $label()
18         label=$label,
19         #else
20         label='$id',
21         #end if
22         #if $formatter()
23         converter=forms.$(converver)(formatter=$formatter),
24         #else
25         converter=forms.$(converver)(),
26         #end if
27 )
28 #set $grid_pos = $grid_pos()
29 #if not grid_pos
30 self.Add(self.$(id)_text_box)
31 #else
32 self.GridAdd(self.$(id)_text_box, $grid_pos[0], $grid_pos[1], $grid_pos[2], $grid_pos[3])
33 #end if</make>
34         <callback>self.set_$(id)($value)</callback>
35         <callback>self.$(id)_text_box.set_value($id)</callback>
36         <param>
37                 <name>Label</name>
38                 <key>label</key>
39                 <value></value>
40                 <type>string</type>
41                 <hide>#if $label() then 'none' else 'part'#</hide>
42         </param>
43         <param>
44                 <name>Default Value</name>
45                 <key>value</key>
46                 <value>0</value>
47                 <type>raw</type>
48         </param>
49         <param>
50                 <name>Converter</name>
51                 <key>converver</key>
52                 <value>float_converter</value>
53                 <type>enum</type>
54                 <option>
55                         <name>Float</name>
56                         <key>float_converter</key>
57                 </option>
58                 <option>
59                         <name>Integer</name>
60                         <key>int_converter</key>
61                 </option>
62                 <option>
63                         <name>String</name>
64                         <key>str_converter</key>
65                 </option>
66                 <option>
67                         <name>Evaluate</name>
68                         <key>eval_converter</key>
69                 </option>
70         </param>
71         <param>
72                 <name>Formatter</name>
73                 <key>formatter</key>
74                 <value>None</value>
75                 <type>raw</type>
76                 <hide>part</hide>
77         </param>
78         <param>
79                 <name>Grid Position</name>
80                 <key>grid_pos</key>
81                 <value></value>
82                 <type>grid_pos</type>
83         </param>
84         <doc>
85 This block creates a variable with a text box. \
86 Leave the label blank to use the variable id as the label.
87
88 Format should be a function/lambda that converts a value into a string or None for the default formatter.
89
90 Use the Grid Position (row, column, row span, column span) to position the graphical element in the window.
91         </doc>
92 </block>