offapi/com/sun/star/mozilla/XProfileDiscover.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_XProfileDiscover_idl__
  20 #define __com_sun_star_mozilla_XProfileDiscover_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/mozilla/MozillaProductType.idl>
  24
  25
  26  module com {  module sun {  module star {  module mozilla {
  27
  28
  29
  30 /** is the interface used to list and get information for Mozilla/Thunderbird profiles
  31
  32
  33     @see com::sun::star::mozilla::XProfileManager
  34     @see com::sun::star::mozilla::MozillaBootstrap
  35  */
  36 published interface XProfileDiscover: com::sun::star::uno::XInterface
  37 {
  38
  39     /** attempts to get the profiles count.
  40
  41         @param product
  42             is the product name to get profiles count.Currently support "Mozilla" and "Thunderbird".
  43         @returns
  44             the profiles count of selected product.
  45
  46      */
  47     long getProfileCount( [in]MozillaProductType product);
  48
  49     /** attempts to get the profile list for the given product.
  50
  51         @param product
  52             is the product name to get profile list.Currently support "Mozilla" and "Thunderbird".
  53         @param list
  54             is a list of all profile of the given product.
  55         @returns
  56             the profile count for the given product.
  57
  58      */
  59     long getProfileList( [in]MozillaProductType product,[out] sequence<string> list);
  60
  61     /** attempts to get the default profile name for the given product.
  62
  63         @param product
  64             is the product name to get default profile.Currently support "Mozilla" and "Thunderbird".
  65         @returns
  66             the default profile name for the given product.
  67
  68      */
  69     string getDefaultProfile( [in]MozillaProductType product);
  70
  71
  72     /** attempts to get the full path for the given profile.
  73
  74         @param product
  75             is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
  76         @param profileName
  77             the profile name to get full path.
  78         @returns
  79             the full path of the given profile.
  80
  81      */
  82     string getProfilePath( [in]MozillaProductType product,[in]string profileName);
  83
  84     /** attempts to get whether profile is locked by other applications.
  85
  86         @param product
  87             is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
  88         @param profileName
  89             the profile name to check.
  90         @returns
  91             true is the given profile is locked.
  92
  93      */
  94     boolean isProfileLocked( [in]MozillaProductType product,[in]string profileName);
  95
  96     /** return true if the given profile exists
  97
  98         @param product
  99             is the product name to get profile path.Currently support "Mozilla" and "Thunderbird".
 100         @param profileName
 101             the profile name to check.
 102         @returns
 103             whether given profile exists
 104
 105      */
 106     boolean getProfileExists( [in]MozillaProductType product,[in]string profileName);
 107
 108
 109 };
 110
 111
 112 }; }; }; };
 113
 114 #endif
 115
 116 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */