[Kst] extragear/graphics/kst/kst/extensions/js

[George Staikos]

SVN commit 418235 by staikos:

add documentation for Label


 M  +24 -1     bind_label.h  


--- trunk/extragear/graphics/kst/kst/extensions/js/bind_label.h #418234:418235
@@ -27,6 +27,11 @@
 
 using namespace KJSEmbed;
 
+/* @class Label
+   @collection PlotLabelCollection
+   @description This class represents a text label in Kst.  At this time labels
+                are exclusively associated with plots.
+*/
 class KstBindLabel : public KstBinding {
   public:
     KstBindLabel(KJS::ExecState *exec, KstLabelPtr d);
@@ -42,13 +47,31 @@
 
     // member functions
 
-    // properties
+    /* @property String text
+       @description Contains the text contents of the label.  This may include
+                    carriage returns (\n), scalar references of the form
+                    <i>[scalar_name]</i>, and some basic LaTeX.
+    */
     void setText(KJS::ExecState *exec, const KJS::Value& value);
     KJS::Value text(KJS::ExecState *exec) const;
+    /* @property Number rotation
+       @description Contains the rotation angle of the label.  Rotation is
+                    clockwise from <i>normal</i> and is stored in degrees.
+    */
     void setRotation(KJS::ExecState *exec, const KJS::Value& value);
     KJS::Value rotation(KJS::ExecState *exec) const;
+    /* @property Boolean interpreted
+       @description Determines if the contents of the label should be
+                    interpreted in order to substitute LaTeX-like
+                    constructs.  Default is true.
+    */
     void setInterpreted(KJS::ExecState *exec, const KJS::Value& value);
     KJS::Value interpreted(KJS::ExecState *exec) const;
+    /* @property Boolean scalarReplacement
+       @description Determines if the contents of the label should be
+                    interpreted in order to substitute variable reference
+                    constructs.  Default is true.
+    */
     void setScalarReplacement(KJS::ExecState *exec, const KJS::Value& value);
     KJS::Value scalarReplacement(KJS::ExecState *exec) const;