[Kst] branches/work/kst/1.6/kst/src/extensions/js
Andrew Walker
arwalker at sumusltd.com
Tue Jan 22 23:21:48 CET 2008
SVN commit 764963 by arwalker:
format changes
M +4 -0 bind_axisticklabel.h
M +4 -0 bind_box.h
M +6 -0 bind_collection.h
M +12 -0 bind_datamatrix.h
M +4 -0 bind_document.h
M +1 -0 bind_ellipse.h
M +1 -1 bind_image.h
M +9 -0 bind_label.h
M +4 -0 bind_line.h
M +3 -1 bind_picture.h
M +1 -0 bind_point.h
M +1 -0 bind_size.h
--- branches/work/kst/1.6/kst/src/extensions/js/bind_axisticklabel.h #764962:764963
@@ -42,22 +42,26 @@
bool hasProperty(KJS::ExecState *exec, const KJS::Identifier& propertyName) const;
// member functions
+
/* @property string font
@description Used to set or get the current font used for the label.
*/
void setFont(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value font(KJS::ExecState *exec) const;
+
/* @property number fontSize
@description Contains the size of the font used to draw the label.
*/
void setFontSize(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value fontSize(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 string type
@readonly
@description The type of axis - X or Y presently.
--- branches/work/kst/1.6/kst/src/extensions/js/bind_box.h #764962:764963
@@ -63,12 +63,14 @@
*/
void setXRound(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value xRound(KJS::ExecState *exec) const;
+
/* @property number yRound
@description The roundness of the corners in the Y dimension. Must be
an integer between 0 and 99.
*/
void setYRound(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value yRound(KJS::ExecState *exec) const;
+
/* @property number cornerStyle
@description The style to draw the corners of the box.
<ul>
@@ -79,11 +81,13 @@
*/
void setCornerStyle(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value cornerStyle(KJS::ExecState *exec) const;
+
/* @property int borderWidth
@description The width in pixels of the border.
*/
void setBorderWidth(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value borderWidth(KJS::ExecState *exec) const;
+
/* @property string borderColor
@description The border color for this object.
*/
--- branches/work/kst/1.6/kst/src/extensions/js/bind_collection.h #764962:764963
@@ -56,12 +56,14 @@
*/
// default throws an exception
virtual KJS::Value append(KJS::ExecState *exec, const KJS::List& args);
+
/* @method prepend
@arg Object newObj The new object to prepend to the collection.
@description Prepends a new object to the start of the collection.
*/
// default throws an exception
virtual KJS::Value prepend(KJS::ExecState *exec, const KJS::List& args);
+
/* @method remove
@arg number n The index of the entry to remove.
@description Removes an entry from the collection.
@@ -72,22 +74,26 @@
*/
// default throws an exception
virtual KJS::Value remove(KJS::ExecState *exec, const KJS::List& args);
+
/* @method clear
@description Clears the collection, removing all entries.
*/
// default throws an exception
virtual KJS::Value clear(KJS::ExecState *exec, const KJS::List& args);
+
/* @property number length
@readonly
@description The number of items in the collection. Items are ordered
0..(length - 1) so it is easy to iterate.
*/
virtual KJS::Value length(KJS::ExecState *exec) const;
+
/* @property boolean readOnly
@readonly
@description True if this is a read-only collection.
*/
virtual KJS::Value readOnly(KJS::ExecState *exec) const;
+
virtual QStringList collection(KJS::ExecState *exec) const;
virtual KJS::Value extract(KJS::ExecState *exec, const KJS::Identifier& item) const;
virtual KJS::Value extract(KJS::ExecState *exec, unsigned item) const;
--- branches/work/kst/1.6/kst/src/extensions/js/bind_datamatrix.h #764962:764963
@@ -58,15 +58,18 @@
bool hasProperty(KJS::ExecState *exec, const KJS::Identifier& propertyName) const;
// member functions
+
/* @method reload
description Triggers a reload of this matrix from disk.
*/
KJS::Value reload(KJS::ExecState *exec, const KJS::List& args);
+
/* @method changeFile
@arg DataSource source The DataSource to switch to.
@description Switches this DataMatrix to a different DataSource.
*/
KJS::Value changeFile(KJS::ExecState *exec, const KJS::List& args);
+
/* @method change
@arg number xStart The x starting frame.
@arg number yStart The y starting frame.
@@ -84,52 +87,61 @@
@description True if the data matrix is valid.
*/
KJS::Value valid(KJS::ExecState *exec) const;
+
/* @property boolean skip
@readonly
@description True if the matrix should skip by <i>skipLength</i> samples
while reading from the data source.
*/
KJS::Value skip(KJS::ExecState *exec) const;
+
/* @property boolean boxcar
@readonly
@description True if the matrix should be boxcar filtered.
*/
KJS::Value boxcar(KJS::ExecState *exec) const;
+
/* @property boolean xReadToEnd
@readonly
@description If true, the matrix is read to the end of the source in the
x dimension.
*/
KJS::Value xReadToEnd(KJS::ExecState *exec) const;
+
/* @property boolean yReadToEnd
@readonly
@description If true, the matrix is read to the end of the source in the
y dimension.
*/
KJS::Value yReadToEnd(KJS::ExecState *exec) const;
+
/* @property boolean xCountFromEnd
@readonly
@description If true, the matrix reads only a maximum number of samples
from the end of the source in the x dimension.
*/
KJS::Value xCountFromEnd(KJS::ExecState *exec) const;
+
/* @property boolean yCountFromEnd
@readonly
@description If true, the matrix reads only a maximum number of samples
from the end of the source in the y dimension.
*/
KJS::Value yCountFromEnd(KJS::ExecState *exec) const;
+
/* @property number skipLength
@readonly
@description The number of samples to skip by.
*/
KJS::Value skipLength(KJS::ExecState *exec) const;
+
/* @property string field
@readonly
@description The field being read from the data source to create this
matrix.
*/
KJS::Value field(KJS::ExecState *exec) const;
+
/* @property DataSource dataSource
@readonly
@description The data source object used by this DataMatrix.
--- branches/work/kst/1.6/kst/src/extensions/js/bind_document.h #764962:764963
@@ -47,10 +47,12 @@
@description Saves the current Kst session to disk.
*/
KJS::Value save(KJS::ExecState *exec, const KJS::List& args);
+
/* @method newDocument
@description Clears the current Kst session and starts a new one.
*/
KJS::Value newDocument(KJS::ExecState *exec, const KJS::List& args);
+
/* @method load
@returns boolean
@arg string filename The filename for a Kst file to load.
@@ -63,11 +65,13 @@
@description The XML text of the current session in Kst-file form.
*/
KJS::Value text(KJS::ExecState *exec) const;
+
/* @property string name
@description The filename for the current Kst session.
*/
KJS::Value name(KJS::ExecState *exec) const;
void setName(KJS::ExecState *exec, const KJS::Value& value);
+
/* @property boolean modified
@description True if the document has been modified but not saved.
*/
--- branches/work/kst/1.6/kst/src/extensions/js/bind_ellipse.h #764962:764963
@@ -62,6 +62,7 @@
*/
void setBorderWidth(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value borderWidth(KJS::ExecState *exec) const;
+
/* @property string borderColor
@description The color of the border of the ellipse.
*/
--- branches/work/kst/1.6/kst/src/extensions/js/bind_image.h #764962:764963
@@ -26,7 +26,7 @@
/* @class Image
@inherits DataObject
- @description an image object created from a matrix.
+ @description An image object created from a matrix.
*/
class KstBindImage : public KstBindDataObject {
public:
--- branches/work/kst/1.6/kst/src/extensions/js/bind_label.h #764962:764963
@@ -61,6 +61,7 @@
@description Adjusts the size of the label to fit the text.
*/
KJS::Value adjustSizeForText(KJS::ExecState *exec, const KJS::List& args);
+
/* @property string text
@description Contains the text contents of the label. This may include
carriage returns (\n), scalar references of the form
@@ -68,16 +69,19 @@
*/
void setText(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value text(KJS::ExecState *exec) const;
+
/* @property string font
@description Used to set or get the current font used for the label.
*/
void setFont(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value font(KJS::ExecState *exec) const;
+
/* @property number fontSize
@description Contains the size of the font used to draw the label.
*/
void setFontSize(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value fontSize(KJS::ExecState *exec) const;
+
/* @property number justification
@description The justification for the label. This is a bit field with
two segments, one for horizontal and one for vertical
@@ -99,12 +103,14 @@
*/
void setJustification(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value justification(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 number dataPrecision
@description Contains the number of digits of precision to display data
values in the label. Restricted to a value between 0 and
@@ -112,6 +118,7 @@
*/
void setDataPrecision(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value dataPrecision(KJS::ExecState *exec) const;
+
/* @property boolean interpreted
@description Determines if the contents of the label should be
interpreted in order to substitute LaTeX-like
@@ -119,6 +126,7 @@
*/
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
@@ -126,6 +134,7 @@
*/
void setScalarReplacement(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value scalarReplacement(KJS::ExecState *exec) const;
+
/* @property boolean autoResize
@description Automatically resizes the label to fit the text exactly.
May trigger a slight move of the label. It will not
--- branches/work/kst/1.6/kst/src/extensions/js/bind_line.h #764962:764963
@@ -62,16 +62,19 @@
*/
void setFrom(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value from(KJS::ExecState *exec) const;
+
/* @property Point to
@description The ending point of the line.
*/
void setTo(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value to(KJS::ExecState *exec) const;
+
/* @property number width
@description The width of the line.
*/
void setWidth(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value width(KJS::ExecState *exec) const;
+
/* @property number capStyle
@description The cap style for the line.
<ul>
@@ -82,6 +85,7 @@
*/
void setCapStyle(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value capStyle(KJS::ExecState *exec) const;
+
/* @property number lineStyle
@description The style for the line.
<ul>
--- branches/work/kst/1.6/kst/src/extensions/js/bind_picture.h #764962:764963
@@ -64,6 +64,7 @@
@arg string url The URL to retrieve the image from.
*/
KJS::Value load(KJS::ExecState *exec, const KJS::List& args);
+
/* @property Image image
@description The raw image that is being displayed. You can take a copy
of this, manipulate it, then set it back to change the
@@ -71,12 +72,14 @@
*/
void setImage(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value image(KJS::ExecState *exec) const;
+
/* @property string url
@readonly
@description The URL of the image if it was loaded from a file and has
not been modified.
*/
KJS::Value url(KJS::ExecState *exec) const;
+
/* @property number refreshTimer
@description A timer to automatically refresh the picture. Value of 0
means the timer is disabled. Units are in seconds.
@@ -84,7 +87,6 @@
void setRefreshTimer(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value refreshTimer(KJS::ExecState *exec) const;
-
protected:
KstBindPicture(int id, const char *name = 0L);
void addBindings(KJS::ExecState *exec, KJS::Object& obj);
--- branches/work/kst/1.6/kst/src/extensions/js/bind_point.h #764962:764963
@@ -53,6 +53,7 @@
*/
void setX(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value x(KJS::ExecState *exec) const;
+
/* @property number y
@description The value of the y co-ordinate.
*/
--- branches/work/kst/1.6/kst/src/extensions/js/bind_size.h #764962:764963
@@ -56,6 +56,7 @@
*/
void setW(KJS::ExecState *exec, const KJS::Value& value);
KJS::Value w(KJS::ExecState *exec) const;
+
/* @property number h
@description The height.
*/
More information about the Kst
mailing list