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
28#ifndef __com_sun_star_drawing_framework_XResource_idl__
29#define __com_sun_star_drawing_framework_XResource_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35module com { module sun { module star { module drawing { module framework {
36
37published interface XResourceId;
38
39/** Base interface that provides functionality shared by all resource types
40    of the drawing framework.
41*/
42published interface XResource
43{
44    /** Return an <type>XResourceId</type> object for the called resource.
45        The returned id unambiguously indentifies the resource.
46    */
47    XResourceId getResourceId ();
48
49    /** Some resources must not be leafs, i.e. have to be anchor to at least
50        one other resource.  Most panes are examples for this.  Views on the
51        other hand are in most cases no anchors.  So the typical pane will
52        return <TRUE/> and the typical view will return <FALSE/>.
53
54        The return value is used to determine whether a resource has to be
55        deactivated when it has no children, either because none is
56        requested or because none can be created.
57    */
58    boolean isAnchorOnly ();
59};
60
61}; }; }; }; }; // ::com::sun::star::drawing::framework
62
63#endif
64