summaryrefslogtreecommitdiff
path: root/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h')
-rw-r--r--gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h17
1 files changed, 16 insertions, 1 deletions
diff --git a/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h b/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h
index c49b9d9ec0..bc7f0a6f1c 100644
--- a/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h
+++ b/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h
@@ -34,7 +34,7 @@
namespace gr {
namespace qtgui {
-
+
/*!
* \brief A graphical sink to display multiple signals in frequency.
* \ingroup instrumentation_blk
@@ -46,6 +46,21 @@ namespace gr {
* different color, and the \a set_title and \a set_color
* functions can be used to change the lable and color for a given
* input number.
+ *
+ * Message Ports:
+ *
+ * - freq (input):
+ * Receives a PMT pair: (intern("freq"), double(frequency).
+ * This is used to retune the center frequency of the
+ * display's x-axis.
+ *
+ * - freq (output):
+ * Produces a PMT pair with (intern("freq"), double(frequency).
+ * When a user double-clicks on the display, the frequency
+ * that the cursor is on is used to retune the x-axis scale
+ * to recenter onto the clicked frequency. A message
+ * containing the new frequency is also produced and can be
+ * used by other blocks to update their frequency setting.
*/
class QTGUI_API freq_sink_f : virtual public sync_block
{