git.gag.com Git - debian/gnuradio/blob - grc/data/platforms/python/blocks/options.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 ###################################################
   4 ##Options Block:
   5 ## options for window size,
   6 ## and flow graph building.
   7 ###################################################
   8  -->
   9 <block>
  10         <name>Options</name>
  11         <key>options</key>
  12         <import>from gnuradio import gr
  13 #if $generate_options.eval == 'wx_gui'
  14 from grc_gnuradio import wxgui as grc_wxgui
  15 import wx
  16 #end if
  17 </import>
  18         <make></make>
  19         <param>
  20                 <name>Title</name>
  21                 <key>title</key>
  22                 <value>untitled</value>
  23                 <type>string</type>
  24         </param>
  25         <param>
  26                 <name>Author</name>
  27                 <key>author</key>
  28                 <value>unknown</value>
  29                 <type>string</type>
  30         </param>
  31         <param>
  32                 <name>Description</name>
  33                 <key>description</key>
  34                 <value>gnuradio flow graph</value>
  35                 <type>string</type>
  36         </param>
  37         <param>
  38                 <name>Window Size</name>
  39                 <key>window_size</key>
  40                 <value>1280, 1024</value>
  41                 <type>int_vector</type>
  42         </param>
  43         <param>
  44                 <name>Generate Options</name>
  45                 <key>generate_options</key>
  46                 <value>wx_gui</value>
  47                 <type>enum</type>
  48                 <option>
  49                         <name>WX GUI</name>
  50                         <key>wx_gui</key>
  51                         <opt>hide_category:all</opt>
  52                 </option>
  53                 <option>
  54                         <name>No GUI</name>
  55                         <key>no_gui</key>
  56                         <opt>hide_category:all</opt>
  57                 </option>
  58                 <option>
  59                         <name>Hier Block</name>
  60                         <key>hb</key>
  61                         <opt>hide_category:</opt>
  62                 </option>
  63         </param>
  64         <param>
  65                 <name>Category</name>
  66                 <key>category</key>
  67                 <value>Custom</value>
  68                 <type>string</type>
  69                 <hide>$generate_options.hide_category</hide>
  70         </param>
  71         <check>len($window_size) == 2</check>
  72         <check>300 &lt;= $(window_size)[0] &lt;= 2048</check>
  73         <check>300 &lt;= $(window_size)[1] &lt;= 2048</check>
  74         <doc>
  75 The options block sets special parameters for the flow graph. \
  76 Only one option block is allowed per flow graph.
  77
  78 Title, author, and description parameters are for identification purposes.
  79
  80 The window size controls the dimensions of the flow graph editor. \
  81 The window size (width, height) must be between (300, 300) and (2048, 2048).
  82
  83 The generate options controls the type of code generated. \
  84 Non-graphical flow graphs should avoid using graphical sinks or graphical variable controls.
  85
  86 The id of this block determines the name of the generated file and the name of the class. \
  87 For example, an id of my_block will generate the file my_block.py and class my_block(gr....
  88
  89 The category parameter determines the placement of the block in the block selection window. \
  90 The category only applies when creating hier blocks. \
  91 To put hier blocks into the root category, enter / for the category.
  92         </doc>
  93 </block>