LOKDocView.View¶

Subclasses:: None

Methods¶

Inherited:: Gtk.DrawingArea (1), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gio.Initable (2)
Structs:: Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` (pPath, cancellable)
class	`new_from_user_profile` (pPath, pUserProfile, cancellable)
	`copy_selection` (pMimeType)
	`find_next` (pText, bHighlightAll)
	`find_prev` (pText, bHighlightAll)
	`get_command_values` (pCommand)
	`get_edit` ()
	`get_part` ()
	`get_part_name` (nPart)
	`get_parts` ()
	`get_version_info` ()
	`get_zoom` ()
	`highlight_all` (pText)
	`new_from_widget` (pRenderingArguments)
	`open_document` (pPath, pRenderingArguments, cancellable, callback, *userdata)
	`open_document_finish` (res)
	`paste` (pMimeType, pData, nSize)
	`pixel_to_twip` (fInput)
	`post_command` (pCommand, pArguments, bNotifyWhenFinished)
	`reset_view` ()
	`send_content_control_event` (pArguments)
	`set_document_password` (pURL, pPassword)
	`set_edit` (bEdit)
	`set_part` (nPart)
	`set_partmode` (nPartMode)
	`set_visible_area` (pVisibleArea)
	`set_zoom` (fZoom)
	`twip_to_pixel` (fInput)

Virtual Methods¶

Inherited:: Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gio.Initable (1)

Properties¶

Inherited:: Gtk.Widget (39)

Name	Type	Flags	Short Description
`can-zoom-in`	`bool`	r	Whether the view can be zoomed in further
`can-zoom-out`	`bool`	r	Whether the view can be zoomed out further
`doc-height`		r/w	Height of the document in twips
`doc-password`	`bool`	r/w	Whether client supports providing document passwords
`doc-password-to-modify`	`bool`	r/w	Whether the client supports providing passwords to edit documents
`doc-width`		r/w	Width of the document in twips
`docpath`	`str`	r/w	The URI of the document to open
`docpointer`	`int`	r/w	A LibreOfficeKitDocument* from documentLoad()
`editable`	`bool`	r/w	Whether the content is in edit mode or not
`is-initialized`	`bool`	r	Whether the view has completely initialized
`is-loading`	`bool`	r	Whether the view is loading a document
`load-progress`	`float`	r	Shows the progress of the document load operation
`lopath`	`str`	r/w/co	LibreOffice Install Path
`lopointer`	`int`	r/w/co	A LibreOfficeKit* from lok_init()
`tiled-annotations`	`bool`	r/w	Whether the client wants in tile comment rendering
`unipoll`	`bool`	r/w/co	Whether we use a custom unified polling loop
`userprofileurl`	`str`	r/w/co	LibreOffice user profile path
`zoom-level`	`float`	r/w	The current zoom level of the content

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Widget (69), GObject.Object (1)

Name	Short Description
`address-changed`
`command-changed`
`command-result`
`comment`
`content-control`
`cursor-changed`
`edit-changed`
`formula-changed`
`hyperlink-clicked`
`invalidate-header`	The column/row header is no more valid because of a column/row insertion or a similar event.
`load-changed`
`part-changed`
`password-required`	Password must be provided by calling `LOKDocView.View.set_document_password` function with pUrl as provided by the callback.
`ruler`	The payload format is: { “margin1”: “…”, “margin2”: “…”, “leftOffset”: “…”, “pageOffset”: “…”, “pageWidth”: “…”, “unit”: “…” }
`search-not-found`
`search-result-count`
`size-changed`
`text-selection`
`window`	This signal emits information about external windows like dialogs, autopopups for now.

Fields¶

Inherited:: Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
aDrawingArea	`Gtk.DrawingArea`	r

Class Details¶

class LOKDocView.View(**kwargs)¶

Bases:: Gtk.DrawingArea, Gio.Initable
Abstract:: No
Structure:: LOKDocView.ViewClass

classmethod new(pPath, cancellable)¶

Parameters:

pPath (str or None) – LibreOffice install path. Pass null to set it to default path which in most cases would be $libdir/libreoffice/program
cancellable (Gio.Cancellable or None) – The cancellable object that you can use to cancel this operation.

Raises:

GLib.Error

Returns:

The LOKDocView.View widget instance.

Return type:

Gtk.Widget

classmethod new_from_user_profile(pPath, pUserProfile, cancellable)¶

Parameters:

pPath (str or None) – LibreOffice install path. Pass null to set it to default path which in most cases would be $libdir/libreoffice/program
pUserProfile (str or None) – User profile URL. Must be either a file URL or a special vnd.sun.star.pathname URL. Pass non-null to be able to use this widget and LibreOffice itself in parallel.
cancellable (Gio.Cancellable or None) – The cancellable object that you can use to cancel this operation.

Raises:

GLib.Error

Returns:

The LOKDocView.View widget instance.

Return type:

Gtk.Widget

copy_selection(pMimeType)¶

Parameters:

pMimeType (str) – suggests the return format, for example text/plain;charset=utf-8

Returns:

Selected text. The caller must free the returned buffer after use. Returns null if no document is set.

pUsedMimeType:: output parameter to inform about the determined format (suggested or plain text).

Return type:

(str, pUsedMimeType: str)

find_next(pText, bHighlightAll)¶

Parameters:

pText (str) – text to search for
bHighlightAll (bool) – 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

find_prev(pText, bHighlightAll)¶

Parameters:

pText (str) – text to search for
bHighlightAll (bool) – 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

get_command_values(pCommand)¶

Parameters:: pCommand (str) – the command to issue to LO core
Returns:: A json mapping of the possible values for the given command
Return type:: str

Get a json mapping of the possible values for the given command. In the form of: {commandName: unoCmd, commandValues: {possible_values}}

get_edit()¶

Returns:: True if the given pDocView is in edit mode.
Return type:: bool

Gets if the viewer is actually an editor or not.

get_part()¶

Returns:: Current part number of the document. Returns -1 if no document is set currently.
Return type:: int

get_part_name(nPart)¶

Parameters:: nPart (int) –
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.
Return type:: str

get_parts()¶

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.
Return type:: int

get_version_info()¶

Returns:

JSON string containing version information in format: {ProductName: <>, ProductVersion: <>, ProductExtension: <>, BuildId: <>}

Eg: {“ProductName”: “LibreOffice”, “ProductVersion”: “5.3”, “ProductExtension”: “.0.0.alpha0”, “BuildId”: “<full 40 str git hash>”}

Return type:

str

Get version information of the LOKit process

get_zoom()¶

Returns:: The current zoom factor value in float for pDocView
Return type:: float

highlight_all(pText)¶

Parameters:: pText (str) – text to search for

Highlights all matching texts in the view. search-not-found signal will be emitted when no search is found

new_from_widget(pRenderingArguments)¶

Parameters:: pRenderingArguments (str or None) – lok::Document:py:func:::initializeForRendering<LOKDocView.View.signals.initializeForRendering>() arguments.
Returns:: The LOKDocView.View widget instance.
Return type:: Gtk.Widget

open_document(pPath, pRenderingArguments, cancellable, callback, *userdata)¶

Parameters:

pPath (str) – The path of the document that LOKDocView.View widget should try to open
pRenderingArguments (str or None) – lok::Document:py:func:::initializeForRendering<LOKDocView.View.signals.initializeForRendering>() arguments.
cancellable (Gio.Cancellable or None) –
callback (Gio.AsyncReadyCallback or None) –
userdata (object or None) –

open_document_finish(res)¶

Parameters:: res (Gio.AsyncResult) –
Raises:: GLib.Error
Returns:: True if the document is loaded successfully, False otherwise
Return type:: bool

paste(pMimeType, pData, nSize)¶

Parameters:

pMimeType (str) – format of pData, for example text/plain;charset=utf-8
pData (str) – the data to be pasted
nSize (int) – length of data to be pasted

Returns:

if pData was pasted successfully.

Return type:

bool

Pastes the content at the current cursor position

pixel_to_twip(fInput)¶

Parameters:: fInput (float) – The value in pixels to convert to twips
Returns:: The corresponding value in twips
Return type:: float

Converts the value in pixels to twips according to zoom level.

post_command(pCommand, pArguments, bNotifyWhenFinished)¶

Parameters:

pCommand (str) – the command to issue to LO core
pArguments (str) – the arguments to the given command
bNotifyWhenFinished (bool) – normally false, but it may be useful for eg. .uno:Save

Posts the .uno: command to the LibreOfficeKit.

reset_view()¶

send_content_control_event(pArguments)¶

Parameters:: pArguments (str or None) – see lok::Document:py:func:::sendContentControlEvent<LOKDocView.View.signals.sendContentControlEvent>() for the details.

set_document_password(pURL, pPassword)¶

Parameters:

pURL (str) – the URL of the document to set password for, as sent with signal password-required
pPassword (str or None) – the password, None for no password

Set the password for password protected documents

set_edit(bEdit)¶

Parameters:: bEdit (bool) – True if the pDocView should go in edit mode, False otherwise

Sets if the viewer is actually an editor or not.

set_part(nPart)¶

Parameters:: nPart (int) –

set_partmode(nPartMode)¶

Parameters:: nPartMode (int) –

set_visible_area(pVisibleArea)¶

Parameters:: pVisibleArea (Gdk.Rectangle) – The new visible area of pDocView in twips.

Sets the new visible area of the widget. This helps e.g. the page down key to jump the correct length, which depends on the amount of visible height of the document.

set_zoom(fZoom)¶

Parameters:: fZoom (float) – 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.

twip_to_pixel(fInput)¶

Parameters:: fInput (float) – The value in twips to convert to pixels
Returns:: The corresponding value in pixels
Return type:: float

Converts the value in twips to pixels according to zoom level.

Signal Details¶

LOKDocView.View.signals.address_changed(view, aCommand)¶

Signal Name:

address-changed

Flags:

LOKDocView.View¶

Methods¶

Virtual Methods¶

Properties¶

Style Properties¶

Signals¶

Fields¶

Class Details¶

Signal Details¶

Property Details¶