/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XPackageTypeInfo.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 22:59:18 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/

#if ! defined INCLUDED_com_sun_star_deployment_XPackageTypeInfo_idl
#define INCLUDED_com_sun_star_deployment_XPackageTypeInfo_idl

#include <com/sun/star/uno/XInterface.idl>


module com { module sun { module star { module deployment {

/** Objects of this interface provide information about a package's type.

    @since OOo 2.0.0
*/
interface XPackageTypeInfo
{
    /** returns the media type of a package, e.g.
        <code>application/vnd.sun.star.basic-script</code>.

        @return
                media type of package
    */
    string getMediaType();

    /** returns a description string to describe a package type.

        @return
                description
    */
    string getDescription();

    /** returns a short description string to describe a package type
        (one line only).

        @return
                description
    */
    string getShortDescription();

    /** returns a file filter string for the file picker user interface.
        Both, the short description string and file filter string
        will be passed to
        <member scope="com::sun::star::ui::dialogs">XFilterManager::appendFilter</member>.

        @return
                file filter string
    */
    string getFileFilter();

    /** returns an icon for a package.

        @param highContrast
               return high contrast icon
        @param smallIcon
               return a small icon (e.g. 16x16 pixel),
               else return a big one (e.g. 26x26 pixel)
        @return
                currently an unsigned short
                (resource id for deploymentgui resource file),
                <VOID/> any if none is available
    */
    any getIcon( [in] boolean highContrast, [in] boolean smallIcon );
};

}; }; }; };

#endif
