diff --git a/docs/API-v0.5.txt b/docs/API-v0.5.txt
index 8797ce4..11d0d2e 100644
--- a/docs/API-v0.5.txt
+++ b/docs/API-v0.5.txt
@@ -101,12 +101,15 @@ API_VERSION in the code.
// display (big) number num at horizontal position x
void (*num) (Driver *drvthis, int x, int num);
- // set heartbeat state; animalte heartbeat
+ // set heartbeat state; animate heartbeat
void (*heartbeat) (Driver *drvthis, int state);
// draw named icon at position (x,y)
void (*icon) (Driver *drvthis, int x, int y, int icon);
+ // set cursor type and move it to position (x,y)
+ void (*cursor) (Driver *drvthis, int x, int y, int type);
+
//// User-defined character functions
@@ -290,6 +293,12 @@ void (*heartbeat) (Driver *drvthis, int type);
//HEARTBEAT_ON to say that we want to display/refresh the heartbeat.
//The driver choose how to do it. See MtxOrb.c"
+void (*icon) (Driver *drvthis, int x, int y, int icon);
+// draw named icon at position (x,y)
+
+void (*cursor) (Driver *drvthis, int x, int y, int type);
+// set cursor type and move it to position (x,y)
+
int (*get_contrast) (Driver *drvthis);
// Gets the contrast from the driver.
// the value returned is in the ramnge 0 - 1000
diff --git a/docs/lcdproc-dev/driver-api.docbook b/docs/lcdproc-dev/driver-api.docbook
index f58544c..d26d7b9 100644
--- a/docs/lcdproc-dev/driver-api.docbook
+++ b/docs/lcdproc-dev/driver-api.docbook
@@ -116,12 +116,15 @@ API_VERSION in the code.
// display (big) number num at horizontal position x
void (*num) (Driver *drvthis, int x, int num);
- // set heartbeat state; animalte heartbeat
+ // set heartbeat state; animate heartbeat
void (*heartbeat) (Driver *drvthis, int state);
// draw named icon at position (x,y)
void (*icon) (Driver *drvthis, int x, int y, int icon);
+ // set cursor type and move it to position (x,y)
+ void (*cursor) (Driver *drvthis, int x, int y, int type);
+
//// User-defined character functions
@@ -319,7 +322,7 @@ typedef struct my_driver_private {
- Get the screen height in lines.
+ Get the screen height in character lines.
The result is 1-based.
@@ -432,12 +435,9 @@ typedef struct my_driver_private {
- Sets the heartbeat to the indicated state.
- 0=off 1=graph1 2=graph2
- David GLAUDE:
- "state is apparently type and it could have the value
+ Sets the heartbeat to the indicated state: 0=off 1=graph1 2=graph2
HEARTBEAT_ON to say that we want to display/refresh the heartbeat.
- The driver choose how to do it. See MtxOrb.c"
+ The driver choose how to do it. See MtxOrb.c
@@ -450,6 +450,22 @@ typedef struct my_driver_private {
+ Draw named icon icon at position
+ (x,y).
+
+
+
+
+ void (*cursor)
+ Driver *drvthis
+ int x
+ int y
+ int type
+
+
+
+ Move cursor to position (x,y),
+ setting its type to type.
@@ -479,6 +495,8 @@ typedef struct my_driver_private {
+ Return the width of a character cell in pixels.
+ The result is 1-based.
@@ -488,6 +506,8 @@ typedef struct my_driver_private {
+ Return the height of a character cell in pixels.
+ The result is 1-based.
@@ -499,8 +519,7 @@ typedef struct my_driver_private {
Get the contrast value from the driver.
The return value is an integer in the range from 0 to 1000.
- Many displays do not support getting or setting contrast
- using software.
+ Many displays do not support getting or setting contrast using software.
@@ -529,8 +548,7 @@ typedef struct my_driver_private {
The parameter state determnies which one
is returned.
The return value is an integer in the range from 0 to 1000.
- Many displays do not support getting or setting brightness
- using software.
+ Many displays do not support getting or setting brightness using software.