LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Attributes | List of all members
TransferInfo Struct Referencepublished

contains information needed to transfer objects from one location to another. More...

import "TransferInfo.idl";

Inheritance diagram for TransferInfo:
TransferInfo2

Public Attributes

boolean MoveData
 contains the flags describing whether the data shall be moved instead of copied. More...
 
string SourceURL
 contains the URL of the source of the action (e.g. More...
 
string NewTitle
 contains the title of the transferred object, if it is different from the original one. More...
 
long NameClash
 describes how to act in case of title clashes while transferring the data. More...
 

Detailed Description

contains information needed to transfer objects from one location to another.

The transfer command is always called on the target folder. For a details description of the transfer command refer to the documentation of service Content.

Member Data Documentation

boolean MoveData

contains the flags describing whether the data shall be moved instead of copied.

long NameClash

describes how to act in case of title clashes while transferring the data.

A title clash for instance occurs, if a file named "foo.txt" is to be transferred to a folder already containing another file named "foo.txt".

The value can be one of the NameClash constants.

Implementations that are not able to detect whether there is a clashing resource may ignore NameClash::ERROR and NameClash::RENAME always write the new data.

string NewTitle

contains the title of the transferred object, if it is different from the original one.

If this field is filled, for example, a file will be renamed while it is being transferred.

string SourceURL

contains the URL of the source of the action (e.g.

the URL of a file to move).


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