AlterOffice
AlterOffice 2026.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
XMultiEntryClipboard Interface Referencepublished

import "XMultiEntryClipboard.idl";

Inheritance diagram for XMultiEntryClipboard:
XInterface

Public Member Functions

com::sun::star::datatransfer::XTransferable getEntry ([in] unsigned short nId)
 To get the clipboard entry with provided id. More...
 
void deleteEntry ([in] unsigned short nId)
 To delete the clipboard entry with provided id from the clipboard. More...
 
void deleteAllEntries ()
 To delete all entries from the clipboard. More...
 
sequence< unsigned short > getEntryIdList ()
 To get the list with ids of all entries in the clipboard. More...
 
byte getEntryType ([in] unsigned short nId)
 To get an enum value representing the type of entry with id: text, image, table, chart. More...
 
string getEntryPreviewText ([in] unsigned short nId)
 To get the preview text for an entry with provided id. More...
 
void skipClipboardUpdateFor ([in] unsigned short nId)
 Notify the clipboard that the entry with provided id is going to be inserted to the system clipboard. 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...
 

Member Function Documentation

void deleteAllEntries ( )

To delete all entries from the clipboard.

void deleteEntry ( [in] unsigned short  nId)

To delete the clipboard entry with provided id from the clipboard.

com::sun::star::datatransfer::XTransferable getEntry ( [in] unsigned short  nId)

To get the clipboard entry with provided id.

Returns
The transferable object representing the clipboard entry with provided id.
See Also
com::sun::star::datatransfer::XTransferable
sequence<unsigned short> getEntryIdList ( )

To get the list with ids of all entries in the clipboard.

Returns
The sequence of entry ids.
string getEntryPreviewText ( [in] unsigned short  nId)

To get the preview text for an entry with provided id.

Returns
A preview text string without formatting.
byte getEntryType ( [in] unsigned short  nId)

To get an enum value representing the type of entry with id: text, image, table, chart.

Returns
The type enum value.
void skipClipboardUpdateFor ( [in] unsigned short  nId)

Notify the clipboard that the entry with provided id is going to be inserted to the system clipboard.

This allows to skip an excess update of the clipboard.


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