1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#if ! defined INCLUDED_com_sun_star_deployment_XPackageTypeInfo_idl
25#define INCLUDED_com_sun_star_deployment_XPackageTypeInfo_idl
26
27#include <com/sun/star/uno/XInterface.idl>
28#include <com/sun/star/deployment/ExtensionRemovedException.idl>
29
30module com { module sun { module star { module deployment {
31
32/** Objects of this interface provide information about a package's type.
33
34    @since OpenOffice 2.0
35*/
36interface XPackageTypeInfo
37{
38    /** returns the media type of a package, e.g.
39        <code>application/vnd.sun.star.basic-script</code>.
40
41        @return
42                media type of package
43    */
44    string getMediaType();
45
46    /** returns a description string to describe a package type.
47
48        @return
49                description
50    */
51    string getDescription()
52        raises (ExtensionRemovedException);
53
54    /** returns a short description string to describe a package type
55        (one line only).
56
57        @return
58                description
59    */
60    string getShortDescription()
61        raises (ExtensionRemovedException);
62
63    /** returns a file filter string for the file picker user interface.
64        Both, the short description string and file filter string
65        will be passed to
66        <member scope="com::sun::star::ui::dialogs">XFilterManager::appendFilter</member>.
67
68        @return
69                file filter string
70    */
71    string getFileFilter();
72
73    /** returns an icon for a package.
74
75        @param highContrast
76               return high contrast icon
77        @param smallIcon
78               return a small icon (e.g. 16x16 pixel),
79               else return a big one (e.g. 26x26 pixel)
80        @return
81                currently an unsigned short
82                (resource id for deploymentgui resource file),
83                <void/> any if none is available
84    */
85    any getIcon( [in] boolean highContrast, [in] boolean smallIcon );
86};
87
88}; }; }; };
89
90#endif
91