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