Projects/SuperKaramba/API - Revision history

Tampakrap at 10:55, 23 October 2008

2008-10-23T10:55:29Z

2008-02-22T02:21:19Z

‎moveCanvasWidget

2008-02-22T00:50:01Z

added createCanvasWidget and moveCanvasWidget methods

2007-09-20T19:01:38Z

‎getBarSize: typo

2007-09-20T19:01:02Z

‎getBarPos: typo

2007-08-04T13:54:32Z

getPlasmaSensor: typo--

2007-08-04T01:50:26Z

added dox for the Sensor.getPlasmaSensor method

2007-07-15T21:51:10Z

‎Misc: added getIconByName function info

2007-05-27T15:56:51Z

API change

2007-05-24T00:34:43Z

‎setImagePath: added note about new support of SVG in this fn.

@@ Line 453: / Line 453: @@
 === setGraphMinMax ===
-Sets the graphs min and max values.
+Sets the graphs min and max values. (default: min = 0, max = 100)
 <br><br>'''Synopsis:'''<br>
 boolean setGraphMinMax(widget, graph, min, max)

@@ Line 2,551: / Line 2,551: @@
 Moves the canvaswidget object to a new position.<br><br>
-'''Synopsis:'''<br>boolean createCanvasWidget(widget, canvaswidget, x, y, w, h)
+'''Synopsis:'''<br>boolean moveCanvasWidget(widget, canvaswidget, x, y, w, h)
 <br><br>'''Arguments:'''<br>
 * reference to widget -- karamba
@@ Line 2,560: / Line 2,560: @@
 * integer h -- height
 <br>'''Return Value:'''<br>
-the reference to an instance of a QGraphicsProxyWidget canvaswidget object.
+true if the move was successful done else false.
 = Wiki Markup Generation =

@@ Line 2,535: / Line 2,535: @@
 <br>'''Return Value:'''<br>
 the reference to an instance of the SuperKaramba PlasmaSensor class. See also http://websvn.kde.org/trunk/kdeutils/superkaramba/src/sensors/plasmaengine.h
 = Wiki Markup Generation =

@@ Line 71: / Line 71: @@
 === getBarSize ===
-Given a reference to a bar object, this will return a array
+Given a reference to a bar object, this will return an array
 containing the height and width of the bar object.
 <br><br>'''Synopsis:'''<br>

@@ Line 50: / Line 50: @@
 === getBarPos ===
-Given a reference to a bar object, this will return a array
+Given a reference to a bar object, this will return an array
 containing the x and y coordinate of a bar object.
 <br><br>'''Synopsis:'''<br>

@@ Line 2,528: / Line 2,528: @@
 Returns a sensor for Plasma::DataEngine objects.<br><br>'''Synopsis:'''<br>
-dataengine getPlasmaSensor(widget, engine, source, format)
+dataengine getPlasmaSensor(widget, engine, source)
 <br><br>'''Arguments:'''<br>
 * reference to widget -- karamba

@@ Line 1,510: / Line 1,510: @@
 <br>'''Return Value:'''<br>
 process id of the executed command
 === getIncomingData ===

@@ Line 560: / Line 560: @@
 true if successful
-=== changeImageToAlpha===
+=== changeImageAlpha===
 This will change the image transparency to the given alpha value. The R,G, or B value of -1 indicates that pixels of all intensities in this channel will be assigned the given alpha. If a color (R,G, or B) intensity is specified in the range of 0-255, the alpha value is applied only to the pixels with that intensity. This allows to make, for example, only black (R=0,G=0,B=0) pixels transparent, while keeping all other pixel's alpha unchanged.
 The value of millisec instructs how long the transparency effect should stay. The value of 0 makes the alpha effect permanent.
 <br><br>'''Synopsis:'''<br>
-boolean changeImageToAlpha(widget, image, alpha, red=-1, green=-1, blue=-1, millisec=-1)
+boolean changeImageAlpha(widget, image, alpha, red=-1, green=-1, blue=-1, millisec=0)
 <br><br>'''Arguments:'''<br>
 * reference to widget -- karamba
@@ Line 575: / Line 575: @@
 <br>'''Return Value:'''<br>
 true if successful
 === createBackgroundImage ===
@@ Line 900: / Line 898: @@
 true if the element is available or false if it is not an SVG image.
-=== resetImageElement ===
+=== setImageElementAll ===
 This function reset a previous set element. A call to this function will result in a completly drawn SVG image.
 <br><br>'''Synopsis:'''<br>
-boolean resetImageElement(widget, image)
+boolean setImageElementAll(widget, image)
 <br><br>'''Arguments:'''<br>
 * reference to widget -- karamba

@@ Line 819: / Line 819: @@
 === setImagePath ===
-This will change image of a image widget.
+This will change image of a image widget. Note, starting with SuperKaramba version 0.50 (KDE4.0) this function accepts SVG.
 <br><br>'''Synopsis:'''<br>
 reference setImagePath(widget, image, path)