LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XChangesBatch Interface Referencepublished

this interface enables applying a set of changes in one batch transaction. More...

import"XChangesBatch.idl";

Inheritance diagram for XChangesBatch:
XInterface UpdateRootElement XReadWriteAccess Package HierarchyDataReadWriteAccess ConfigurationUpdateAccess ReadWriteAccess

Public Member Functions

void commitChanges () raises ( com::sun::star::lang::WrappedTargetException )
 commits any pending changes. More...
 
boolean hasPendingChanges ()
 checks whether this object has any pending changes that can be committed. More...
 
ChangesSet getPendingChanges ()
 queries for any pending changes that can be committed. 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

this interface enables applying a set of changes in one batch transaction.

An object implementing this interface allows other interfaces to change its state locally. It will keep a list of pending changes until such changes are committed or canceled.

Only when they are explicitly committed will these changes take effect persistently or globally.

See also
XChangesNotifier
XChangesSet
XCancellable
Developers Guide
WritingUNO - Disable Commands - Disabling Commands at Runtime

Member Function Documentation

◆ commitChanges()

void commitChanges ( )
raises (com::sun::star::lang::WrappedTargetException
)

commits any pending changes.

The exact action depends on the concrete service.

◆ getPendingChanges()

ChangesSet getPendingChanges ( )

queries for any pending changes that can be committed.

◆ hasPendingChanges()

boolean hasPendingChanges ( )

checks whether this object has any pending changes that can be committed.


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