summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/framework/ResourceId.idl
blob: 6b5f7ddd9ee1e6be499ca6a2faa82dc1d264366a (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef __com_sun_star_drawing_framework_ResourceId_idl__
#define __com_sun_star_drawing_framework_ResourceId_idl__

#include <com/sun/star/drawing/framework/XResourceId.idl>

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

/** The <type>ResourceId</type> service provides several constructors for
    resource ids.
    <p>They mainly differ in how the anchor is specified.</p>
*/
service ResourceId
    : XResourceId
{
    /** Create an empty resource id.  It does not specify a specific
        resource but describes the absence of one.
    */
    createEmpty ();

    /** Create a resource id that has no anchor.
        <p>This constructor can be used to create resource ids for panes.</p>
    */
    create ([in] string sResourceURL);

    /** Create a resource id for an anchor that is given as
        <type>XResourceId</type> object.  This is the most general of the
        constructor variants.
    */
    createWithAnchor ([in] string sResourceURL, [in] XResourceId xAnchor);

    /** Create a resource id for a resource that is bound to an anchor that
        can be specified by a single URL.
        <p>This constructor can be used to create resources ids for views
        where the anchor is a pane.</p>
    */
    createWithAnchorURL ([in] string sResourceURL, [in] string sAnchorURL);
};

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

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */