summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/mozilla/XProfileDiscover.idl
blob: ca37a13c97738c200f0d88f92fcd9f3497b29617 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XProfileDiscover.idl,v $
 * $Revision: 1.4 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_mozilla_XProfileDiscover_idl__
#define __com_sun_star_mozilla_XProfileDiscover_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_mozilla_MozillaProductType_idl__
#include <com/sun/star/mozilla/MozillaProductType.idl>
#endif


 module com {  module sun {  module star {  module mozilla {



/** is the interface used to list and get information for Mozilla/Thunderbird profiles


    @see com::sun::star::mozilla::XProfileManager
    @see com::sun::star::mozilla::MozillaBootstrap
 */
published interface XProfileDiscover: com::sun::star::uno::XInterface
{

    /** attempts to get the profiles count.

        @param product
            is the product name to get profiles count.Currently support "Mozilla" and "Thunderbird".
        @returns
            the profiles count of selected product.

     */
    long getProfileCount( [in]MozillaProductType product);

    /** attempts to get the profile list for the given product.

        @param product
            is the product name to get profile list.Currently support "Mozilla" and "Thunderbird".
        @param list
            is a list of all profile of the given product.
        @returns
            the profile count for the given product.

     */
    long getProfileList( [in]MozillaProductType product,[out] sequence<string> list);

    /** attempts to get the default profile name for the given product.

        @param product
            is the product name to get default profile.Currently support "Mozilla" and "Thunderbird".
        @returns
            the default profile name for the given product.

     */
    string getDefaultProfile( [in]MozillaProductType product);


    /** attempts to get the full path for the given profile.

        @param product
            is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
        @param profileName
            the profile name to get full path.
        @returns
            the full path of the given profile.

     */
    string getProfilePath( [in]MozillaProductType product,[in]string profileName);

    /** attempts to get whether profile is locked by other applications.

        @param product
            is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
        @param profileName
            the profile name to check.
        @returns
            true is the given profile is locked.

     */
    boolean isProfileLocked( [in]MozillaProductType product,[in]string profileName);

    /** return true if the given profile exists

        @param product
            is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
        @param profileName
            the profile name to check.
        @returns
            whether given profile exists

     */
    boolean getProfileExists( [in]MozillaProductType product,[in]string profileName);


};

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

}; }; }; };

#endif