home | support | contact | forum

Zhorn Software
stickies | bart | zbar | caffeine | cas | birthday reminder | soundboard | vnchelper
Stickies

Download

Screenshots

FAQ

Tools

API

    Overview

    Code

    Commands

    Events

    Code ideas

Skins

Versions

Stickies API

The following is description of each of the events which your application may be sent, once it's registered with Stickies for events. Some you may want to ignore, others you may need to process.

Text in <angle brackets> is a parameter - it will change according to the current state of Stickies.

 


500 created desktop sticky <reason> <uniqueid>

A desktop sticky with the specified unique id has been created, for the specified reason

Remarks

The unique id identifies a sticky which has just been created on the desktop. It will now be visible to the user, and can be queried for additional values by the API. The basic source of this message is that a user has created a new note. However, it will also be generated whenever any activity causes a new sticky to appear - loading Stickies, copying an existing one, an attached sticky appearing and so on.

The reason given explains why the sticky has been created. It will be one of the following values:

  • welcome
  • loaded
  • imported
  • network
  • new
  • waking
  • attached
  • undeleted
  • woken
  • unattached
  • unstored
  • copied

 


501 closed desktop sticky <reason> <uniqueid>

The specified desktop sticky has been closed

Remarks

The sticky has been closed, and is now in the Closed stickies list. It is no longer be accessible on the desktop to the user, or to the API.

The reason given explains why the sticky has been closed. It will be one of the following values:

  • closed
  • exiting
  • unattached
  • stored
  • topalm
  • network
  • email
  • movetofile
  • slept
  • toppc

 


502 deleted desktop sticky <uniqueid>

The specified sticky has been deleted from the desktop

Remarks

This command indicates that the sticky has been permanently removed from the desktop. One cause of this is that the user has shift-deleted it, or perhaps that they store no closed stickies, but it may also mean that the sticky has been sent to sleep, moved to file, or stored. The event means that it is gone, and has not been added to the Closed list of stickies. The sticky is no longer available on the desktop to the user, or to the API.

 


503 stickies is exiting

Stickies is terminating

Remarks

Stickies is terminating. No more communication will be possible until it is restarted. If your application was registered, it will need to re-register for events when Stickies is running again.

 


504 custom Stickies command: <command>

A custom menu command was clicked on the Stickies task-tray menu

Remarks

The custom command string which this event contains details which of the custom commands, added with the "do stickymenuadd" command above the user has clicked. Your application should check that the command is one which it needs to respond to, as any command clicked in Stickies will cause this event to be sent to all registered API clients.

 


505 custom sticky command: <command> <uniqueid>

A custom menu command was clicked on a sticky right-click menu

Remarks

The custom command string which this event contains details which of the custom commands, added with the "do stickiesmenuadd" command above the user has clicked. Your application should check that the command is one which it needs to respond to, as any command clicked in Stickies will cause this event to be sent to all registered API clients. The unique id identifies which sticky the user has selected, and clicked this menu item on.

 


506 desktop sticky focus <uniqueid>

The user clicked the mouse into a desktop sticky

Remarks

Used to identify the currently selected sticky - this event is sent when any desktop sticky gains input focus.

 


507 desktop sticky lostfocus <uniqueid>

The user moved input focus away from a desktop sticky

Remarks

This event is sent when any desktop sticky loses input focus, when the user clicks either onto another application, the desktop or perhaps another sticky.

 


508 deleted closed sticky <uniqueid>

A sticky was permanently removed from the application

Remarks

When a sticky is closed, it usually passes into the Closed stickies list - unless the user either bypasses the Closed category by shift-deleting it, or perhaps if they choose to keep zero Closed stickies. This event fires when the oldest Closed sticky is permenently removed, because the user has closed a desktop note, and more room needs to be made in the Closed category.

 


509 desktop sticky moved <uniqueid>[,<uniqueid>]
Requires: 8.0c

The desktop sticky, or stickies, were moved

Remarks

One or more desktop stickies were moved on the screen. Use the API command get desktop <id> position to retrieve the new position of any note. The unique ID is a list of IDs terminated with a comma - this may be just one note, or more than one note if the user has moved a number of stickies at once.

 


510 desktop sticky sized <uniqueid>
Requires: 8.0c

A desktop sticky was resized

Remarks

The desktop sticky identified by the ID has had its size altered. In order to determine the new size, use the command get desktop <id> size.

 


511 created stack <uniqueid>
Requires: 9.0a

A new stack was created

Remarks

Stack IDs are in a different range than sticky IDs, and are an integer.

 


512 closed stack <uniqueid>
Requires: 9.0a

A stack was closed

Remarks

Stack IDs are in a different range than sticky IDs, and are an integer.

 


513 stack moved <uniqueid> to <x>,<y>
Requires: 9.0a

The specified stack was moved on screen to the location specified.

Remarks

The stack has been moved by the user dragging it,

 


514 stack sized <uniqueid> to <w>x<h>
Requires: 9.0a

A stack was closed

Remarks

The specified stack has been sized by the user

 


515 backup taken to: <path>
Requires: 9.0a

A backup has been taken

Remarks

This may have been a scheduled backup, generated by Stickies, or instead a manual backup created by the user.

 


516 stickies is exiting for a restore from: <path>
Requires: 9.0a

All Stickies data is about to be restored

Remarks

Immediately following this API command, Stickies will become unresponsive to further commands for a period, while it copies the data into place and then restarts to pick up that data. Following this operation, anything you know about stickies, stacks, options ... or anything else may be completely different.

 


517 desktop sticky rolled <id>
517 desktop sticky unrolled <id>
Requires: 9.0a

The status of the specified desktop sticky has changed

Remarks

A slightly different message is received depending on whether the note was rolled up, or was unrolled.

 


518 options changed
Requires: 9.0a

Options have changed

Remarks

This event will trigger when the user has opened the Options dialog, and then clicked OK. It does not guarantee that any options were actually altered, but just that the user clicked OK to the dialog.

 


© Zhorn Software 2016