QT GUI Label: Difference between revisions

From GNU Radio
Jump to navigation Jump to 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...")
 
(added example for formatter; confusing implementation)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
This block creates a variable with a label widget for text. 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.


== 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).
:  


; Param 2
; Type (''R'')
: blah blah blah
: Type of data to handle


== Example Flowgraph ==
; Defaut Value (''R'')
:
 
; Formatter
: Function returning string. Something like <code>lambda x: f'{x:.3f}'</code> can be used to format a number.


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.
; GUI Hint
: See [[GUI Hint]] for info about how to organize multiple QT GUIs


== Source Files ==
== Example Flowgraph ==


; C++ files
This flowgraph and output show a QT GUI Label with an id:freq and a value of 0.1  Note that the output shows the <code>Label:</code> value 'Frequency' and the <code>Default Value:</code> value '100.0m'. The <code>freq</code> value is used to set the Signal Source Frequency.
: [https://github.com/gnuradio/gnuradio TODO]


; Header files
[[File:QT_GUI_demo.png|800px]]
: [https://github.com/gnuradio/gnuradio TODO]


; Public header files
== Source 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_label.block.yml]

Latest revision as of 23:22, 2 February 2023

This block creates a variable with a label widget for text. Leave the label blank to use the variable id as the label.

Parameters

(R): Run-time adjustable

Label
Type (R)
Type of data to handle
Defaut Value (R)
Formatter
Function returning string. Something like lambda x: f'{x:.3f}' can be used to format a number.
GUI Hint
See GUI Hint for info about how to organize multiple QT GUIs

Example Flowgraph

This flowgraph and output show a QT GUI Label with an id:freq and a value of 0.1 Note that the output shows the Label: value 'Frequency' and the Default Value: value '100.0m'. The freq value is used to set the Signal Source Frequency.

QT GUI demo.png

Source Files

Block definition
[1]
Retrieved from "https://wiki.gnuradio.org/index.php?title=QT_GUI_Label&oldid=12925"