libreofficekit

const (
	// Any tiles which are over the rectangle described in the payload are no
	// longer valid.
	//
	// Rectangle format: "x, y, width, height", where all numbers are document
	// coordinates, in twips. When all tiles are supposed to be dropped, the
	// format is the "EMPTY" string.
	CALLBACK_INVALIDATE_TILES CallbackType = 0

	// The size and/or the position of the visible cursor changed.
	//
	// Old format is the same as CALLBACK_INVALIDATE_TILES.
	// New format is a JSON with 3 elements the 'viewId' element represented by
	// an integer value, a 'rectangle' element in the format "x, y, width, height",
	// and a 'misspelledWord' element represented by an integer value: '1' when
	// a misspelled word is at the cursor position, '0' when the word is
	// not misspelled.
	CALLBACK_INVALIDATE_VISIBLE_CURSOR CallbackType = 1

	// The list of rectangles representing the current text selection changed.
	//
	// List format is "rectangle1[; rectangle2[; ...]]" (without quotes and
	// brackets), where rectangleN has the same format as
	// CALLBACK_INVALIDATE_TILES. When there is no selection, an empty
	// string is provided.
	CALLBACK_TEXT_SELECTION CallbackType = 2

	// The position and size of the cursor rectangle at the text
	// selection start. It is used to draw the selection handles.
	//
	// This callback must be called prior to CALLBACK_TEXT_SELECTION every
	// time the selection is updated.
	//
	// Rectangle format is the same as CALLBACK_INVALIDATE_TILES.
	CALLBACK_TEXT_SELECTION_START CallbackType = 3

	// The position and size of the cursor rectangle at the text
	// selection end. It is used to draw the selection handles.
	//
	// This callback must be called prior to CALLBACK_TEXT_SELECTION every
	// time the selection is updated.
	//
	// Rectangle format is the same as CALLBACK_INVALIDATE_TILES.
	CALLBACK_TEXT_SELECTION_END CallbackType = 4

	// The blinking text cursor is now visible or not.
	//
	// Clients should assume that this is true initially and are expected to
	// hide the blinking cursor at the rectangle described by
	// CALLBACK_INVALIDATE_VISIBLE_CURSOR once it becomes false. Payload is
	// either the "true" or the "false" string.
	CALLBACK_CURSOR_VISIBLE CallbackType = 5

	// The size and/or the position of the graphic selection changed,
	// the rotation angle of the embedded graphic object, and a property list
	// which can be used for informing the client about several properties.
	//
	// Format is "x, y, width, height, angle, { list of properties }",
	// where angle is in 100th of degree, and the property list is optional.
	//
	// The "{ list of properties }" part is in JSON format.
	// Follow some examples of the property list part:
	//
	// 1) when the selected object is an image inserted in Writer:
	//
	//      { "isWriterGraphic": true }
	//
	// 2) when the selected object is a chart legend:
	//
	//      { "isDraggable": true, "isResizable": true, "isRotatable": false }
	//
	// 3) when the selected object is a pie segment in a chart:
	//
	//      {
	//          "isDraggable": true,
	//          "isResizable": false,
	//          "isRotatable": false,
	//          "dragInfo": {
	//              "dragMethod": "PieSegmentDragging",
	//              "initialOffset": 50,
	//              "dragDirection": [x, y],
	//              "svg": "<svg ..."
	//          }
	//      }
	//
	//      where the "svg" property is a string containing an svg document
	//      which is a representation of the pie segment.
	CALLBACK_GRAPHIC_SELECTION CallbackType = 6

	// User clicked on a hyperlink that should be handled by other
	// applications accordingly.
	CALLBACK_HYPERLINK_CLICKED CallbackType = 7

	// Emit state update to the client.
	// For example, when cursor is on bold text, this callback is triggered
	// with payload: ".uno:Bold=true"
	CALLBACK_STATE_CHANGED CallbackType = 8

	// Start a "status indicator" (here restricted to a progress bar type
	// indicator). The payload is the descriptive text (or empty). Even if
	// there is no documentation that would promise so, we assume that de facto
	// for a document being viewed or edited, there will be at most one status
	// indicator, and its descriptive text will not change.
	//
	// Note that for the case of the progress indication during loading of a
	// document, the status indicator callbacks will arrive to the callback
	// registered for the LibreOfficeKit (singleton) object, not a
	// LibreOfficeKitDocument one, because we are in the very progress of
	// loading a document and then constructing a LibreOfficeKitDocument
	// object.
	CALLBACK_STATUS_INDICATOR_START CallbackType = 9

	// Sets the numeric value of the status indicator.
	// The payload should be a percentage, an integer between 0 and 100.
	CALLBACK_STATUS_INDICATOR_SET_VALUE CallbackType = 10

	// Ends the status indicator.
	//
	// Not necessarily ever emitted.
	CALLBACK_STATUS_INDICATOR_FINISH CallbackType = 11

	// No match was found for the search input
	CALLBACK_SEARCH_NOT_FOUND CallbackType = 12

	// Size of the document changed.
	//
	// Payload format is "width, height", i.e. clients get the new size without
	// having to do an explicit lok::Document::getDocumentSize() call.
	//
	// A size change is always preceded by a series of
	// CALLBACK_INVALIDATE_TILES events invalidating any areas
	// need re-rendering to adapt.
	CALLBACK_DOCUMENT_SIZE_CHANGED CallbackType = 13

	// The current part number is changed.
	//
	// Payload is a single 0-based integer.
	CALLBACK_SET_PART CallbackType = 14

	// Selection rectangles of the search result when find all is performed.
	//
	// Payload format example, in case of two matches:
	//
	// {
	//     "searchString": "...",
	//     "highlightAll": true|false, // this is a result of 'search all'
	//     "searchResultSelection": [
	//         {
	//             "part": "...",
	//             "rectangles": "..."
	//         },
	//         {
	//             "part": "...",
	//             "rectangles": "..."
	//         }
	//     ]
	// }
	//
	// - searchString is the search query
	// - searchResultSelection is an array of part-number and rectangle list
	//   pairs, in CALLBACK_SET_PART / CALLBACK_TEXT_SELECTION format.
	CALLBACK_SEARCH_RESULT_SELECTION CallbackType = 15

	// Result of the UNO command execution when bNotifyWhenFinished was set
	// to 'true' during the postUnoCommand() call.
	//
	// The result returns a success / failure state, and potentially
	// additional data:
	//
	// {
	//     "commandName": "...",    // the command for which this is the result
	//     "success": true/false,   // when the result is "don't know", this is missing
	//     // TODO "result": "..."  // UNO Any converted to JSON (not implemented yet)
	// }
	CALLBACK_UNO_COMMAND_RESULT CallbackType = 16

	// The size and/or the position of the cell cursor changed.
	//
	// Payload format: "x, y, width, height, column, row", where the first
	// 4 numbers are document coordinates, in twips, and the last 2 are table
	// coordinates starting from 0.
	// When the cursor is not shown the payload format is the "EMPTY" string.
	//
	// Rectangle format is the same as CALLBACK_INVALIDATE_TILES.
	CALLBACK_CELL_CURSOR CallbackType = 17

	// The current mouse pointer style.
	//
	// Payload is a css mouse pointer style.
	CALLBACK_MOUSE_POINTER CallbackType = 18

	// The text content of the formula bar in Calc.
	CALLBACK_CELL_FORMULA CallbackType = 19

	// Loading a document requires a password.
	//
	// Loading the document is blocked until the password is provided via
	// lok::Office::setDocumentPassword().  The document cannot be loaded
	// without the password.
	CALLBACK_DOCUMENT_PASSWORD CallbackType = 20

	// Editing a document requires a password.
	//
	// Loading the document is blocked until the password is provided via
	// lok::Office::setDocumentPassword().
	CALLBACK_DOCUMENT_PASSWORD_TO_MODIFY CallbackType = 21

	// An error happened.
	//
	// The payload returns information further identifying the error, like:
	//
	// {
	//     "classification": "error" | "warning" | "info"
	//     "kind": "network" etc.
	//     "code": a structured 32-bit error code, the ErrCode from LibreOffice's <tools/errcode.hxx>
	//     "message": freeform description
	// }
	CALLBACK_ERROR CallbackType = 22

	// Context menu structure
	//
	// Returns the structure of context menu.  Contains all the separators &
	// submenus, example of the returned structure:
	//
	// {
	//     "menu": [
	//         { "text": "label text1", "type": "command", "command": ".uno:Something1", "enabled": "true" },
	//         { "text": "label text2", "type": "command", "command": ".uno:Something2", "enabled": "false" },
	//         { "type": "separator" },
	//         { "text": "label text2", "type": "menu", "menu": [ { ... }, { ... }, ... ] },
	//         ...
	//     ]
	// }
	//
	// The 'command' can additionally have a checkable status, like:
	//
	//     {"text": "label text3", "type": "command", "command": ".uno:Something3", "checktype": "checkmark|radio|auto", "checked": "true|false"}
	CALLBACK_CONTEXT_MENU CallbackType = 23

	// The size and/or the position of the view cursor changed. A view cursor
	// is a cursor of another view, the current view can't change it.
	//
	// The payload format:
	//
	// {
	//     "viewId": "..."
	//     "rectangle": "..."
	// }
	//
	// - viewId is a value returned earlier by lok::Document::createView()
	// - rectangle uses the format of CALLBACK_INVALIDATE_VISIBLE_CURSOR
	CALLBACK_INVALIDATE_VIEW_CURSOR CallbackType = 24

	// The text selection in one of the other views has changed.
	//
	// The payload format:
	//
	// {
	//     "viewId": "..."
	//     "selection": "..."
	// }
	//
	// - viewId is a value returned earlier by lok::Document::createView()
	// - selection uses the format of CALLBACK_TEXT_SELECTION.
	CALLBACK_TEXT_VIEW_SELECTION CallbackType = 25

	// The cell cursor in one of the other views has changed.
	//
	// The payload format:
	//
	// {
	//     "viewId": "..."
	//     "rectangle": "..."
	// }
	//
	// - viewId is a value returned earlier by lok::Document::createView()
	// - rectangle uses the format of CALLBACK_CELL_CURSOR.
	CALLBACK_CELL_VIEW_CURSOR CallbackType = 26

	// The size and/or the position of a graphic selection in one of the other
	// views has changed.
	//
	// The payload format:
	//
	// {
	//     "viewId": "..."
	//     "selection": "..."
	// }
	//
	// - viewId is a value returned earlier by lok::Document::createView()
	// - selection uses the format of CALLBACK_INVALIDATE_TILES.
	CALLBACK_GRAPHIC_VIEW_SELECTION CallbackType = 27

	// The blinking text cursor in one of the other views is now visible or
	// not.
	//
	// The payload format:
	//
	// {
	//     "viewId": "..."
	//     "visible": "..."
	// }
	//
	// - viewId is a value returned earlier by lok::Document::createView()
	// - visible uses the format of CALLBACK_CURSOR_VISIBLE.
	CALLBACK_VIEW_CURSOR_VISIBLE CallbackType = 28

	// The size and/or the position of a lock rectangle in one of the other
	// views has changed.
	//
	// The payload format:
	//
	// {
	//     "viewId": "..."
	//     "rectangle": "..."
	// }
	//
	// - viewId is a value returned earlier by lok::Document::createView()
	// - rectangle uses the format of CALLBACK_INVALIDATE_TILES.
	CALLBACK_VIEW_LOCK CallbackType = 29

	// The size of the change tracking table has changed.
	//
	// The payload example:
	// {
	//     "redline": {
	//         "action": "Remove",
	//         "index": "1",
	//         "author": "Unknown Author",
	//         "type": "Delete",
	//         "comment": "",
	//         "description": "Delete 'abc'",
	//         "dateTime": "2016-08-18T12:14:00"
	//     }
	// }
	//
	// The format is the same as an entry of
	// lok::Document::getCommandValues('.uno:AcceptTrackedChanges'), extra
	// fields:
	//
	// - 'action' is either 'Add' or 'Remove', depending on if this is an
	//   insertion into the table or a removal.
	CALLBACK_REDLINE_TABLE_SIZE_CHANGED CallbackType = 30

	// An entry in the change tracking table has been modified.
	//
	// The payload example:
	// {
	//     "redline": {
	//         "action": "Modify",
	//         "index": "1",
	//         "author": "Unknown Author",
	//         "type": "Insert",
	//         "comment": "",
	//         "description": "Insert 'abcd'",
	//         "dateTime": "2016-08-18T13:13:00"
	//     }
	// }
	//
	// The format is the same as an entry of
	// lok::Document::getCommandValues('.uno:AcceptTrackedChanges'), extra
	// fields:
	//
	// - 'action' is 'Modify'.
	CALLBACK_REDLINE_TABLE_ENTRY_MODIFIED CallbackType = 31

	// There is some change in comments in the document
	//
	// The payload example:
	// {
	//     "comment": {
	//         "action": "Add",
	//         "id": "11",
	//         "parent": "4",
	//         "author": "Unknown Author",
	//         "text": "",
	//         "dateTime": "2016-08-18T13:13:00",
	//         "anchorPos": "4529, 3906",
	//         "textRange": "1418, 3906, 3111, 919"
	//     }
	// }
	//
	// The format is the same as an entry of
	// lok::Document::getCommandValues('.uno:ViewAnnotations'), extra
	// fields:
	//
	// - 'action' can be 'Add', 'Remove' or 'Modify' depending on whether
	//    comment has been added, removed or modified.
	CALLBACK_COMMENT CallbackType = 32

	// The column/row header is no more valid because of a column/row insertion
	// or a similar event. Clients must query a new column/row header set.
	//
	// The payload says if we are invalidating a row or column header. So,
	// payload values can be: "row", "column", "all".
	CALLBACK_INVALIDATE_HEADER CallbackType = 33

	// The text content of the address field in Calc. Eg: "A7"
	CALLBACK_CELL_ADDRESS CallbackType = 34

	// The key ruler related properties on change are reported by this.
	//
	// The payload format is:
	//
	// {
	//      "margin1": "...",
	//      "margin2": "...",
	//      "leftOffset": "...",
	//      "pageOffset": "...",
	//      "pageWidth": "...",
	//      "unit": "..."
	//  }
	//
	// Here all aproperties are same as described in svxruler.
	CALLBACK_RULER_UPDATE CallbackType = 35

	// 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.)
	//  - "deck" - window is a docked/floating deck (i.e. the sidebar)
	//  - "tooltip" - window is a tooltip popup
	//
	// "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 available
	//    in "visible" field
	// - "close" - window is closed
	// - "show" - show the window
	// - "hide" - hide the window
	CALLBACK_WINDOW CallbackType = 36

	// When for the current cell is defined a validity list we need to show
	// a drop down button in the form of a marker.
	//
	// The payload format is: "x, y, visible" where x, y are the current
	// cell cursor coordinates and visible is set to 0 or 1.
	CALLBACK_VALIDITY_LIST_BUTTON CallbackType = 37

	// Notification that the clipboard contents have changed.
	// Typically fired in response to copying to clipboard.
	//
	// Payload is optional. When payload is empty, Online gets string from selected text.
	// Payload format is JSON.
	// Example: { "mimeType": "text/plain", "content": "some content" }
	CALLBACK_CLIPBOARD_CHANGED CallbackType = 38

	// When the (editing) context changes - like the user switches from
	// editing textbox in Impress to editing a shape there.
	//
	// Payload is the application ID and context, delimited by space.
	// Eg. com.sun.star.presentation.PresentationDocument TextObject
	CALLBACK_CONTEXT_CHANGED CallbackType = 39

	// On-load notification of the document signature status.
	CALLBACK_SIGNATURE_STATUS CallbackType = 40

	// Profiling tracing information single string of multiple lines
	// containing <pid> <timestamp> and zone start/stop information
	CALLBACK_PROFILE_FRAME CallbackType = 41

	// The position and size of the cell selection area. It is used to
	// draw the selection handles for cells in Calc documents.
	//
	// Rectangle format is the same as CALLBACK_INVALIDATE_TILES.
	CALLBACK_CELL_SELECTION_AREA CallbackType = 42

	// The position and size of the cell auto fill area. It is used to
	// trigger auto fill functionality if that area is hit.
	//
	// Rectangle format is the same as CALLBACK_INVALIDATE_TILES.
	CALLBACK_CELL_AUTO_FILL_AREA CallbackType = 43

	// When the cursor is in a table or a table is selected in the
	// document, this sends the table's column and row border positions
	// to the client. If the payload is empty (empty JSON object), then
	// no table is currently selected or the cursor is not inside a table
	// cell.
	CALLBACK_TABLE_SELECTED CallbackType = 44

	// Show reference marks from payload.
	//
	// Example payload:
	// {
	//     "marks": [
	//         { "rectangle": "3825, 3315, 1245, 2010", "color": "0000ff", "part": "0" },
	//         { "rectangle": "8925, 4335, 2520, 735", "color": "ff0000", "part": "0" },
	//         ...
	//     ]
	// }
	CALLBACK_REFERENCE_MARKS CallbackType = 45

	// Callback related to native dialogs generated in JavaScript from
	// the description.
	CALLBACK_JSDIALOG CallbackType = 46

	// Send the list of functions whose name starts with the characters entered
	// by the user in the formula input bar.
	CALLBACK_CALC_FUNCTION_LIST CallbackType = 47

	// Sends the tab stop list for the current of the current cursor position.
	CALLBACK_TAB_STOP_LIST CallbackType = 48

	// Sends all information for displaying form field button for a text based field.
	//
	// It contains the position where the frame with the button should be displayed and
	// also contains all information that the popup window needs.
	//
	// The payload example:
	// {
	//      "action": "show",
	//      "type": "drop-down",
	//      "textArea": "1418, 3906, 3111, 919",
	//      "params": {
	//           "items": ["January", "February", "July"],
	//           "selected": "2",
	//           "placeholder": "No items specified"
	//      }
	// }
	//
	// or
	// {
	//      "action": "hide",
	//      "type": "drop-down"
	// }
	CALLBACK_FORM_FIELD_BUTTON CallbackType = 49

	// This is Calc specific. Indicates that some or all of the current sheet's
	// geometry data has changed. Clients must request a full or partial sheet
	// geometry data set.
	//
	// The payload specifies what part of the sheet geometry data has changed.
	// The payload format is:
	// 'all|rows|columns [sizes [hidden [filtered [groups]]]]'
	//
	// For example, the payload 'rows sizes groups' indicates that the row heights
	// and row-groups data have changed.
	CALLBACK_INVALIDATE_SHEET_GEOMETRY CallbackType = 50

	// When for the current cell is defined an input help text.
	//
	// The payload format is JSON: { "title": "title text", "content": "content text" }
	CALLBACK_VALIDITY_INPUT_HELP CallbackType = 51

	// This is currently Calc only. Indicates the document background
	// color in the payload as a RGB hex string (RRGGBB).
	CALLBACK_DOCUMENT_BACKGROUND_COLOR CallbackType = 52

	// When a user tries to use command which is restricted for that user
	COMMAND_BLOCKED CallbackType = 53

	// The position of the cell cursor jumped to.
	//
	// Payload format: "x, y, width, height, column, row", where the first
	// 4 numbers are document coordinates, in twips, and the last 2 are table
	// coordinates starting from 0.
	// When the cursor is not shown the payload format is the "EMPTY" string.
	//
	// Rectangle format is the same as CALLBACK_INVALIDATE_TILES.
	CALLBACK_SC_FOLLOW_JUMP CallbackType = 54
)

