1
0
Fork 0
libreoffice/offapi/com/sun/star/configuration/backend/XCompositeLayer.idl
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

82 lines
2.9 KiB
Text

/* -*- 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 .
*/
module com { module sun { module star { module configuration { module backend {
/**
provides read access to layers that contain sublayers accessible through an
additional criterion (for instance the locale they contain data for).
@since OOo 1.1.2
*/
published interface XCompositeLayer : XLayer
{
/**
Returns a list of the criteria that can be used to access the
sublayers.
@return
a list supported sublayer identifiers
@throws com::sun::star::lang::WrappedTargetException
if an error occurs in the retrieval of the data.
*/
sequence<string> listSubLayerIds()
raises (com::sun::star::lang::WrappedTargetException) ;
/**
Describes the content of a particular sublayer to
an XLayerHandler.
@param aHandler
Handler object that will receive calls
describing the contents of the sublayer.
@param aSubLayerId
Identifier of the sublayer to be read.
<p> Must be one the identifiers returned by
XCompositeLayer::listSubLayerIds()
</p>
@throws com::sun::star::lang::NullPointerException
if a `NULL` handler is passed.
@throws com::sun::star::lang::IllegalArgumentException
if the identifier is invalid.
@throws com::sun::star::lang::WrappedTargetException
if an error occurs in the access to or processing of the data.
@throws com::sun::star::configuration::backend::MalformedDataException
if the data read from the layer is rejected as invalid by the
XLayerHandler.
*/
void readSubLayerData([in] XLayerHandler aHandler, [in] string aSubLayerId)
raises (com::sun::star::lang::NullPointerException,
com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::WrappedTargetException,
MalformedDataException) ;
} ;
} ; } ; } ; } ; } ;
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */