Commit 9a43cc0d authored by Serge A. Zaitsev's avatar Serge A. Zaitsev

added readme

parent fd9f32ba
Tray
----
Cross-platform, super tiny C99 implementation of a system tray icon with a popup menu.
Works well on:
* Linux/Gtk (libappindicator)
* Windows XP or newer (shellapi.h)
* MacOS (Cocoa/AppKit)
There is also a stub implementation that returns errors on attempt to create a tray menu.
# Example
```c
struct tray tray = {
.icon = "icon.png",
.menu = (struct tray_menu[]){{"Toggle me", 0, 0, toggle_cb, NULL},
{"-", 0, 0, NULL, NULL},
{"Quit", 0, 0, quit_cb, NULL},
{NULL, 0, 0, NULL, NULL}},
};
void toggle_cb(struct tray_menu *item) {
item->checked = !item->checked;
tray_update(&tray);
}
void quit_cb(struct tray_menu *item) {
tray_exit();
}
...
tray_init(&tray);
while (tray_loop(1) == 0);
tray_exit();
```
# API
Tray structure defines an icon and a menu.
Menu is a NULL-terminated array of items.
Menu item defines menu text, menu checked and disabled (grayed) flags and a
callback with some optional context pointer.
```c
struct tray {
char *icon;
struct tray_menu *menu;
};
struct tray_menu {
char *text;
int disabled;
int checked;
void (*cb)(struct tray_menu *);
void *context;
};
```
* `int tray_init(struct tray *)` - creates tray icon. Returns -1 if tray icon/menu can't be created.
* `void tray_update(struct tray *)` - updates tray icon and menu.
* `int tray_loop(int blocking)` - runs one iteration of the UI loop. Returns -1 if `tray_exit()` has been called.
* `void tray_exit()` - terminates UI loop.
All functions are meant to be called from the UI thread only.
## Roadmap
[x] Cross-platform tray icon
[x] Cross-platform tray popup menu
[x] Separators in the menu
[x] Disabled/enabled menu items
[x] Checked/unchecked menu items
[ ] Nested menus
[ ] Icons for menu items
[ ] Rewrite ObjC code in C using ObjC Runtime (now ObjC code breaks many linters and static analyzers)
[ ] Call GTK code using dlopen/dlsym (to make binaries run safely if Gtk libraries are not available)
## License
This software is distributed under [MIT license](http://www.opensource.org/licenses/mit-license.php),
so feel free to integrate it in your commercial products.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment