LibreOffice Module vcl (master)  1
Public Member Functions | Protected Attributes | List of all members
vcl::ITiledRenderable Class Referenceabstract

#include <ITiledRenderable.hxx>

Public Member Functions

virtual ~ITiledRenderable ()
 
virtual void paintTile (VirtualDevice &rDevice, int nOutputWidth, int nOutputHeight, int nTilePosX, int nTilePosY, long nTileWidth, 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)
 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::WindowgetDocWindow ()=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 OUString getRowColumnHeaders (const tools::Rectangle &)
 Get position and content of row/column headers of Calc documents. More...
 
virtual OString getCellCursor (int, int, long, long)
 Get position and size of cell cursor in Calc. 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 OUString getTrackedChanges ()
 Implementation for lok::Document::getCommandValues(".uno:AcceptTrackedChanges") when there is no matching UNO API. More...
 
virtual OUString getTrackedChangeAuthors ()
 Implementation for lok::Document::getCommandValues(".uno:TrackedChangeAuthors"). More...
 
virtual OUString getPostIts ()
 Implementation for lok::Document::getCommandValues(".uno:ViewAnnotations");. More...
 
virtual OUString getPostItsPos ()
 Implementation for lok::Document::getCommandValues(".uno:ViewAnnotationsPosition");. More...
 
virtual OUString getRulerState ()
 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...
 

Protected Attributes

int mnTilePixelWidth
 
int mnTilePixelHeight
 
int mnTileTwipWidth
 
int mnTileTwipHeight
 

Detailed Description

Definition at line 44 of file ITiledRenderable.hxx.

Constructor & Destructor Documentation

vcl::ITiledRenderable::~ITiledRenderable ( )
virtual

Definition at line 75 of file ITiledRenderable.cxx.

Member Function Documentation

virtual OString vcl::ITiledRenderable::getCellCursor ( int  ,
int  ,
long  ,
long   
)
inlinevirtual

Get position and size of cell cursor in Calc.

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

Definition at line 185 of file ITiledRenderable.hxx.

virtual Size vcl::ITiledRenderable::getDocumentSize ( )
pure virtual

Get the document size in twips.

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

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

virtual int vcl::ITiledRenderable::getPart ( )
inlinevirtual

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

Definition at line 90 of file ITiledRenderable.hxx.

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.

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

Definition at line 273 of file ITiledRenderable.hxx.

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 99 of file ITiledRenderable.hxx.

virtual OUString vcl::ITiledRenderable::getPartPageRectangles ( )
inlinevirtual
See also
lok::Document::getPartPageRectangles().

Definition at line 165 of file ITiledRenderable.hxx.

virtual int vcl::ITiledRenderable::getParts ( )
inlinevirtual

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

Definition at line 81 of file ITiledRenderable.hxx.

virtual PointerStyle vcl::ITiledRenderable::getPointer ( )
pure virtual
virtual OUString vcl::ITiledRenderable::getPostIts ( )
inlinevirtual

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

Definition at line 250 of file ITiledRenderable.hxx.

virtual OUString vcl::ITiledRenderable::getPostItsPos ( )
inlinevirtual

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

Definition at line 257 of file ITiledRenderable.hxx.

virtual OUString vcl::ITiledRenderable::getRowColumnHeaders ( const tools::Rectangle )
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 176 of file ITiledRenderable.hxx.

virtual OUString vcl::ITiledRenderable::getRulerState ( )
inlinevirtual

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

Definition at line 264 of file ITiledRenderable.hxx.

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

Gets the selection as a transferable for later processing.

virtual OUString vcl::ITiledRenderable::getTrackedChangeAuthors ( )
inlinevirtual

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

Definition at line 243 of file ITiledRenderable.hxx.

virtual OUString vcl::ITiledRenderable::getTrackedChanges ( )
inlinevirtual

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

Definition at line 236 of file ITiledRenderable.hxx.

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.

virtual bool vcl::ITiledRenderable::isMimeTypeSupported ( )
pure virtual

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

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 290 of file ITiledRenderable.hxx.

virtual void vcl::ITiledRenderable::paintTile ( VirtualDevice rDevice,
int  nOutputWidth,
int  nOutputHeight,
int  nTilePosX,
int  nTilePosY,
long  nTileWidth,
long  nTileHeight 
)
pure virtual

Paint a tile to a given VirtualDevice.

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

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().
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().
virtual void vcl::ITiledRenderable::resetSelection ( )
pure virtual
See also
lok::Document::resetSelection().
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 283 of file ITiledRenderable.hxx.

virtual void vcl::ITiledRenderable::setClientVisibleArea ( const tools::Rectangle )
inlinevirtual
See also
lok::Document::setClientVisibleArea().

Definition at line 216 of file ITiledRenderable.hxx.

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 209 of file ITiledRenderable.hxx.

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

Sets the clipboard of the component.

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

Adjusts the graphic selection.

See also
lok::Document::setGraphicSelection().
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 228 of file ITiledRenderable.hxx.

virtual void vcl::ITiledRenderable::setPart ( int  )
inlinevirtual

Set the document "part", i.e.

slide for a slideshow, and tab for a spreadsheet.

Definition at line 76 of file ITiledRenderable.hxx.

virtual void vcl::ITiledRenderable::setPartMode ( int  )
inlinevirtual
See also
lok::Document::setPartMode().

Definition at line 116 of file ITiledRenderable.hxx.

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().

Member Data Documentation

int vcl::ITiledRenderable::mnTilePixelHeight
protected

Definition at line 47 of file ITiledRenderable.hxx.

int vcl::ITiledRenderable::mnTilePixelWidth
protected

Definition at line 47 of file ITiledRenderable.hxx.

int vcl::ITiledRenderable::mnTileTwipHeight
protected

Definition at line 48 of file ITiledRenderable.hxx.

int vcl::ITiledRenderable::mnTileTwipWidth
protected

Definition at line 48 of file ITiledRenderable.hxx.


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