/*************************************************************************
 *
 *  $RCSfile: TypeDetection.idl,v $
 *
 *  $Revision: 1.2.4.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:41:40 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_document_TypeDetection_idl__
#define __com_sun_star_document_TypeDetection_idl__

#ifndef __com_sun_star_document_XTypeDetection_idl__
#include <com/sun/star/document/XTypeDetection.idl>
#endif

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif

//=============================================================================

module com { module sun { module star { module document {

//=============================================================================
/** capsulate a type detection service and supports access on taht configuration

    <p>
    It's possible to make a "flat" detection wich may use internal configuration
    data only - or a "deep" detection which use special <type>ExtendedTypeDetection</type>s
    to look into the document to specify it unambigous. Last mode can be supressed
    to perform.
    </p>
 */
service TypeDetection
{
	//-------------------------------------------------------------------------
	/**	detect resource

		<p>
        Use this interface to get information about type of given document.
        Return value will be always an internal name of a registered document type.
        It can be used may on other services (e.g. <type>FilterFactory</type>) for
        further things (especialy to get the default filter for it).
 		</p>
	 */
    interface XTypeDetection;

	//-------------------------------------------------------------------------
    /** provides access to complete type configuration

		<p>
        This configuration is organized as a collection of flat data structures.
        The representation of such data structures will pe represented by
        the type sequence<com::sun::star::beans::PropertyValue>.
        Follow properties will be supported:
        <table border=1>
            <tr>
                <td><strong>property name</strong></td>
                <td><strong>Value type</strong></td>
                <td><strong>description</strong></td>
            </tr>
            <tr>
                <td>UIName</td>
                <td>[string]</td>
                <td>localized name of type to show at UI elements</td>
            </tr>
            <tr>
                <td>MediaType</td>
                <td>[string]</td>
                <td>MIME or content type</td>
            </tr>
            <tr>
                <td>ClipboardFormat</td>
                <td>[string]</td>
                <td>name of supported clipboard format</td>
            </tr>
            <tr>
                <td>URLPattern</td>
                <td>[sequence< string >]</td>
                <td>a list of URL patterns which identify this type</td>
            </tr>
            <tr>
                <td>Extensions</td>
                <td>[sequence< string >]</td>
                <td>a list of file extensions which identify this type</td>
            </tr>
            <tr>
                <td>DocumentIconID</td>
                <td>[integer]</td>
                <td>an ID which present the number of corresponding icon</td>
            </tr>
        </table>
 		</p>

        <p>
        Note:<br>
        All elements of this container will be adressed by his internal type name.
        This must be an unambigous name.
        </p>
	 */
	interface com::sun::star::container::XNameAccess;
};

//=============================================================================

}; }; }; };

#endif
