Files
loongoffice/offapi/com/sun/star/ucb/XFetchProviderForContentAccess.idl
Michael Stahl b7ba598ced *api: clean up multi-line and mal-formed XML tags
It is amazing what some people believe autodoc supports.

Also, com::sun::uno::Any does not exist in IDL, that is part of
the C++ language binding.

Change-Id: I1f1f5cf5d27663ace6ff618ecbecb41fd2dfa1fc
2013-06-04 12:01:05 +02:00

109 lines
3.7 KiB
Plaintext

/* -*- 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` &lt;-&gt; forward step;
`FALSE` &lt;-&gt; 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` &lt;-&gt; forward step;
`FALSE` &lt;-&gt; 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` &lt;-&gt; forward step;
`FALSE` &lt;-&gt; 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: */