LibreOffice: com/sun/star/drawing/framework/XResourceId.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XResourceId.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef __com_sun_star_drawing_framework_XResourceId_idl__
21#define __com_sun_star_drawing_framework_XResourceId_idl__
22
23#include <com/sun/star/uno/XInterface.idl>
24#include <com/sun/star/drawing/framework/AnchorBindingMode.idl>
25#include <com/sun/star/util/URL.idl>
26
27module com { module sun { module star { module drawing { module framework {
28
44 interface XResourceId
45{
49 string getResourceURL ();
50
53 com::sun::star::util::URL getFullResourceURL ();
54
58 boolean hasAnchor ();
59
62 XResourceId getAnchor ();
63
69 sequence<string> getAnchorURLs ();
70
74 string getResourceTypePrefix ();
75
96 short compareTo (
97 [in] XResourceId xId);
98
114 boolean isBoundTo (
115 [in] XResourceId xAnchorId,
116 [in] AnchorBindingMode eMode);
117
131 boolean isBoundToURL (
132 [in] string AnchorURL,
133 [in] AnchorBindingMode eMode);
134
138 XResourceId clone ();
139};
140
141}; }; }; }; }; // ::com::sun::star::drawing::framework
142
143#endif
144
145/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
AnchorBindingMode.idl
XInterface.idl
com::sun::star::drawing::framework::XResourceId
A resource id uses a set of URLs to unambiguously specify a resource of the drawing framework.
Definition: XResourceId.idl:45
com::sun::star::drawing::framework::XResourceId::clone
XResourceId clone()
Return a copy of the called resource id.
com::sun::star::drawing::framework::XResourceId::getAnchorURLs
sequence< string > getAnchorURLs()
Return the, possibly empty, list of anchor URLs.
com::sun::star::drawing::framework::XResourceId::isBoundToURL
boolean isBoundToURL([in] string AnchorURL, [in] AnchorBindingMode eMode)
Return whether the anchor of the called resource id object represents the same resource as the given ...
com::sun::star::drawing::framework::XResourceId::getResourceURL
string getResourceURL()
Return the URL of the resource.
com::sun::star::drawing::framework::XResourceId::getResourceTypePrefix
string getResourceTypePrefix()
Return the type prefix of the resource URL.
com::sun::star::drawing::framework::XResourceId::hasAnchor
boolean hasAnchor()
Return whether there is a non-empty anchor URL.
com::sun::star::drawing::framework::XResourceId::getAnchor
XResourceId getAnchor()
Return a new XResourceId that represents the anchor resource.
com::sun::star::drawing::framework::XResourceId::isBoundTo
boolean isBoundTo([in] XResourceId xAnchorId, [in] AnchorBindingMode eMode)
Return whether the anchor of the called resource id object represents the same resource as the given ...
com::sun::star::drawing::framework::XResourceId::compareTo
short compareTo([in] XResourceId xId)
Compare the called XResourceId object with the given one.
com::sun::star::drawing::framework::XResourceId::getFullResourceURL
com::sun::star::util::URL getFullResourceURL()
Return a URL object of the resource URL that may contain arguments.
com::sun::star::drawing::framework::AnchorBindingMode
AnchorBindingMode
This enum specifies how a resource is bound to an anchor.
Definition: AnchorBindingMode.idl:35
com
Definition: Ambiguous.idl:22
com::sun::star::util::URL
represents the structure of a Uniform Resource Locator.
Definition: URL.idl:44
URL.idl