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