udkapi/com/sun/star/lang/XUnoTunnel.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_lang_XUnoTunnel_idl__
  28 #define __com_sun_star_lang_XUnoTunnel_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34
  35
  36 //=============================================================================
  37
  38 module com {  module sun {  module star {  module lang {
  39
  40 //=============================================================================
  41
  42 /** An interface to tunnel UNO. This means providing access to data or
  43     something else, which is not specified by UNO-IDL.
  44
  45     @attention
  46     Restrictive useage.  Use only, if there is no better possibility left.
  47     It is definitely a hack.
  48
  49     <p>
  50     Common usage:
  51     Getting a C++ object pointer in the same process, thus to use an
  52     implementation directly, most often because of a design flaw.
  53     </p>
  54 */
  55 published interface XUnoTunnel: com::sun::star::uno::XInterface
  56 {
  57     /** Call this method to get something which is not specified in UNO, e.g.
  58         an address to some C++ object.
  59
  60         @attention
  61         The identifier specifies how the return value is to be reinterpreted.
  62         The identifier must be globally unique, because it is unknown where
  63         the implementation resides.
  64
  65         @param aIdentifier
  66                identifier
  67         @return
  68                 something
  69     */
  70     hyper getSomething( [in] sequence< byte > aIdentifier );
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 /*=============================================================================
  78
  79 =============================================================================*/
  80 #endif