Difference between revisions of "QT GUI Push Button"

From GNU Radio
Jump to: navigation, search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
This block creates a variable push button. Leave the label blank to use the variable id as the label.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]]. This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.
 
  
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
+
A push button selects between two values of similar type. The variable will take on one value or the other depending on whether the button is pressed or released.
  
 
== Parameters ==
 
== Parameters ==
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
; Param 1 (''R'')
+
; Label
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
+
: Name of the widget in the GUI
  
; Param 2
+
; Default Value (''R'')
: blah blah blah
+
: Value set before the first interaction
 +
 
 +
; Pressed
 +
: Value to set when the button is pressed
 +
 
 +
; Released
 +
: Value to set when the button is released
 +
 
 +
; GUI Hint
 +
: See [[GUI Hint]] for info about how to organize multiple QT GUIs
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 19: Line 27:
  
 
== Source Files ==
 
== Source Files ==
 
; C++ files
 
: [https://github.com/gnuradio/gnuradio TODO]
 
 
; Header files
 
: [https://github.com/gnuradio/gnuradio TODO]
 
 
; Public header files
 
: [https://github.com/gnuradio/gnuradio TODO]
 
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-qtgui/grc/qtgui_push_button.block.yml]

Revision as of 13:59, 9 September 2019

This block creates a variable push button. Leave the label blank to use the variable id as the label.

A push button selects between two values of similar type. The variable will take on one value or the other depending on whether the button is pressed or released.

Parameters

(R): Run-time adjustable

Label
Name of the widget in the GUI
Default Value (R)
Value set before the first interaction
Pressed
Value to set when the button is pressed
Released
Value to set when the button is released
GUI Hint
See GUI Hint for info about how to organize multiple QT GUIs

Example Flowgraph

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files

Block definition
[1]