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_ResourceId_idl__
29#define __com_sun_star_drawing_framework_ResourceId_idl__
30
31#ifndef __com_sun_star_drawing_framework_XResourceId_idl__
32#include <com/sun/star/drawing/framework/XResourceId.idl>
33#endif
34
35module com { module sun { module star { module drawing { module framework {
36
37/** The <type>ResourceId</type> service provides several constructors for
38    resource ids.
39    <p>They mainly differe in how the anchor is specified.</p>
40*/
41service ResourceId
42    : XResourceId
43{
44    /** Create an empty resource id.  It does not specify a specific
45        resource but describes the absence of one.
46    */
47    createEmpty ();
48
49    /** Create a resource id that has no anchor.
50        <p>This constructor can be used to create resource ids for panes.</p>
51    */
52    create ([in] string sResourceURL);
53
54    /** Create a resource id for an anchor that is given as
55        <type>XResourceId</type> object.  This is the mose general of the
56        constructor variants.
57    */
58    createWithAnchor ([in] string sResourceURL, [in] XResourceId xAnchor);
59
60    /** Create a resource id for a resource that is bound to an anchor that
61        can be specified by a single URL.
62        <p>This constructor can be used to create resources ids for views
63        where the anchor is a pane.</p>
64    */
65    createWithAnchorURL ([in] string sResourceURL, [in] string sAnchorURL);
66};
67
68}; }; }; }; }; // ::com::sun::star::drawing::framework
69
70#endif
71