xref: /AOO41X/main/offapi/com/sun/star/mozilla/XProfileManager.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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#ifndef __com_sun_star_mozilla_XProfileManager_idl__
24#define __com_sun_star_mozilla_XProfileManager_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29#ifndef __com_sun_star_mozilla_MozillaProductType_idl__
30#include <com/sun/star/mozilla/MozillaProductType.idl>
31#endif
32
33
34
35 module com {  module sun {  module star {  module mozilla {
36
37
38
39/** is the interface to bootup and switch Mozilla/Thunderbird profiles
40
41    @see com::sun::star::mozilla::MozillaProductType
42    @see com::sun::star::mozilla::XProfileDiscover
43    @see com::sun::star::mozilla::MozillaBootstrap
44 */
45published interface XProfileManager: com::sun::star::uno::XInterface
46{
47
48    // DocMerge from xml: method com::sun::star::mozilla::XProfileManager::bootupProfile
49    /** attempts to init xpcom runtime using given profile.
50
51        @param product
52            is the product to start up.
53        @param profileName
54            the profile name to be used.
55        @returns
56            the current refrence count for the given profile.
57
58     */
59    long bootupProfile( [in]MozillaProductType product,[in]string profileName);
60
61    /** attempts to shutdown the current profile.
62
63        @returns
64            the current refrence count for the current profile.
65
66     */
67    long shutdownProfile();
68
69    /** attempts to get the current product.
70
71        @returns
72            the current used product.
73
74     */
75    MozillaProductType getCurrentProduct();
76
77    /** attempts to get the current profile name.
78
79        @returns
80            the current used profile.
81
82     */
83    string getCurrentProfile();
84
85    /** attempts to check whether the current profile locked or not
86
87        @returns
88            return sal_True is current profile is locked
89
90     */
91    boolean isCurrentProfileLocked();
92
93    /** attempts to set the current used profile name for the given product.
94
95        @param product
96            is the product to be used.
97        @param profileName
98            the profile name to be used.
99        @returns
100            the current used profile name for the given product.
101
102     */
103    string setCurrentProfile( [in]MozillaProductType product,[in]string profileName);
104
105
106};
107
108//=============================================================================
109
110}; }; }; };
111
112#endif
113