xref: /AOO42X/main/offapi/com/sun/star/mozilla/XProfileManager.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_mozilla_XProfileManager_idl__
28#define __com_sun_star_mozilla_XProfileManager_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33#ifndef __com_sun_star_mozilla_MozillaProductType_idl__
34#include <com/sun/star/mozilla/MozillaProductType.idl>
35#endif
36
37
38
39 module com {  module sun {  module star {  module mozilla {
40
41
42
43/** is the interface to bootup and switch Mozilla/Thunderbird profiles
44
45    @see com::sun::star::mozilla::MozillaProductType
46    @see com::sun::star::mozilla::XProfileDiscover
47    @see com::sun::star::mozilla::MozillaBootstrap
48 */
49published interface XProfileManager: com::sun::star::uno::XInterface
50{
51
52    // DocMerge from xml: method com::sun::star::mozilla::XProfileManager::bootupProfile
53    /** attempts to init xpcom runtime using given profile.
54
55        @param product
56            is the product to start up.
57        @param profileName
58            the profile name to be used.
59        @returns
60            the current refrence count for the given profile.
61
62     */
63    long bootupProfile( [in]MozillaProductType product,[in]string profileName);
64
65    /** attempts to shutdown the current profile.
66
67        @returns
68            the current refrence count for the current profile.
69
70     */
71    long shutdownProfile();
72
73    /** attempts to get the current product.
74
75        @returns
76            the current used product.
77
78     */
79    MozillaProductType getCurrentProduct();
80
81    /** attempts to get the current profile name.
82
83        @returns
84            the current used profile.
85
86     */
87    string getCurrentProfile();
88
89    /** attempts to check whether the current profile locked or not
90
91        @returns
92            return sal_True is current profile is locked
93
94     */
95    boolean isCurrentProfileLocked();
96
97    /** attempts to set the current used profile name for the given product.
98
99        @param product
100            is the product to be used.
101        @param profileName
102            the profile name to be used.
103        @returns
104            the current used profile name for the given product.
105
106     */
107    string setCurrentProfile( [in]MozillaProductType product,[in]string profileName);
108
109
110};
111
112//=============================================================================
113
114}; }; }; };
115
116#endif
117