offapi/com/sun/star/system/XProxySettings.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: XProxySettings.idl,v $
  10  * $Revision: 1.7 $
  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
  31 #ifndef __com_sun_star_system_XProxySettings_idl__
  32 #define __com_sun_star_system_XProxySettings_idl__
  33
  34 #ifndef __com_sun_star_uno_RuntimeException_idl__
  35 #include <com/sun/star/uno/RuntimeException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_uno_XInterface_idl__
  39 #include <com/sun/star/uno/XInterface.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module system {
  45
  46 //=============================================================================
  47 /** Enables access to different proxy settings. If particular settings are not
  48     available an empty string will be returned.
  49
  50     @deprecated
  51 */
  52
  53 published interface XProxySettings: com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56     /** Access to the Ftp proxy address.
  57         @returns
  58         The address of the ftp proxy server, if any has been specified.
  59     */
  60     string getFtpProxyAddress( );
  61
  62     //-------------------------------------------------------------------------
  63     /** Access to the Ftp proxy port.
  64         @returns
  65         The port of the ftp proxy server, if any has been specified.
  66     */
  67     string getFtpProxyPort( );
  68
  69     //-------------------------------------------------------------------------
  70     /** Access to the Gopher proxy address.
  71         @returns
  72         The address of the gopher proxy server, if any has been specified.
  73     */
  74     string getGopherProxyAddress( );
  75
  76     //-------------------------------------------------------------------------
  77     /** Access to the Gopher proxy port.
  78         @returns
  79         The port of the gopher proxy server, if any has been specified.
  80     */
  81     string getGopherProxyPort( );
  82
  83     //-------------------------------------------------------------------------
  84     /** Access to the Http proxy address.
  85         @returns
  86         The address of the http proxy server, if any has been specified.
  87     */
  88     string getHttpProxyAddress( );
  89
  90     //-------------------------------------------------------------------------
  91     /** Access to the Http proxy port.
  92         @returns
  93         The port of the http proxy server, if any has been specified.
  94     */
  95     string getHttpProxyPort( );
  96
  97     //-------------------------------------------------------------------------
  98     /** Access to the Https proxy address.
  99         @returns
 100         The address of the https proxy server, if any has been specified.
 101     */
 102     string getHttpsProxyAddress( );
 103
 104     //-------------------------------------------------------------------------
 105     /** Access to the Https proxy port.
 106         @returns
 107         The port of the https proxy server, if any has been specified.
 108     */
 109     string getHttpsProxyPort( );
 110
 111     //-------------------------------------------------------------------------
 112     /** Access to the Socks proxy address.
 113         @returns
 114         The address of the socks proxy server, if any has been specified.
 115     */
 116     string getSocksProxyAddress( );
 117
 118     //-------------------------------------------------------------------------
 119     /** Access to the Socks proxy port.
 120         @returns
 121         The port of the socks proxy server, if any has been specified.
 122     */
 123     string getSocksProxyPort( );
 124
 125     //-------------------------------------------------------------------------
 126     /** Access to the Proxy-Bypass address.
 127         @returns
 128         A string of ';' separated addresses for which no proxy server
 129         should be used.
 130     */
 131     string getProxyBypassAddress( );
 132
 133     //-------------------------------------------------------------------------
 134     /** Either a proxy is enabled or not.
 135         @returns
 136         A value of <TRUE/> if a proxy is enabled.
 137         <p>A value of <FALSE/> if a proxy is disabled.</p>
 138     */
 139     boolean isProxyEnabled( );
 140 };
 141
 142 //=============================================================================
 143
 144 }; }; }; };
 145
 146 #endif
 147