summaryrefslogtreecommitdiff
path: root/include/LibreOfficeKit/LibreOfficeKitEnums.h
diff options
context:
space:
mode:
authorPranav Kant <pranavk@collabora.co.uk>2017-12-21 13:20:26 +0530
committerAndras Timar <andras.timar@collabora.com>2018-03-19 19:06:16 +0100
commitfb51e433f8991c9a50fcd53e2845538a5710c776 (patch)
tree23dc622693f80d6a5328da8401e62e96c0212949 /include/LibreOfficeKit/LibreOfficeKitEnums.h
parentd2e79cfbb188d6402dbcfc7bd71886f6d2252727 (diff)
lokdocview: Handle INVALIDATE_HEADER cb
With this calc gtktiledviewer or any other lok client shouldn't crash anymore when a new view is opened. And while at it, update documentation of callbacks. (cherry picked from commit 71cd37fad9792038279969c82e0cb209df06f024) Change-Id: I436c3b424dd4e2e6b8c312b0d3ba43d7006e944b
Diffstat (limited to 'include/LibreOfficeKit/LibreOfficeKitEnums.h')
-rw-r--r--include/LibreOfficeKit/LibreOfficeKitEnums.h27
1 files changed, 26 insertions, 1 deletions
diff --git a/include/LibreOfficeKit/LibreOfficeKitEnums.h b/include/LibreOfficeKit/LibreOfficeKitEnums.h
index dc5f82d2f1e2..46be3f25fea8 100644
--- a/include/LibreOfficeKit/LibreOfficeKitEnums.h
+++ b/include/LibreOfficeKit/LibreOfficeKitEnums.h
@@ -540,7 +540,32 @@ typedef enum
*/
LOK_CALLBACK_RULER_UPDATE = 35,
/**
- * Dialog invalidation
+ * Window related callbacks are emitted under this category. It includes
+ * external windows like dialogs, autopopups for now.
+ *
+ * The payload format is:
+ *
+ * {
+ * "id": "unique integer id of the dialog",
+ * "action": "<see below>",
+ * "type": "<see below>"
+ * "rectangle": "x, y, width, height"
+ * }
+ *
+ * "type" tells the type of the window the action is associated with
+ * - "dialog" - window is a dialog
+ * - "child" - window is a floating window (combo boxes, etc.)
+ *
+ * "action" can take following values:
+ * - "created" - window is created in the backend, client can render it now
+ * - "title_changed" - window's title is changed
+ * - "size_changed" - window's size is changed
+ * - "invalidate" - the area as described by "rectangle" is invalidated
+ * Clients must request the new area
+ * - "cursor_invalidate" - cursor is invalidated. New position is in "rectangle"
+ * - "cursor_visible" - cursor visible status is changed. Status is availabe
+ * in "visible" field
+ * - "close" - window is closed
*/
LOK_CALLBACK_WINDOW = 36,
}