LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
ImportFilter Service Referencepublished

filter for imports More...

import"ImportFilter.idl";

Inheritance diagram for ImportFilter:
XImporter XFilter XInitialization XNamed XInterface XInterface XInterface XInterface XMLImportFilter

Exported Interfaces

interface XImporter
 set target(!) document for this filter More...
 
interface XFilter
 filter interface More...
 
interface com::sun::star::lang::XInitialization
 support initialization of filter with its own configuration More...
 
interface com::sun::star::container::XNamed
 provides access to the internal name of this filter More...
 

Additional Inherited Members

- Public Member Functions inherited from XImporter
void setTargetDocument ([in] com::sun::star::lang::XComponent Document) raises ( com::sun::star::lang::IllegalArgumentException )
 sets the target document for the importer 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...
 
- Public Member Functions inherited from XFilter
boolean filter ([in] sequence< com::sun::star::beans::PropertyValue > aDescriptor)
 filter the document. More...
 
void cancel ()
 cancel the process. More...
 
- Protected Member Functions inherited from XInitialization
void initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 initializes the object. More...
 
- Protected Member Functions inherited from XNamed
string getName ()
 
void setName ([in] string aName)
 sets the programmatic name of the object. More...
 

Detailed Description

filter for imports

Such filters can be used for importing a content. Of course it's possible to combine it with the service ExportFilter if export functionality should be available at same implementation too.

See also
ExportFilter
Developers Guide
OfficeDev - Integrating Import and Export Filters

Exported Interfaces

provides access to the internal name of this filter

This internal filter name can be used on service FilterFactory to get further information about it (e.g. his registration for mime types or extensions etc.) It's important that returned string is the "internal name" of the filter which must be unambiguous against all other registered filters in current installation.

Attention!
Supported method setName() should be ignored or forwarded to the FilterFactory. It's not allowed to set it directly to the configuration. Because it depends from real implementation of the FilterFactory if it will be allowed or not!

support initialization of filter with its own configuration

A filter object must be created by global service FilterFactory. If filter supports this optional interface, he will be initialized by the factory directly after creation. The factory will pass follow information to this new instance:

See description of service FilterFactory::XNameContainer for a description of possible configuration data.

interface XFilter

filter interface

It's used to filter a document at loading time. The target document should be already set by using another interface ImportFilter::XImporter which is supported by this service too.

Tip:
If same implementation provides the service ExportFilter too, code must distinguish between filtering into a target document (for import) or filtering from a source document (for export). This can be recognized by saving state of used interfaces XExporter or XImporter! Otherwise it's not clear which action is required here.

interface XImporter

set target(!) document for this filter

The document must be used as the target of the filter. Any external content will be written there.


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