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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_mozilla_XProfileManager_idl__
  20 #define __com_sun_star_mozilla_XProfileManager_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/mozilla/MozillaProductType.idl>
  24
  25
  26
  27  module com {  module sun {  module star {  module mozilla {
  28
  29
  30
  31 /** is the interface to boot up and switch Mozilla/Thunderbird profiles
  32
  33     @see com::sun::star::mozilla::MozillaProductType
  34     @see com::sun::star::mozilla::XProfileDiscover
  35     @see com::sun::star::mozilla::MozillaBootstrap
  36  */
  37 published interface XProfileManager: com::sun::star::uno::XInterface
  38 {
  39     /** attempts to init XPCOM runtime using given profile.
  40
  41         @param product
  42             is the product to start up.
  43         @param profileName
  44             the profile name to be used.
  45         @returns
  46             the current reference count for the given profile.
  47
  48      */
  49     long bootupProfile( [in]MozillaProductType product,[in]string profileName);
  50
  51     /** attempts to shutdown the current profile.
  52
  53         @returns
  54             the current reference count for the current profile.
  55
  56      */
  57     long shutdownProfile();
  58
  59     /** attempts to get the current product.
  60
  61         @returns
  62             the current used product.
  63
  64      */
  65     MozillaProductType getCurrentProduct();
  66
  67     /** attempts to get the current profile name.
  68
  69         @returns
  70             the current used profile.
  71
  72      */
  73     string getCurrentProfile();
  74
  75     /** attempts to check whether the current profile locked or not
  76
  77         @returns
  78             return sal_True is current profile is locked
  79
  80      */
  81     boolean isCurrentProfileLocked();
  82
  83     /** attempts to set the current used profile name for the given product.
  84
  85         @param product
  86             is the product to be used.
  87         @param profileName
  88             the profile name to be used.
  89         @returns
  90             the current used profile name for the given product.
  91
  92      */
  93     string setCurrentProfile( [in]MozillaProductType product,[in]string profileName);
  94
  95
  96 };
  97
  98
  99 }; }; }; };
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */