#include <ITiledRenderable.hxx>

Public Types
typedef std::map< OUString, OUString >	StringMap

Public Member Functions
virtual	~ITiledRenderable ()

virtual void	paintTile (VirtualDevice &rDevice, int nOutputWidth, int nOutputHeight, int nTilePosX, int nTilePosY, tools::Long nTileWidth, tools::Long nTileHeight)=0
	Paint a tile to a given VirtualDevice. More...

virtual Size	getDocumentSize ()=0
	Get the document size in twips. More...

virtual void	setPart (int, bool=true)
	Set the document "part", i.e. More...

virtual int	getParts ()
	Get the number of parts – see setPart for further details. More...

virtual int	getPart ()
	Get the currently displayed/selected part – see setPart for further details. More...

virtual OUString	getPartName (int)
	Get the name of the currently displayed part, i.e. More...

virtual VclPtr< vcl::Window >	getDocWindow ()=0
	Get the vcl::Window for the document being edited. More...

virtual OUString	getPartHash (int nPart)=0
	Get the hash of the currently displayed part, i.e. More...

virtual void	setPartMode (int)

virtual void	initializeForTiledRendering (const css::uno::Sequence< css::beans::PropertyValue > &rArguments)=0
	Setup various document properties that are needed for the document to be renderable via tiled rendering. More...

virtual void	postKeyEvent (int nType, int nCharCode, int nKeyCode)=0
	Posts a keyboard event on the document. More...

virtual void	postMouseEvent (int nType, int nX, int nY, int nCount, int nButtons, int nModifier)=0
	Posts a mouse event on the document. More...

virtual void	setTextSelection (int nType, int nX, int nY)=0
	Sets the start or end of a text selection. More...

virtual css::uno::Reference< css::datatransfer::XTransferable >	getSelection ()=0
	Gets the selection as a transferable for later processing. More...

virtual void	setGraphicSelection (int nType, int nX, int nY)=0
	Adjusts the graphic selection. More...

virtual void	resetSelection ()=0

virtual OUString	getPartPageRectangles ()

virtual void	getRowColumnHeaders (const tools::Rectangle &, tools::JsonWriter &)
	Get position and content of row/column headers of Calc documents. More...

virtual OString	getSheetGeometryData (bool, bool, bool, bool, bool, bool)
	Generates a serialization of the active (Calc document) sheet's geometry data. More...

virtual void	getCellCursor (tools::JsonWriter &)
	Get position and size of cell cursor in Calc - as JSON in the current' views' co-ordinate system. More...

virtual PointerStyle	getPointer ()=0

virtual void	setClipboard (const css::uno::Reference< css::datatransfer::clipboard::XClipboard > &xClipboard)=0
	Sets the clipboard of the component. More...

virtual bool	isMimeTypeSupported ()=0
	If the current contents of the clipboard is something we can paste. More...

virtual void	setClientZoom (int, int, int, int)
	Save the client's view so that we can compute the right zoom level for the mouse events. More...

virtual void	setClientVisibleArea (const tools::Rectangle &)

virtual void	setOutlineState (bool, int, int, bool)
	Show/Hide a single row/column header outline for Calc documents. More...

virtual void	getTrackedChanges (tools::JsonWriter &)
	Implementation for lok::Document::getCommandValues(".uno:AcceptTrackedChanges") when there is no matching UNO API. More...

virtual void	getTrackedChangeAuthors (tools::JsonWriter &)
	Implementation for lok::Document::getCommandValues(".uno:TrackedChangeAuthors"). More...

virtual void	getPostIts (tools::JsonWriter &)
	Implementation for lok::Document::getCommandValues(".uno:ViewAnnotations");. More...

virtual void	getPostItsPos (tools::JsonWriter &)
	Implementation for lok::Document::getCommandValues(".uno:ViewAnnotationsPosition");. More...

virtual void	getRulerState (tools::JsonWriter &)
	Implementation for lok::Document::getCommandValues(".uno:RulerState");. More...

virtual OUString	getPartInfo (int)

virtual void	selectPart (int, int)
	Select/Unselect a document "part", i.e. More...

virtual void	moveSelectedParts (int, bool)
	Move selected pages/slides to a new position. More...

virtual void	completeFunction (const OUString &)

virtual bool	isDisposed () const
	It can happen that the underlying implementation is being disposed, but somebody is trying to access the data... More...

virtual void	executeFromFieldEvent (const StringMap &)
	Execute a form field event in the document. More...

virtual std::vector< basegfx::B2DRange >	getSearchResultRectangles (const char *)
	Returns the rectangles of the input search result JSON. More...

virtual void	executeContentControlEvent (const StringMap &)
	Execute a content control event in the document. More...

Detailed Description

Definition at line 45 of file ITiledRenderable.hxx.

Member Typedef Documentation

◆ StringMap

typedef std::map<OUString, OUString> vcl::ITiledRenderable::StringMap

Definition at line 49 of file ITiledRenderable.hxx.

Constructor & Destructor Documentation

◆ ~ITiledRenderable()

vcl::ITiledRenderable::~ITiledRenderable ( )

virtual

Definition at line 74 of file ITiledRenderable.cxx.

Member Function Documentation

◆ completeFunction()

virtual void vcl::ITiledRenderable::completeFunction ( const OUString & )

inlinevirtual

See also: lok::Document::completeFunction().

Definition at line 311 of file ITiledRenderable.hxx.

◆ executeContentControlEvent()

virtual void vcl::ITiledRenderable::executeContentControlEvent ( const StringMap & )

inlinevirtual

Execute a content control event in the document.

E.g. select a list item from a drop down content control.

Definition at line 344 of file ITiledRenderable.hxx.

◆ executeFromFieldEvent()

virtual void vcl::ITiledRenderable::executeFromFieldEvent ( const StringMap & )

inlinevirtual

Execute a form field event in the document.

E.g. select an item from a drop down field's list.

Definition at line 328 of file ITiledRenderable.hxx.

◆ getCellCursor()

virtual void vcl::ITiledRenderable::getCellCursor ( tools::JsonWriter & )

inlinevirtual

Get position and size of cell cursor in Calc - as JSON in the current' views' co-ordinate system.

(This could maybe also be used for tables in Writer/Impress in future?)

Definition at line 212 of file ITiledRenderable.hxx.

◆ getDocumentSize()

virtual Size vcl::ITiledRenderable::getDocumentSize ( )

pure virtual

Get the document size in twips.

◆ getDocWindow()

virtual VclPtr< vcl::Window > vcl::ITiledRenderable::getDocWindow ( )

pure virtual

Get the vcl::Window for the document being edited.

◆ getPart()

virtual int vcl::ITiledRenderable::getPart ( )

inlinevirtual

Get the currently displayed/selected part – see setPart for further details.

Definition at line 92 of file ITiledRenderable.hxx.

◆ getPartHash()

virtual OUString vcl::ITiledRenderable::getPartHash ( int nPart )

pure virtual

Get the hash of the currently displayed part, i.e.

sheet in a spreadsheet or slide in a presentation.

◆ getPartInfo()

virtual OUString vcl::ITiledRenderable::getPartInfo ( int )

inlinevirtual

Definition at line 291 of file ITiledRenderable.hxx.

◆ getPartName()

virtual OUString vcl::ITiledRenderable::getPartName ( int )

inlinevirtual

Get the name of the currently displayed part, i.e.

sheet in a spreadsheet or slide in a presentation.

Definition at line 101 of file ITiledRenderable.hxx.

◆ getPartPageRectangles()

virtual OUString vcl::ITiledRenderable::getPartPageRectangles ( )

inlinevirtual

See also: lok::Document::getPartPageRectangles().

Definition at line 167 of file ITiledRenderable.hxx.

◆ getParts()

virtual int vcl::ITiledRenderable::getParts ( )

inlinevirtual

Get the number of parts – see setPart for further details.

Definition at line 83 of file ITiledRenderable.hxx.

◆ getPointer()

virtual PointerStyle vcl::ITiledRenderable::getPointer ( )

pure virtual

◆ getPostIts()

virtual void vcl::ITiledRenderable::getPostIts ( tools::JsonWriter & )

inlinevirtual

Implementation for lok::Document::getCommandValues(".uno:ViewAnnotations");.

Definition at line 271 of file ITiledRenderable.hxx.

◆ getPostItsPos()

virtual void vcl::ITiledRenderable::getPostItsPos ( tools::JsonWriter & )

inlinevirtual

Implementation for lok::Document::getCommandValues(".uno:ViewAnnotationsPosition");.

Definition at line 277 of file ITiledRenderable.hxx.

◆ getRowColumnHeaders()

virtual void vcl::ITiledRenderable::getRowColumnHeaders	(	const tools::Rectangle &	,
		tools::JsonWriter &
	)

inlinevirtual

Get position and content of row/column headers of Calc documents.

Parameters

rRectangle - if not empty, then limit the output only to the area of this rectangle

Returns: a JSON describing position/content of rows/columns

Definition at line 178 of file ITiledRenderable.hxx.

◆ getRulerState()

virtual void vcl::ITiledRenderable::getRulerState ( tools::JsonWriter & )

inlinevirtual

Implementation for lok::Document::getCommandValues(".uno:RulerState");.

Definition at line 283 of file ITiledRenderable.hxx.

◆ getSearchResultRectangles()

virtual std::vector< basegfx::B2DRange > vcl::ITiledRenderable::getSearchResultRectangles ( const char * )

inlinevirtual

Returns the rectangles of the input search result JSON.

Definition at line 335 of file ITiledRenderable.hxx.

◆ getSelection()

virtual css::uno::Reference< css::datatransfer::XTransferable > vcl::ITiledRenderable::getSelection ( )

pure virtual

Gets the selection as a transferable for later processing.

◆ getSheetGeometryData()

virtual OString vcl::ITiledRenderable::getSheetGeometryData	(	bool	,
		bool	,
		bool	,
		bool	,
		bool	,
		bool
	)

inlinevirtual

Generates a serialization of the active (Calc document) sheet's geometry data.

Parameters

bColumns - if true, the column widths/hidden/filtered/groups data are included depending on the settings of the flags bSizes, bHidden, bFiltered and bGroups.

bRows - if true, the row heights/hidden/filtered/groups data are included depending on the settings of the flags bSizes, bHidden, bFiltered and bGroups. @bSizes - if true, the column-widths and/or row-heights data (represented as a list of spans) are included depending on the settings of the flags bColumns and bRows. @bHidden - if true, the hidden columns and/or rows data (represented as a list of spans) are included depending on the settings of the flags bColumns and bRows. @bFiltered - if true, the filtered columns and/or rows data (represented as a list of spans) are included depending on the settings of the flags bColumns and bRows. @bGroups - if true, the column grouping and/or row grouping data are included depending on the settings of the flags bColumns and bRows.

Returns: serialization of the active sheet's geometry data as OString.

Definition at line 201 of file ITiledRenderable.hxx.

◆ getTrackedChangeAuthors()

virtual void vcl::ITiledRenderable::getTrackedChangeAuthors ( tools::JsonWriter & )

inlinevirtual

Implementation for lok::Document::getCommandValues(".uno:TrackedChangeAuthors").

Definition at line 265 of file ITiledRenderable.hxx.

◆ getTrackedChanges()

virtual void vcl::ITiledRenderable::getTrackedChanges ( tools::JsonWriter & )

inlinevirtual

Implementation for lok::Document::getCommandValues(".uno:AcceptTrackedChanges") when there is no matching UNO API.

Definition at line 259 of file ITiledRenderable.hxx.

◆ initializeForTiledRendering()

virtual void vcl::ITiledRenderable::initializeForTiledRendering ( const css::uno::Sequence< css::beans::PropertyValue > & rArguments )

pure virtual

Setup various document properties that are needed for the document to be renderable via tiled rendering.

◆ isDisposed()

virtual bool vcl::ITiledRenderable::isDisposed ( ) const

inlinevirtual

It can happen that the underlying implementation is being disposed, but somebody is trying to access the data...

Definition at line 319 of file ITiledRenderable.hxx.

◆ isMimeTypeSupported()

virtual bool vcl::ITiledRenderable::isMimeTypeSupported ( )

pure virtual

If the current contents of the clipboard is something we can paste.

◆ moveSelectedParts()

virtual void vcl::ITiledRenderable::moveSelectedParts	(	int	,
		bool
	)

inlinevirtual

Move selected pages/slides to a new position.

nPosition: the new position to move to. bDuplicate: to copy (true), or to move (false).

Definition at line 308 of file ITiledRenderable.hxx.

◆ paintTile()

virtual void vcl::ITiledRenderable::paintTile	(	VirtualDevice &	rDevice,
		int	nOutputWidth,
		int	nOutputHeight,
		int	nTilePosX,
		int	nTilePosY,
		tools::Long	nTileWidth,
		tools::Long	nTileHeight
	)

pure virtual

Paint a tile to a given VirtualDevice.

Output parameters are measured in pixels, tile parameters are in twips.

◆ postKeyEvent()

virtual void vcl::ITiledRenderable::postKeyEvent	(	int	nType,
		int	nCharCode,
		int	nKeyCode
	)

pure virtual

Posts a keyboard event on the document.

See also: lok::Document::postKeyEvent().

◆ postMouseEvent()

