offapi/com/sun/star/mozilla/XProfileDiscover.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XProfileDiscover.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_mozilla_XProfileDiscover_idl__
  31 #define __com_sun_star_mozilla_XProfileDiscover_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_mozilla_MozillaProductType_idl__
  37 #include <com/sun/star/mozilla/MozillaProductType.idl>
  38 #endif
  39
  40
  41  module com {  module sun {  module star {  module mozilla {
  42
  43
  44
  45 /** is the interface used to list and get information for Mozilla/Thunderbird profiles
  46
  47
  48     @see com::sun::star::mozilla::XProfileManager
  49     @see com::sun::star::mozilla::MozillaBootstrap
  50  */
  51 published interface XProfileDiscover: com::sun::star::uno::XInterface
  52 {
  53
  54     /** attempts to get the profiles count.
  55
  56         @param product
  57             is the product name to get profiles count.Currently support "Mozilla" and "Thunderbird".
  58         @returns
  59             the profiles count of selected product.
  60
  61      */
  62     long getProfileCount( [in]MozillaProductType product);
  63
  64     /** attempts to get the profile list for the given product.
  65
  66         @param product
  67             is the product name to get profile list.Currently support "Mozilla" and "Thunderbird".
  68         @param list
  69             is a list of all profile of the given product.
  70         @returns
  71             the profile count for the given product.
  72
  73      */
  74     long getProfileList( [in]MozillaProductType product,[out] sequence<string> list);
  75
  76     /** attempts to get the default profile name for the given product.
  77
  78         @param product
  79             is the product name to get default profile.Currently support "Mozilla" and "Thunderbird".
  80         @returns
  81             the default profile name for the given product.
  82
  83      */
  84     string getDefaultProfile( [in]MozillaProductType product);
  85
  86
  87     /** attempts to get the full path for the given profile.
  88
  89         @param product
  90             is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
  91         @param profileName
  92             the profile name to get full path.
  93         @returns
  94             the full path of the given profile.
  95
  96      */
  97     string getProfilePath( [in]MozillaProductType product,[in]string profileName);
  98
  99     /** attempts to get whether profile is locked by other applications.
 100
 101         @param product
 102             is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
 103         @param profileName
 104             the profile name to check.
 105         @returns
 106             true is the given profile is locked.
 107
 108      */
 109     boolean isProfileLocked( [in]MozillaProductType product,[in]string profileName);
 110
 111     /** return true if the given profile exists
 112
 113         @param product
 114             is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
 115         @param profileName
 116             the profile name to check.
 117         @returns
 118             whether given profile exists
 119
 120      */
 121     boolean getProfileExists( [in]MozillaProductType product,[in]string profileName);
 122
 123
 124 };
 125
 126 //=============================================================================
 127
 128 }; }; }; };
 129
 130 #endif