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

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