diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl')
-rw-r--r-- | offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl new file mode 100644 index 000000000..a0690b440 --- /dev/null +++ b/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl @@ -0,0 +1,108 @@ +/* -*- 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_ucb_XFetchProviderForContentAccess_idl__ +#define __com_sun_star_ucb_XFetchProviderForContentAccess_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/ucb/FetchResult.idl> + + +module com { module sun { module star { module ucb { + +/** provides the possibility to load information offered by a + XContentAccess for several rows of a + ContentResultSet with a single function call. +*/ +published interface XFetchProviderForContentAccess: com::sun::star::uno::XInterface +{ + /** returns the content identifier strings of the columns of the indicated + rows + + @returns + FetchResult::Rows contains a sequence of anys. Each + of these anys contains a string. + + @param nRowStartPosition + the starting row of the result set + + @param nRowCount + the count of rows + + @param bDirection + `TRUE`, if you want the rows to be read in the same order, as they + are contained in the result set ( `TRUE` <-> forward step; + `FALSE` <-> backward step ) + */ + com::sun::star::ucb::FetchResult + fetchContentIdentifierStrings( [in] long nRowStartPosition + , [in] long nRowCount + , [in] boolean bDirection ); + + /** returns the XContentIdentifiers of the columns of the + indicated rows + + @returns + FetchResult::Rows contains a sequence of anys. Each + of these anys contains an XContentIdentifier. + + @param nRowStartPosition + the starting row of the result set + + @param nRowCount + the count of rows + + @param bDirection + `TRUE`, if you want the rows to be read in the same order, as they + are contained in the result set ( `TRUE` <-> forward step; + `FALSE` <-> backward step ) + */ + com::sun::star::ucb::FetchResult + fetchContentIdentifiers( [in] long nRowStartPosition + , [in] long nRowCount + , [in] boolean bDirection ); + + /** returns the XContent s of the columns of the indicated rows + + @returns + FetchResult::Rows contains a sequence of anys. Each + of these anys contains an XContent. + + @param nRowStartPosition + the starting row of the result set + + @param nRowCount + the count of rows + + @param bDirection + `TRUE`, if you want the rows to be read in the same order, as they + are contained in the result set ( `TRUE` <-> forward step; + `FALSE` <-> backward step ) + */ + com::sun::star::ucb::FetchResult + fetchContents( [in] long nRowStartPosition + , [in] long nRowCount + , [in] boolean bDirection ); +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |