/usr/include/LibreOfficeKit/LibreOfficeKitGtk.h is in libreofficekit-dev 1:5.1.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | /* -*- 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_LIBREOFFICEKITGTK_H
#define INCLUDED_LIBREOFFICEKIT_LIBREOFFICEKITGTK_H
#include <gtk/gtk.h>
#include <gdk/gdk.h>
#include <LibreOfficeKit/LibreOfficeKit.h>
G_BEGIN_DECLS
#define LOK_TYPE_DOC_VIEW (lok_doc_view_get_type())
#define LOK_DOC_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), LOK_TYPE_DOC_VIEW, LOKDocView))
#define LOK_IS_DOC_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), LOK_TYPE_DOC_VIEW))
#define LOK_DOC_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), LOK_TYPE_DOC_VIEW, LOKDocViewClass))
#define LOK_IS_DOC_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), LOK_TYPE_DOC_VIEW))
#define LOK_DOC_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), LOK_TYPE_DOC_VIEW, LOKDocViewClass))
typedef struct _LOKDocView LOKDocView;
typedef struct _LOKDocViewClass LOKDocViewClass;
typedef struct _LOKDocViewPrivate LOKDocViewPrivate;
struct _LOKDocView
{
GtkDrawingArea aDrawingArea;
};
struct _LOKDocViewClass
{
GtkDrawingAreaClass parent_class;
};
GType lok_doc_view_get_type (void) G_GNUC_CONST;
/**
* lok_doc_view_new:
* @pPath: (nullable): LibreOffice install path. Pass null to set it to default
* path which in most cases would be $libdir/libreoffice/program
* @cancellable: The cancellable object that you can use to cancel this
* operation.
* @error: The error that will be set if the object fails to initialize.
*
* Returns: (transfer none): The #LOKDocView widget instance.
*/
GtkWidget* lok_doc_view_new (const gchar* pPath,
GCancellable *cancellable,
GError **error);
/**
* lok_doc_view_new_from_widget:
* @pDocView: The #LOKDocView instance
*
* Returns: (transfer none): The #LOKDocView widget instance.
*/
GtkWidget* lok_doc_view_new_from_widget (LOKDocView* pDocView);
/**
* lok_doc_view_open_document:
* @pDocView: The #LOKDocView instance
* @pPath: (transfer full): The path of the document that #LOKDocView widget should try to open
* @pRenderingArguments: (nullable): lok::Document::initializeForRendering() arguments.
* @cancellable:
* @callback:
* @userdata:
*
* Returns: %TRUE if the document is loaded succesfully, %FALSE otherwise
*/
void lok_doc_view_open_document (LOKDocView* pDocView,
const gchar* pPath,
const gchar* pRenderingArguments,
GCancellable* cancellable,
GAsyncReadyCallback callback,
gpointer userdata);
/**
* lok_doc_view_open_document_finish:
* @pDocView: The #LOKDocView instance
* @res:
* @error:
*
* Returns: %TRUE if the document is loaded succesfully, %FALSE otherwise
*/
gboolean lok_doc_view_open_document_finish (LOKDocView* pDocView,
GAsyncResult* res,
GError** error);
/**
* lok_doc_view_get_document:
* @pDocView: The #LOKDocView instance
*
* Gets the document the viewer displays.
*
* Returns: The #LibreOfficeKitDocument instance the widget is currently showing
*/
LibreOfficeKitDocument* lok_doc_view_get_document (LOKDocView* pDocView);
/**
* lok_doc_view_set_zoom:
* @pDocView: The #LOKDocView instance
* @fZoom: The new zoom level that pDocView must set it into.
*
* Sets the new zoom level for the widget. Does nothing if fZoom is equal to
* existing zoom level. Values outside the range [0.25, 5.0] are clamped into
* the nearest allowed value in the interval.
*/
void lok_doc_view_set_zoom (LOKDocView* pDocView,
float fZoom);
/**
* lok_doc_view_get_zoom:
* @pDocView: The #LOKDocView instance
*
* Returns: The current zoom factor value in float for pDocView
*/
gfloat lok_doc_view_get_zoom (LOKDocView* pDocView);
/**
* lok_doc_view_get_parts:
* @pDocView: The #LOKDocView instance
*
* Returns: Part refers to either individual sheets in a Calc, or slides in Impress,
* and has no relevance for Writer. Returns -1 if no document is set currently.
*/
gint lok_doc_view_get_parts (LOKDocView* pDocView);
/**
* lok_doc_view_get_part:
* @pDocView: The #LOKDocView instance
*
* Returns: Current part number of the document. Returns -1 if no document is set currently.
*/
gint lok_doc_view_get_part (LOKDocView* pDocView);
/**
* lok_doc_view_set_part:
* @pDocView: The #LOKDocView instance
* @nPart:
*/
void lok_doc_view_set_part (LOKDocView* pDocView,
int nPart);
/**
* lok_doc_view_get_part_name:
* @pDocView: The #LOKDocView instance
* @nPart:
*
* Returns: Get current part name of loaded document. Returns null if no
* document is set, or document has been destroyed using lok_doc_view_destroy_document.
*/
gchar* lok_doc_view_get_part_name (LOKDocView* pDocView,
int nPart);
/**
* lok_doc_view_set_partmode:
* @pDocView: The #LOKDocView instance
* @nPartMode:
*/
void lok_doc_view_set_partmode (LOKDocView* pDocView,
int nPartMode);
/**
* lok_doc_view_reset_view:
* @pDocView: The #LOKDocView instance
*/
void lok_doc_view_reset_view (LOKDocView* pDocView);
/**
* lok_doc_view_set_edit:
* @pDocView: The #LOKDocView instance
* @bEdit: %TRUE if the pDocView should go in edit mode, %FALSE otherwise
*
* Sets if the viewer is actually an editor or not.
*/
void lok_doc_view_set_edit (LOKDocView* pDocView,
gboolean bEdit);
/**
* lok_doc_view_get_edit:
* @pDocView: The #LOKDocView instance
*
* Gets if the viewer is actually an editor or not.
*
* Returns: %TRUE if the given pDocView is in edit mode.
*/
gboolean lok_doc_view_get_edit (LOKDocView* pDocView);
/**
* lok_doc_view_post_command:
* @pDocView: the #LOKDocView instance
* @pCommand: the command to issue to LO core
* @pArguments: the arguments to the given command
* @bNotifyWhenFinished: normally false, but it may be useful for eg. .uno:Save
*
* Posts the .uno: command to the LibreOfficeKit.
*/
void lok_doc_view_post_command (LOKDocView* pDocView,
const gchar* pCommand,
const gchar* pArguments,
gboolean bNotifyWhenFinished);
/**
* lok_doc_view_find_next:
* @pDocView: The #LOKDocView instance
* @pText: text to search for
* @bHighlightAll: Whether all the matches should be highlighted or not
*
* Highlights the next matching text in the view. `search-not-found` signal will
* be emitted when no search is found
*/
void lok_doc_view_find_next (LOKDocView* pDocView,
const gchar* pText,
gboolean bHighlightAll);
/**
* lok_doc_view_find_prev:
* @pDocView: The #LOKDocView instance
* @pText: text to search for
* @bHighlightAll: Whether all the matches should be highlighted or not
*
* Highlights the previous matching text in the view. `search-not-found` signal
* will be emitted when no search is found
*/
void lok_doc_view_find_prev (LOKDocView* pDocView,
const gchar* pText,
gboolean bHighlightAll);
/**
* lok_doc_view_highlight_all:
* @pDocView: The #LOKDocView instance
* @pText: text to search for
*
* Highlights all matching texts in the view. `search-not-found` signal
* will be emitted when no search is found
*/
void lok_doc_view_highlight_all (LOKDocView* pDocView,
const gchar* pText);
/**
* lok_doc_view_copy_selection:
* @pDocView: The #LOKDocView instance
* @pMimeType: suggests the return format, for example text/plain;charset=utf-8
* @pUsedMimeType: (out): output parameter to inform about the determined format
* (suggested or plain text).
*
* Returns: Selected text. The caller must free the returned buffer after
* use. Returns null if no document is set.
*/
gchar* lok_doc_view_copy_selection (LOKDocView* pDocView,
const gchar* pMimeType,
gchar** pUsedMimeType);
/**
* lok_doc_view_paste:
* @pDocView: The #LOKDocView instance
* @pMimeType: format of pData, for example text/plain;charset=utf-8
* @pData: the data to be pasted
* @nSize: length of data to be pasted
*
* Pastes the content at the current cursor position
*
* Returns: if pData was pasted successfully.
*/
gboolean lok_doc_view_paste (LOKDocView* pDocView,
const gchar* pMimeType,
const gchar* pData,
gsize nSize);
/**
* lok_doc_view_set_document_password:
* @pDocView: The #LOKDocView instance
* @pUrl: the URL of the document to set password for, as sent with signal `password-required`
* @pPassword: (nullable): the password, NULL for no password
*
* Set the password for password protected documents
*/
void lok_doc_view_set_document_password (LOKDocView* pDocView,
const gchar* pURL,
const gchar* pPassword);
/**
* lok_doc_view_pixel_to_twip:
* @pDocView: The #LOKDocView instance
* @fInput: The value in pixels to convert to twips
*
* Converts the value in pixels to twips according to zoom level.
*
* Returns: The corresponding value in twips
*/
gfloat lok_doc_view_pixel_to_twip (LOKDocView* pDocView,
float fInput);
/**
* lok_doc_view_twip_to_pixel:
* @pDocView: The #LOKDocView instance
* @fInput: The value in twips to convert to pixels
*
* Converts the value in twips to pixels according to zoom level.
*
* Returns: The corresponding value in pixels
*/
gfloat lok_doc_view_twip_to_pixel (LOKDocView* pDocView,
float fInput);
G_END_DECLS
#endif // INCLUDED_LIBREOFFICEKIT_LIBREOFFICEKITGTK_H
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|