Merging r11186:11273 from grc branch.
[debian/gnuradio] / grc / blocks / variable_slider.xml
1 <?xml version="1.0"?>
2 <!--
3 ###################################################
4 ##Variable Slider:
5 ##      a combined slider and text box form
6 ###################################################
7  -->
8 <block>
9         <name>Variable Slider</name>
10         <key>variable_slider</key>
11         <import>from gnuradio.wxgui import forms</import>
12         <var_make>self.$(id) = $(id) = $value</var_make>
13         <make>_$(id)_sizer = wx.BoxSizer(wx.VERTICAL)
14 self.$(id)_text_box = forms.text_box(
15         parent=self.GetWin(),
16         sizer=_$(id)_sizer,
17         value=self.$id,
18         callback=self.set_$(id),
19         #if $label()
20         label=$label,
21         #else
22         label='$id',
23         #end if
24         converter=forms.$(converver)(),
25         proportion=0,
26 )
27 self.$(id)_slider = forms.slider(
28         parent=self.GetWin(),
29         sizer=_$(id)_sizer,
30         value=self.$id,
31         callback=self.set_$(id),
32         minimum=$min,
33         maximum=$max,
34         num_steps=$num_steps,
35         style=$style,
36         cast=$(converver.slider_cast),
37         proportion=1,
38 )
39 #set $grid_pos = $grid_pos()
40 #if not grid_pos
41 self.Add(_$(id)_sizer)
42 #else
43 self.GridAdd(_$(id)_sizer, $grid_pos[0], $grid_pos[1], $grid_pos[2], $grid_pos[3])
44 #end if</make>
45         <callback>self.set_$(id)($value)</callback>
46         <callback>self.$(id)_slider.set_value($id)</callback>
47         <callback>self.$(id)_text_box.set_value($id)</callback>
48         <param>
49                 <name>Label</name>
50                 <key>label</key>
51                 <value></value>
52                 <type>string</type>
53                 <hide>#if $label() then 'none' else 'part'#</hide>
54         </param>
55         <param>
56                 <name>Default Value</name>
57                 <key>value</key>
58                 <value>50</value>
59                 <type>real</type>
60         </param>
61         <param>
62                 <name>Minimum</name>
63                 <key>min</key>
64                 <value>0</value>
65                 <type>real</type>
66         </param>
67         <param>
68                 <name>Maximum</name>
69                 <key>max</key>
70                 <value>100</value>
71                 <type>real</type>
72         </param>
73         <param>
74                 <name>Num Steps</name>
75                 <key>num_steps</key>
76                 <value>100</value>
77                 <type>int</type>
78                 <hide>part</hide>
79         </param>
80         <param>
81                 <name>Style</name>
82                 <key>style</key>
83                 <value>wx.SL_HORIZONTAL</value>
84                 <type>enum</type>
85                 <hide>part</hide>
86                 <option>
87                         <name>Horizontal</name>
88                         <key>wx.SL_HORIZONTAL</key>
89                 </option>
90                 <option>
91                         <name>Vertical</name>
92                         <key>wx.SL_VERTICAL</key>
93                 </option>
94         </param>
95         <param>
96                 <name>Converter</name>
97                 <key>converver</key>
98                 <value>float_converter</value>
99                 <type>enum</type>
100                 <option>
101                         <name>Float</name>
102                         <key>float_converter</key>
103                         <opt>slider_cast:float</opt>
104                 </option>
105                 <option>
106                         <name>Integer</name>
107                         <key>int_converter</key>
108                         <opt>slider_cast:int</opt>
109                 </option>
110         </param>
111         <param>
112                 <name>Grid Position</name>
113                 <key>grid_pos</key>
114                 <value></value>
115                 <type>grid_pos</type>
116         </param>
117         <check>$min &lt;= $value &lt;= $max</check>
118         <check>$min &lt; $max</check>
119         <check>0 &lt; $num_steps &lt;= 1000</check>
120         <doc>
121 This block creates a variable with a slider. \
122 Leave the label blank to use the variable id as the label. \
123 The value must be a real number. \
124 The value must be between the minimum and the maximum. \
125 The number of steps must be between 0 and 1000.
126
127 Use the Grid Position (row, column, row span, column span) to position the graphical element in the window.
128         </doc>
129 </block>