Overview | Module | Use | Devguide | Index

Services' Summary | Interfaces' Summary | Properties' Summary | Services' Details | Interfaces' Details | Properties' Details

:: com :: sun :: star :: document ::
service TypeDetection
Description encapsulate a type detection service and provide read/write access on it's configuration data. It's possible to make a "flat" detection which may use internal configuration data only - or a "deep" detection which use special ExtendedTypeDetection services to look into the document stream. Last mode can be suppressed to perform the operation. Of course the results can't be guaranteed then. (e.g. in case the extension was changed) Developers Guide OfficeDev - Integrating Import and Export Filters

Exported Interfaces - Summary
XTypeDetection | can be used to make a flat or deep type detection. (details)
::com::sun::star::container::XNameAccess | provides read access to the complete set of type configuration data. (details)
::com::sun::star::container::XNameContainer | provides a write access to the configuration data. (details)
::com::sun::star::container::XContainerQuery | provides search on the configuration data set. (details)
::com::sun::star::util::XFlushable | can be used to perform container changes. (details)

Exported Interfaces - Details
XTypeDetection
Description can be used to make a flat or deep type detection. Use this interface to get information about the type of the given resource. Return value will be always an internal name of a registered document type. It can be used may on other services (e.g. ::com::sun::star::frame::FrameLoaderFactory) to do further things, which base on it (e.g. to load it into a frame).
::com::sun::star::container::XNameAccess
  Description provides read access to the complete set of type configuration data. Every container item is specified as a set of properties and will be represented by a sequence< PropertyValue > structure. Follow properties are supported: (But note: not all of them must be present every time!)
  Property Name | Value Type | Description
  Name | [string] | The internal name is the only value, which makes a container item unique.
  UIName | [string] | It contains the localized name for this type for the current locale.
  UINames | [sequence< string >] | It contains all available localized names for this type. The are organized in pairs and represented as a structure of sequence< PropertyValue >. The name of such property must be interpreted as locale; it's value as the localized type name corresponding to this locale.
  MediaType | [string] | It contains the MIME or content type descriptor. The differences between a MIME type and an internal type name was made, to resolve existing ambiguities.
  ClipboardFormat deprecated! | [string] | It was interpreted as an identifier inside clipboard. Please use new property ContentFormat instead of this now.
  ContentFormat | [string] | It's and identifier, which is used for a deep format detection. An ExtendedTypeDetection use this value to match a given content to this type. e.g. It's interpreted as the doc type of an XML stream or as an identifier inside a file header.
  URLPattern | [sequence< string >] | This list contains different URL patterns, which identify this type. E.g. data base contents can be described by an new defined protocol like "sql://select*". In combination with a suitable ::com::sun::star::frame::FrameLoader or ImportFilter/ExportFilter it would be possible then, to layout a SQL query output into an office frame.
  Extensions | [sequence< string >] | It contains a list of file extensions, which match this type. They must be specified as pure extension, without any special signs. E.g.: "doc", "html" ... but not ".doc". Using wild cards is allowed but not very useful. They may result in ambiguities with other type registrations can't be resolved anytime.
  DocumentIconID | [integer] | It's an ID, which present the number of a corresponding icon.
Note: All elements of this container will be addressed by his internal name, and it must be an unambiguous value.
::com::sun::star::container::XNameContainer
Usage Restrictions optional Description provides a write access to the configuration data.
::com::sun::star::container::XContainerQuery
Usage Restrictions optional Description provides search on the configuration data set. Against simple property search it provides some complex algorithms too. For further information please read the SDK documentation.
::com::sun::star::util::XFlushable
Usage Restrictions optional Description can be used to perform container changes. Because the complexness of such configuration set can be very high, it seams not very useful to update the underlying configuration layer on every container change request immediately. Another strategy can be to make all changes (adding/changing/removing of items) and call flush at the end. That will validate the whole container and reject inconsistent data sets. Only in case all made changes was correct, they will be written back to the configuration. Further this interface provides the possibility, that interested changes listener can be registered too.

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.