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