const (
	DOCTYPE_TEXT DocumentType = iota
	DOCTYPE_SPREADSHEET
	DOCTYPE_PRESENTATION
	DOCTYPE_DRAWING
	DOCTYPE_OTHER
)

const (
	// cf. SalEvent::ExtTextInput
	EXT_TEXTINPUT ExtTextInputType = iota
	// cf. SalEvent::ExtTextInputPos
	EXT_TEXTINPUT_POS
	// cf. SalEvent::EndExtTextInput
	EXT_TEXTINPUT_END
)

const (
	// A key on the keyboard is pressed.
	KEYEVENT_KEYINPUT KeyEventType = iota
	// A key on the keyboard is released.
	KEYEVENT_KEYUP
)

const (
	// A pressed gesture has started.
	MOUSEEVENT_MOUSEBUTTONDOWN MouseEventType = iota
	// A pressed gesture has finished.
	MOUSEEVENT_MOUSEBUTTONUP
	// A change has happened during a press gesture.
	MOUSEEVENT_MOUSEMOVE
)

const (
	// Handle CALLBACK_DOCUMENT_PASSWORD by prompting the user
	// for a password.
	FEATURE_DOCUMENT_PASSWORD OptionalFeatures = 1 << iota

	// Handle CALLBACK_DOCUMENT_PASSWORD_TO_MODIFY by prompting the user
	// for a password.
	FEATURE_DOCUMENT_PASSWORD_TO_MODIFY

	// Request to have the part number as an 5th value in the
	// CALLBACK_INVALIDATE_TILES payload.
	FEATURE_PART_IN_INVALIDATION_CALLBACK

	// Turn off tile rendering for annotations
	FEATURE_NO_TILED_ANNOTATIONS

	// Enable range based header data
	FEATURE_RANGE_HEADERS

	// Request to have the active view's Id as the 1st value in the
	// CALLBACK_INVALIDATE_VISIBLE_CURSOR payload.
	FEATURE_VIEWID_IN_VISCURSOR_INVALIDATION_CALLBACK
)

const (
	PARTMODE_SLIDES PartMode = iota
	PARTMODE_NOTES
)

const (
	SELTYPE_NONE SelectionType = iota
	SELTYPE_TEXT
	SELTYPE_LARGE_TEXT
	SELTYPE_COMPLEX
)

const (
	// A move or a resize action starts. It is assumed that there is a valid
	// graphic selection (see CALLBACK_GRAPHIC_SELECTION) and the supplied
	// coordinates are the ones the user tapped on.
	//
	// The type of the action is move by default, unless the coordinates are
	// the position of a handle (see below), in which case it's a resize.
	//
	// There are 8 handles for a graphic selection:
	// - top-left, top-center, top-right
	// - middle-left, middle-right
	// - bottom-left, bottom-center, bottom-right
	SETGRAPHICSELECTION_START SetGraphicSelectionType = iota

	// A move or resize action stops. It is assumed that this is always used
	// only after a SETTEXTSELECTION_START. The supplied coordinates are
	// the ones where the user released the screen.
	SETGRAPHICSELECTION_END
)

const (
	// The start of selection is to be adjusted.
	SETTEXTSELECTION_START SetTextSelectionType = iota
	// The end of selection is to be adjusted.
	SETTEXTSELECTION_END
	// Both the start and the end of selection is to be adjusted.
	SETTEXTSELECTION_RESET
)

const (
	// The document is not signed.
	SIGNATURE_NONE SignatureState = iota
	// The document is signed and the signature is valid.
	SIGNATURE_OK
	// The document is signed but the signature is invalid.
	SIGNATURE_INVALID
	// The document has a partial set of signatures.
	SIGNATURE_PARTIAL
)

const (
	TILEMODE_RGBA TileMode = iota
	TILEMODE_BGRA
)

const (
	WINDOW_CLOSE WindowAction = iota
	WINDOW_PASTE
)