summaryrefslogtreecommitdiff
path: root/libreofficekit/README
blob: 624d67c1fb9c69d5299ab0002aed9f8f443a9be5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
LibreOfficeKit
**************

LibreOfficeKit can be used for accessing LibreOffice functionality
without LibreOffice, through C/C++, without any need to use UNO.

For now it only offers document conversion (in addition to an experimental
tiled rendering API).

Integrating LOK into other software
-----------------------------------

You will need to integrate shim.c into your program, e.g. as a static library,
in order to be able to use LOK. You will then be able to access LOK via
the functions in LibreOfficeKit.h[xx].

(LibreOfficeKit.hxx is a simple and fully inlined C++ wrapper for the same
functionality as in LibreOfficeKit.h.)

An example program can be seen on:
https://github.com/ojwb/lloconv	

Tiled Rendering
---------------

To use LOK Tiled Rendering you will need the following before the LOK includes:
#define LOK_USE_UNSTABLE_API

Currently only bitmap-buffer rendering is supported, with a 32-bit RGBA
colourspace (further alternatives could feasibly be implemented as needed).
Scanlines are ordered top-down (whereas LibreOffice will internally default
to bottom-up).

LibreOfficeKitGtk
*****************

Currently consists of only a very basic GTK+ document viewer widget.

Currently this simply renders the entire document as one large tile (for
Writer) and/or entire sheet for Calc, which can be somewhat slow with
larger documents.