xref: /aoo41x/main/offapi/com/sun/star/drawing/framework/XResource.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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 {

published interface XResourceId;

/** Base interface that provides functionality shared by all resource types
    of the drawing framework.
*/
published 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