LibreOffice LibreOffice 25.8 SDK API Reference

XRelationshipAccess.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
21 module com { module sun { module star { module embed {
22
33published interface XRelationshipAccess : ::com::sun::star::uno::XInterface
34{
44 boolean hasByID( [in] string sID )
45 raises( ::com::sun::star::io::IOException );
46
63 string getTargetByID( [in] string sID )
64 raises( ::com::sun::star::container::NoSuchElementException,
65 ::com::sun::star::io::IOException );
66
83 string getTypeByID( [in] string sID )
84 raises( ::com::sun::star::container::NoSuchElementException,
85 ::com::sun::star::io::IOException );
86
106 sequence< ::com::sun::star::beans::StringPair >
107 getRelationshipByID( [in] string sID )
108 raises( ::com::sun::star::container::NoSuchElementException,
109 ::com::sun::star::io::IOException );
110
131 sequence< sequence< ::com::sun::star::beans::StringPair > >
132 getRelationshipsByType( [in] string sType )
133 raises( ::com::sun::star::io::IOException );
134
149 sequence< sequence< ::com::sun::star::beans::StringPair > >
150 getAllRelationships()
151 raises( ::com::sun::star::io::IOException );
152
177 void insertRelationshipByID(
178 [in] string sID,
179 [in] sequence< ::com::sun::star::beans::StringPair > aEntry,
180 [in] boolean bReplace )
181 raises( ::com::sun::star::container::ElementExistException,
182 ::com::sun::star::io::IOException );
183
195 void removeRelationshipByID( [in] string sID )
196 raises( ::com::sun::star::container::NoSuchElementException,
197 ::com::sun::star::io::IOException );
198
220 void insertRelationships(
221 [in] sequence< sequence< ::com::sun::star::beans::StringPair > > aEntries,
222 [in] boolean bReplace )
223 raises( ::com::sun::star::container::ElementExistException,
224 ::com::sun::star::io::IOException );
225
231 void clearRelationships()
232 raises( ::com::sun::star::io::IOException );
233
234};
235
236
237}; }; }; };
238
239/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
com::sun::star::embed::XRelationshipAccess
This interface allows to get access to relationship data.
Definition: XRelationshipAccess.idl:34
com::sun::star::embed::XRelationshipAccess::getAllRelationships
sequence< sequence< ::com::sun::star::beans::StringPair > > getAllRelationships()
retrieves the sequence containing all the entries controlled by the object.
com::sun::star::embed::XRelationshipAccess::getTargetByID
string getTargetByID([in] string sID)
retrieves the value of "Target" tag from the entry with specified "Id" tag.
com::sun::star::embed::XRelationshipAccess::getRelationshipByID
sequence< ::com::sun::star::beans::StringPair > getRelationshipByID([in] string sID)
retrieves the sequence containing all the tags from the entry with specified value of "Id" tag.
com::sun::star::embed::XRelationshipAccess::hasByID
boolean hasByID([in] string sID)
allows to detect whether there is an entry with specified value of "Id" tag.
com::sun::star::embed::XRelationshipAccess::getRelationshipsByType
sequence< sequence< ::com::sun::star::beans::StringPair > > getRelationshipsByType([in] string sType)
retrieves the sequence containing all the entries which "Type" tag takes the specified value.
com::sun::star::embed::XRelationshipAccess::getTypeByID
string getTypeByID([in] string sID)
retrieves the value of "Type" tag from the entry with specified "Id" tag.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20