odk/examples/java/Inspector/XInstanceInspector.idl

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: XInstanceInspector.idl,v $
   4  *
   5  *  $Revision: 1.6 $
   6  *
   7  *  last change: $Author: rt $ $Date: 2008-07-11 14:30:03 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40
  41 #ifndef INCLUDED_ORG_OPENOFFICE_XINSTANCEINSPECTOR_IDL
  42 #define INCLUDED_ORG_OPENOFFICE_XINSTANCEINSPECTOR_IDL
  43
  44 #include <com/sun/star/uno/XInterface.idl>
  45
  46 module org {  module openoffice {
  47
  48     interface XInstanceInspector {
  49         /**
  50          * For a given instance this method displays all services, interfaces,
  51          * methods, attributes, and contents in a tree. All dependend
  52          * instances are also inspected and displayed, so the user could browse
  53          * the tree. If you press the key "F1", the API-documentation from
  54          * www.openoffice.org for the current instance will be displayed in a
  55          * new window.
  56          */
  57         void inspect( [in] any aInstance, [in] string sTitle );
  58     };
  59
  60 }; };
  61
  62 #endif