udkapi/com/sun/star/lang/XUnoTunnel.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: XUnoTunnel.idl,v $
  10  * $Revision: 1.14 $
  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 #ifndef __com_sun_star_lang_XUnoTunnel_idl__
  31 #define __com_sun_star_lang_XUnoTunnel_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module lang {
  42
  43 //=============================================================================
  44
  45 /** An interface to tunnel UNO. This means providing access to data or
  46     something else, which is not specified by UNO-IDL.
  47
  48     @attention
  49     Restrictive useage.  Use only, if there is no better possibility left.
  50     It is definitely a hack.
  51
  52     <p>
  53     Common usage:
  54     Getting a C++ object pointer in the same process, thus to use an
  55     implementation directly, most often because of a design flaw.
  56     </p>
  57 */
  58 published interface XUnoTunnel: com::sun::star::uno::XInterface
  59 {
  60     /** Call this method to get something which is not specified in UNO, e.g.
  61         an address to some C++ object.
  62
  63         @attention
  64         The identifier specifies how the return value is to be reinterpreted.
  65         The identifier must be globally unique, because it is unknown where
  66         the implementation resides.
  67
  68         @param aIdentifier
  69                identifier
  70         @return
  71                 something
  72     */
  73     hyper getSomething( [in] sequence< byte > aIdentifier );
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 /*=============================================================================
  81
  82 =============================================================================*/
  83 #endif