/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #ifndef INCLUDED_LIBREOFFICEKIT_LIBREOFFICEKITENUMS_H #define INCLUDED_LIBREOFFICEKIT_LIBREOFFICEKITENUMS_H #ifdef __cplusplus extern "C" { #endif #if defined LOK_USE_UNSTABLE_API || defined LIBO_INTERNAL_ONLY typedef enum { LOK_DOCTYPE_TEXT, LOK_DOCTYPE_SPREADSHEET, LOK_DOCTYPE_PRESENTATION, LOK_DOCTYPE_DRAWING, LOK_DOCTYPE_OTHER } LibreOfficeKitDocumentType; typedef enum { LOK_PARTMODE_SLIDES, LOK_PARTMODE_NOTES } LibreOfficeKitPartMode; typedef enum { LOK_TILEMODE_RGBA, LOK_TILEMODE_BGRA } LibreOfficeKitTileMode; /** Optional features of LibreOfficeKit, in particular callbacks that block * LibreOfficeKit until the corresponding reply is received, which would * deadlock if the client does not support the feature. * * @see lok::Office::setOptionalFeatures(). */ typedef enum { /** * Handle LOK_CALLBACK_DOCUMENT_PASSWORD by prompting the user * for a password. * * @see lok::Office::setDocumentPassword(). */ LOK_FEATURE_DOCUMENT_PASSWORD = (1ULL << 0), /** * Handle LOK_CALLBACK_DOCUMENT_PASSWORD_TO_MODIFY by prompting the user * for a password. * * @see lok::Office::setDocumentPassword(). */ LOK_FEATURE_DOCUMENT_PASSWORD_TO_MODIFY = (1ULL << 1), /** * Request to have the part number as an 5th value in the * LOK_CALLBACK_INVALIDATE_TILES payload. */ LOK_FEATURE_PART_IN_INVALIDATION_CALLBACK = (1ULL << 2), /** * Turn off tile rendering for annotations */ LOK_FEATURE_NO_TILED_ANNOTATIONS = (1ULL << 3) } LibreOfficeKitOptionalFeatures; // This enumerates the types of callbacks emitted to a LibreOfficeKit // object's callback function or to a LibreOfficeKitDocument object's // callback function. No callback type will be emitted to both. It is a // bit unfortunate that the same enum contains both kinds of // callbacks. // TODO: We should really add some indication at the documentation for // each enum value telling which type of callback it is. typedef enum { /** * 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. * * @see LOK_FEATURE_PART_IN_INVALIDATION_CALLBACK. */ LOK_CALLBACK_INVALIDATE_TILES = 0, /** * The size and/or the position of the visible cursor changed. * * Rectangle format is the same as LOK_CALLBACK_INVALIDATE_TILES. */ LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR = 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 * LOK_CALLBACK_INVALIDATE_TILES. When there is no selection, an empty * string is provided. */ LOK_CALLBACK_TEXT_SELECTION = 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 LOK_CALLBACK_TEXT_SELECTION every * time the selection is updated. * * Rectangle format is the same as LOK_CALLBACK_INVALIDATE_TILES. */ LOK_CALLBACK_TEXT_SELECTION_START = 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 LOK_CALLBACK_TEXT_SELECTION every * time the selection is updated. * * Rectangle format is the same as LOK_CALLBACK_INVALIDATE_TILES. */ LOK_CALLBACK_TEXT_SELECTION_END = 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 * LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR once it becomes false. Payload is * either the "true" or the "false" string. */ LOK_CALLBACK_CURSOR_VISIBLE = 5, /** * The size and/or the position of the graphic selection changed. * * Rectangle format is the same as LOK_CALLBACK_INVALIDATE_TILES. */ LOK_CALLBACK_GRAPHIC_SELECTION = 6, /** * User clicked on an hyperlink that should be handled by other * applications accordingly. */ LOK_CALLBACK_HYPERLINK_CLICKED = 7, /** * Emit state update to the client. * For example, when cursor is on bold text, this callback is triggered * with payload: ".uno:Bold=true" */ LOK_CALLBACK_STATE_CHANGED = 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. */ LOK_CALLBACK_STATUS_INDICATOR_START = 9, /** * Sets the numeric value of the status indicator. * The payload should be a percentage, an integer between 0 and 100. */ LOK_CALLBACK_STATUS_INDICATOR_SET_VALUE = 10, /** * Ends the status indicator. * * Not necessarily ever emitted. */ LOK_CALLBACK_STATUS_INDICATOR_FINISH = 11, /** * No match was found for the search input */ LOK_CALLBACK_SEARCH_NOT_FOUND = 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. */ LOK_CALLBACK_DOCUMENT_SIZE_CHANGED = 13, /** * The current part number is changed. * * Payload is a single 0-based integer. */ LOK_CALLBACK_SET_PART = 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 LOK_CALLBACK_SET_PART / LOK_CALLBACK_TEXT_SELECTION format. */ LOK_CALLBACK_SEARCH_RESULT_SELECTION = 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) * } */ LOK_CALLBACK_UNO_COMMAND_RESULT = 16, /** * The size and/or the position of the cell cursor changed. * * Rectangle format is the same as LOK_CALLBACK_INVALIDATE_TILES. */ LOK_CALLBACK_CELL_CURSOR = 17, /** * The current mouse pointer style. * * Payload is a css mouse pointer style. */ LOK_CALLBACK_MOUSE_POINTER = 18, /** * The text content of the formula bar in Calc. */ LOK_CALLBACK_CELL_FORMULA = 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. */ LOK_CALLBACK_DOCUMENT_PASSWORD = 20, /** * Editing a document requires a password. * * Loading the document is blocked until the password is provided via * lok::Office::setDocumentPassword(). */ LOK_CALLBACK_DOCUMENT_PASSWORD_TO_MODIFY = 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 * "message": freeform description * } */ LOK_CALLBACK_ERROR = 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"} */ LOK_CALLBACK_CONTEXT_MENU = 23, /** * The size and/or the position of the view cursor changed. A view cursor * is a cursor of an other 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 LOK_CALLBACK_INVALIDATE_VISIBLE_CURSOR */ LOK_CALLBACK_INVALIDATE_VIEW_CURSOR = 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 LOK_CALLBACK_TEXT_SELECTION. */ LOK_CALLBACK_TEXT_VIEW_SELECTION = 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 LOK_CALLBACK_CELL_CURSOR. */ LOK_CALLBACK_CELL_VIEW_CURSOR = 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 LOK_CALLBACK_INVALIDATE_TILES. */ LOK_CALLBACK_GRAPHIC_VIEW_SELECTION = 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 LOK_CALLBACK_CURSOR_VISIBLE. */ LOK_CALLBACK_VIEW_CURSOR_VISIBLE = 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 LOK_CALLBACK_INVALIDATE_TILES. */ LOK_CALLBACK_VIEW_LOCK = 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. */ LOK_CALLBACK_REDLINE_TABLE_SIZE_CHANGED = 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'. */ LOK_CALLBACK_REDLINE_TABLE_ENTRY_MODIFIED = 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. */ LOK_CALLBACK_COMMENT = 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. */ LOK_CALLBACK_INVALIDATE_HEADER = 33, /** * The text content of the address field in Calc. */ LOK_CALLBACK_CELL_ADDRESS = 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. */ LOK_CALLBACK_RULER_UPDATE = 35, /** * Dialog invalidation */ LOK_CALLBACK_DIALOG = 36, /** * Invalidation corresponding to dialog's children. * Eg: Floating window etc. * * Payload example: * { * "dialogID": "SpellDialog", * "action": "close" * } * * - dialogID is the UNO command of the dialog * - action can be * - close, means dialog child window is closed now * - invalidate, means dialog child window is invalidated * It also means that dialog child window is created if it's the first * invalidate */ LOK_CALLBACK_DIALOG_CHILD = 37 } LibreOfficeKitCallbackType; typedef enum { /// A key on the keyboard is pressed. LOK_KEYEVENT_KEYINPUT, /// A key on the keyboard is released. LOK_KEYEVENT_KEYUP } LibreOfficeKitKeyEventType; typedef enum { /// A pressed gesture has started. LOK_MOUSEEVENT_MOUSEBUTTONDOWN, /// A pressed gesture has finished. LOK_MOUSEEVENT_MOUSEBUTTONUP, /// A change has happened during a press gesture. LOK_MOUSEEVENT_MOUSEMOVE } LibreOfficeKitMouseEventType; typedef enum { /// The start of selection is to be adjusted. LOK_SETTEXTSELECTION_START, /// The end of selection is to be adjusted. LOK_SETTEXTSELECTION_END, /// Both the start and the end of selection is to be adjusted. LOK_SETTEXTSELECTION_RESET } LibreOfficeKitSetTextSelectionType; typedef enum { /** * A move or a resize action starts. It is assumed that there is a valid * graphic selection (see LOK_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 */ LOK_SETGRAPHICSELECTION_START, /** * A move or resize action stops. It is assumed that this is always used * only after a LOK_SETTEXTSELECTION_START. The supplied coordinates are * the ones where the user released the screen. */ LOK_SETGRAPHICSELECTION_END } LibreOfficeKitSetGraphicSelectionType; #endif // defined LOK_USE_UNSTABLE_API || defined LIBO_INTERNAL_ONLY #ifdef __cplusplus } #endif #endif // INCLUDED_LIBREOFFICEKIT_LIBREOFFICEKITENUMS_H /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ '>feature/gsoc14-draw-text-background-color LibreOffice 核心代码仓库文档基金会
summaryrefslogtreecommitdiff
path: root/cppuhelper/qa
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@collabora.co.uk>2017-12-01 10:55:09 +0100
committerMiklos Vajna <vmiklos@collabora.co.uk>2017-12-01 16:30:25 +0100
commit913fbc822c0f0e285cd0dc3f919a2fb43a94c7ad (patch)
tree626a2f404a77f7903901d2d6b5235df96e1ee82f /cppuhelper/qa
parentab7bdd1f91a7e6e25854601cca712488554ab960 (diff)
EPUB export: add UI to request fixed layout
Sets the EPUBLayoutMethod filter data key at UNO level. Change-Id: Ia07029bd83fec02e98cb6a3cc2bfea2ab742d769 Reviewed-on: https://gerrit.libreoffice.org/45644 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Miklos Vajna <vmiklos@collabora.co.uk>