summaryrefslogtreecommitdiff
path: root/grc/data/grc_gnuradio/blocks/options.xml
diff options
context:
space:
mode:
Diffstat (limited to 'grc/data/grc_gnuradio/blocks/options.xml')
-rw-r--r--grc/data/grc_gnuradio/blocks/options.xml89
1 files changed, 89 insertions, 0 deletions
diff --git a/grc/data/grc_gnuradio/blocks/options.xml b/grc/data/grc_gnuradio/blocks/options.xml
new file mode 100644
index 000000000..541028d5c
--- /dev/null
+++ b/grc/data/grc_gnuradio/blocks/options.xml
@@ -0,0 +1,89 @@
+<?xml version="1.0"?>
+<!--
+###################################################
+##Options Block:
+## options for window size,
+## and flow graph building.
+###################################################
+ -->
+<block>
+ <name>Options</name>
+ <key>options</key>
+ <import>from gnuradio import gr
+#if $generate_options.eval == 'wx_gui'
+from grc_gnuradio import wxgui as grc_wxgui
+import wx
+#end if
+</import>
+ <make></make>
+ <param>
+ <name>Title</name>
+ <key>title</key>
+ <value>untitled</value>
+ <type>string</type>
+ </param>
+ <param>
+ <name>Author</name>
+ <key>author</key>
+ <value>unknown</value>
+ <type>string</type>
+ </param>
+ <param>
+ <name>Description</name>
+ <key>description</key>
+ <value>gnuradio flow graph</value>
+ <type>string</type>
+ </param>
+ <param>
+ <name>Window Size</name>
+ <key>window_size</key>
+ <value>1280, 1024</value>
+ <type>int_vector</type>
+ </param>
+ <param>
+ <name>Generate Options</name>
+ <key>generate_options</key>
+ <value>wx_gui</value>
+ <type>enum</type>
+ <option>
+ <name>WX GUI</name>
+ <key>wx_gui</key>
+ </option>
+ <option>
+ <name>No GUI</name>
+ <key>no_gui</key>
+ </option>
+ <option>
+ <name>Hier Block</name>
+ <key>hb</key>
+ </option>
+ </param>
+ <param>
+ <name>Category</name>
+ <key>category</key>
+ <value>Custom</value>
+ <type>string</type>
+ </param>
+ <check>len($window_size) == 2</check>
+ <check>300 &lt;= $(window_size)[0] &lt;= 2048</check>
+ <check>300 &lt;= $(window_size)[1] &lt;= 2048</check>
+ <doc>
+The options block sets special parameters for the flow graph. \
+Only one option block is allowed per flow graph.
+
+Title, author, and description parameters are for identification purposes.
+
+The window size controls the dimensions of the flow graph editor. \
+The window size (width, height) must be between (300, 300) and (2048, 2048).
+
+The generate options controls the type of code generated. \
+Non-graphical flow graphs should avoid using graphical sinks or graphical variable controls.
+
+The id of this block determines the name of the generated file and the name of the class. \
+For example, an id of my_block will generate the file my_block.py and class my_block(gr....
+
+The category parameter determines the placement of the block in the block selection window. \
+The category only applies when creating hier blocks. \
+To put hier blocks into the root category, enter / for the category.
+ </doc>
+</block>