virtual void vcl::ITiledRenderable::postMouseEvent	(	int	nType,
		int	nX,
		int	nY,
		int	nCount,
		int	nButtons,
		int	nModifier
	)

pure virtual

Posts a mouse event on the document.

See also: lok::Document::postMouseEvent().

◆ resetSelection()

virtual void vcl::ITiledRenderable::resetSelection ( )

pure virtual

See also: lok::Document::resetSelection().

◆ selectPart()

virtual void vcl::ITiledRenderable::selectPart	(	int	,
		int
	)

inlinevirtual

Select/Unselect a document "part", i.e.

slide for a slideshow, and tab for a spreadsheet(?). nSelect: 0 to deselect, 1 to select, and 2 to toggle.

Definition at line 301 of file ITiledRenderable.hxx.

◆ setClientVisibleArea()

virtual void vcl::ITiledRenderable::setClientVisibleArea ( const tools::Rectangle & )

inlinevirtual

See also: lok::Document::setClientVisibleArea().

Definition at line 239 of file ITiledRenderable.hxx.

◆ setClientZoom()

virtual void vcl::ITiledRenderable::setClientZoom	(	int	,
		int	,
		int	,
		int
	)

inlinevirtual

Save the client's view so that we can compute the right zoom level for the mouse events.

Parameters

nTilePixelWidth	- tile width in pixels
nTilePixelHeight	- tile height in pixels
nTileTwipWidth	- tile width in twips
nTileTwipHeight	- tile height in twips

Definition at line 232 of file ITiledRenderable.hxx.

◆ setClipboard()

virtual void vcl::ITiledRenderable::setClipboard ( const css::uno::Reference< css::datatransfer::clipboard::XClipboard > & xClipboard )

pure virtual

Sets the clipboard of the component.

◆ setGraphicSelection()

virtual void vcl::ITiledRenderable::setGraphicSelection	(	int	nType,
		int	nX,
		int	nY
	)

pure virtual

Adjusts the graphic selection.

See also: lok::Document::setGraphicSelection().

◆ setOutlineState()

virtual void vcl::ITiledRenderable::setOutlineState	(	bool	,
		int	,
		int	,
		bool
	)

inlinevirtual

Show/Hide a single row/column header outline for Calc documents.

Parameters

bColumn	- if we are dealing with a column or row group
nLevel	- the level to which the group belongs
nIndex	- the group entry index
bHidden	- the new group state (collapsed/expanded)

Definition at line 251 of file ITiledRenderable.hxx.

◆ setPart()

virtual void vcl::ITiledRenderable::setPart	(	int	,
		bool	= `true`
	)

inlinevirtual

Set the document "part", i.e.

slide for a slideshow, and tab for a spreadsheet. bool bAllowChangeFocus - used to not disturb other users while editing when setPart is used for tile rendering only

Definition at line 78 of file ITiledRenderable.hxx.

◆ setPartMode()

virtual void vcl::ITiledRenderable::setPartMode ( int )

inlinevirtual

See also: lok::Document::setPartMode().

Definition at line 118 of file ITiledRenderable.hxx.

◆ setTextSelection()

virtual void vcl::ITiledRenderable::setTextSelection	(	int	nType,
		int	nX,
		int	nY
	)

pure virtual

Sets the start or end of a text selection.

See also: lok::Document::setTextSelection().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ StringMap

Constructor & Destructor Documentation

◆ ~ITiledRenderable()

Member Function Documentation

◆ completeFunction()

◆ executeContentControlEvent()

◆ executeFromFieldEvent()

◆ getCellCursor()

◆ getDocumentSize()

◆ getDocWindow()

◆ getPart()

◆ getPartHash()

◆ getPartInfo()

◆ getPartName()

◆ getPartPageRectangles()

◆ getParts()

◆ getPointer()

◆ getPostIts()

◆ getPostItsPos()

◆ getRowColumnHeaders()

◆ getRulerState()

◆ getSearchResultRectangles()

◆ getSelection()

◆ getSheetGeometryData()

◆ getTrackedChangeAuthors()

◆ getTrackedChanges()

◆ initializeForTiledRendering()

◆ isDisposed()

◆ isMimeTypeSupported()

◆ moveSelectedParts()

◆ paintTile()

◆ postKeyEvent()

◆ postMouseEvent()

◆ resetSelection()

◆ selectPart()

◆ setClientVisibleArea()

◆ setClientZoom()

◆ setClipboard()

◆ setGraphicSelection()

◆ setOutlineState()

◆ setPart()

◆ setPartMode()

◆ setTextSelection()