summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/framework/XResource.idl
blob: be567572d5bde92a68cf126e082f382a7280d676 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XResource.idl,v $
 * $Revision: 1.4 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_drawing_framework_XResource_idl__
#define __com_sun_star_drawing_framework_XResource_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com { module sun { module star { module drawing { module framework {

interface XResourceId;

/** Base interface that provides functionality shared by all resource types
    of the drawing framework.
*/
interface XResource
{
    /** Return an <type>XResourceId</type> object for the called resource.
        The returned id unambiguously indentifies the resource.
    */
    XResourceId getResourceId ();

    /** Some resources must not be leafs, i.e. have to be anchor to at least
        one other resource.  Most panes are examples for this.  Views on the
        other hand are in most cases no anchors.  So the typical pane will
        return <TRUE/> and the typical view will return <FALSE/>.

        The return value is used to determine whether a resource has to be
        deactivated when it has no children, either because none is
        requested or because none can be created.
    */
    boolean isAnchorOnly ();
};

}; }; }; }; }; // ::com::sun::star::drawing::framework

#endif