LibreOffice
LibreOffice 6.4 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 #ifndef __com_sun_star_embed_XRelationshipAccess_idl__
20 #define __com_sun_star_embed_XRelationshipAccess_idl__
21 
27 
28 
29  module com { module sun { module star { module embed {
30 
42 {
52  boolean hasByID( [in] string sID )
54 
71  string getTargetByID( [in] string sID )
74 
91  string getTypeByID( [in] string sID )
94 
114  sequence< ::com::sun::star::beans::StringPair >
115  getRelationshipByID( [in] string sID )
118 
139  sequence< sequence< ::com::sun::star::beans::StringPair > >
140  getRelationshipsByType( [in] string sType )
142 
157  sequence< sequence< ::com::sun::star::beans::StringPair > >
159  raises( ::com::sun::star::io::IOException );
160 
185  void insertRelationshipByID(
186  [in] string sID,
187  [in] sequence< ::com::sun::star::beans::StringPair > aEntry,
188  [in] boolean bReplace )
189  raises( ::com::sun::star::container::ElementExistException,
190  ::com::sun::star::io::IOException );
191 
203  void removeRelationshipByID( [in] string sID )
204  raises( ::com::sun::star::container::NoSuchElementException,
205  ::com::sun::star::io::IOException );
206 
228  void insertRelationships(
229  [in] sequence< sequence< ::com::sun::star::beans::StringPair > > aEntries,
230  [in] boolean bReplace )
231  raises( ::com::sun::star::container::ElementExistException,
232  ::com::sun::star::io::IOException );
233 
239  void clearRelationships()
240  raises( ::com::sun::star::io::IOException );
241 
242 };
243 
244 
245 }; }; }; };
246 
247 #endif
248 
249 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XInterface.idl
StringPair.idl
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::embed::XRelationshipAccess::getAllRelationships
sequence< sequence< ::com::sun::star::beans::StringPair > > getAllRelationships()
retrieves the sequence containing all the entries controlled by the object.
ElementExistException.idl
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
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::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:31
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.
IOException.idl
com::sun::star::embed::XRelationshipAccess
This interface allows to get access to relationship data.
Definition: XRelationshipAccess.idl:42
com
Definition: Ambiguous.idl:22
NoSuchElementException.idl
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::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com::sun::star::embed::XRelationshipAccess::getTargetByID
string getTargetByID([in] string sID)
retrieves the value of "Target" tag from the entry with specified "ID" tag.