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