interesting
/
libui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Slightly more documentation. Now to figure out error handling.

This commit is contained in:
Pietro Gagliardi 2019-05-12 13:59:31 -04:00
parent 1a047da08c
commit 781a4117a7
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/events.md
View File

@ -22,18 +22,22 @@ typedef void (*uiEventHandler)(void *sender, void *args, void *data);
`uiEventHandler` is the type of a pointer to an event handler function registered with `uiEventAddHandler()`. `uiEventHandler` is the type of a pointer to an event handler function registered with `uiEventAddHandler()`.
`args` will be the respective argument passed to `uiEventFire()`, and `sender` and `data` will be the respective arguments passed to `uiEventAddHandler()`.
### `uiEventOptions` ### `uiEventOptions`
```c ```c
typedef struct uiEventOptions uiEventOptions; typedef struct uiEventOptions uiEventOptions;
struct uiEventOptions { struct uiEventOptions {
// TODO size size_t Size;
bool Global; bool Global;
}; };
``` ```
`uiEventOptions` describes the properties of a `uiEvent`; you pass these to `uiNewEvent()`. `uiEventOptions` describes the properties of a `uiEvent`; you pass these to `uiNewEvent()`.
You are responsible for allocating and initializing this struct. To do so, you simply zero the memory for this struct and set its `Size` field to `sizeof (uiEventOptions)`. (TODO put this in a common place)
If `Global` is true, the event is "global" — there are no specific senders, and all registered handler functions are called when the event is fired. Otherwise, the event has specific senders, and only handlers registered with the sender that is currently firing the event will be called. If `Global` is true, the event is "global" — there are no specific senders, and all registered handler functions are called when the event is fired. Otherwise, the event has specific senders, and only handlers registered with the sender that is currently firing the event will be called.
### `uiNewEvent()` ### `uiNewEvent()`