LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XViewDataSupplier Interface Referencepublished

gives access to some properties describing all open views to a document More...

import"XViewDataSupplier.idl";

Inheritance diagram for XViewDataSupplier:
XInterface OfficeDocument XReportDefinition GenericDrawingDocument OfficeDatabaseDocument SpreadsheetDocument GenericTextDocument ReportDefinition DrawingDocument PresentationDocument GlobalDocument TextDocument WebDocument

Public Member Functions

::com::sun::star::container::XIndexAccess getViewData ()
 retrieve information about currently opened view to restore it later More...
 
void setViewData ([in] com::sun::star::container::XIndexAccess Data)
 restore all views which will be represented by given data argument More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

gives access to some properties describing all open views to a document

Each view is described by a sequence< ::com::sun::star::beans::PropertyValue >. Through this interface the state of all open views can be retrieved and restored later. These states can also be made persistent so that a document loader can create all views of the correct types and restore their state to the state when the document was saved.

Developers Guide
OfficeDev - Component - Models - XViewDataSupplier
Drawings - Other Drawing Specific View Settings
Text - Text Document Controller

Member Function Documentation

retrieve information about currently opened view to restore it later

Returns
a com::sun::star::container::XIndexAccess, that gives access to a list of com::sun::star::beans::PropertyValue for every open view. May NULL if no view is currently available.
void setViewData ( [in] com::sun::star::container::XIndexAccess  Data)

restore all views which will be represented by given data argument

Parameters
Dataa list of com::sun::star::beans::PropertyValues with information about last opened views to restore it NULL isn't allowed here.

The documentation for this interface was generated from the following file: