summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNorbert Schechner <nieson@web.de>2013-12-23 17:22:23 +0100
committerNorbert Schechner <nieson@web.de>2013-12-23 17:22:23 +0100
commitc805b42fc7f482d3ea641362194eedd37a0ec637 (patch)
tree6c1ca3acba70a2c063403931a7c65630b5c7e0b0
parentdc35fbb76183174d242ff11d394cb044859d6495 (diff)
downloadlinuxcnc-c805b42fc7f482d3ea641362194eedd37a0ec637.tar.gz
linuxcnc-c805b42fc7f482d3ea641362194eedd37a0ec637.zip
gladevcp - JogWheel - added documentation of the widget
-rw-r--r--docs/src/gui/gladevcp.txt39
-rw-r--r--docs/src/gui/images/JogWheel.pngbin0 -> 19944 bytes
2 files changed, 38 insertions, 1 deletions
diff --git a/docs/src/gui/gladevcp.txt b/docs/src/gui/gladevcp.txt
index 1f4c1bf23..9b891dd06 100644
--- a/docs/src/gui/gladevcp.txt
+++ b/docs/src/gui/gladevcp.txt
@@ -472,7 +472,7 @@ label your panel.
<<gladevcp:HAL_ProgressBar,HAL_ProgressBar>>,
<<gladevcp:HAL_Bars,HAL_HBar and HAL_VBar>>, <<gladevcp:HAL_Meter,HAL_Meter>>
- Widgets for controlling "number" signals: <<gladevcp:HAL_SpinButton,HAL_SpinButton>>,
- <<gladevcp:HAL_Scales,HAL_HScale and HAL_VScale>>
+ <<gladevcp:HAL_Scales,HAL_HScale and HAL_VScale>>, <<gladevcp:JogWheel, Jog Wheel>>
- Helper widgets: <<gladevcp:HAL_HBox_Table,HAL_HBox and HAL_Table>>
- Tool Path preview: <<gladevcp:HAL_Gremlin,HAL_Gremlin>>
- Widgets to show axis positions: <<gladevcp::DRO_widget, DRO Widget>>,
@@ -643,6 +643,43 @@ Example SpinButton:
image:images/spinbutton.png[]
.
+[[gladevcp:JogWheel]]
+=== Jog Wheel
+
+The jogwheel widget simulates a real jogwheel and it exports it's count value as
+
+<widgetname>-s::
+ out S32 pin
+
+It has the following properties:
+
+size::
+ Sets the size in pixel of the widget, allowed values are in the range of 100 to 500
+ default = 200
+cpr::
+ Sets the Counts per Revolution, allowed values are in the range from 25 to 100
+ default = 40
+show_counts::
+ Set this to False, if you want to hide the counts display in the middle of the widget.
+
+Direct program control::
+
+ There a couple ways to directly control the widget using Python.
+
+ Using goobject to set the above listed properties:
+ [widget name].set_property("size",int(value))
+ [widget name].set_property("cpr",int(value))
+ [widget name].set_property("show_counts, True)
+
+ There are two python methods:
+ [widget name].get_value()
+ Will return the counts value as integer
+
+Example JogWheel:
+
+image::images/JogWheel.png[]
+
+
[[gladevcp:HAL_Label]]
=== Label
diff --git a/docs/src/gui/images/JogWheel.png b/docs/src/gui/images/JogWheel.png
new file mode 100644
index 000000000..04168d073
--- /dev/null
+++ b/docs/src/gui/images/JogWheel.png
Binary files differ