LibreOffice: com/sun/star/util/XSearchable.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XSearchable.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_util_XSearchable_idl__
20#define __com_sun_star_util_XSearchable_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23
24#include <com/sun/star/util/XSearchDescriptor.idl>
25
26#include <com/sun/star/container/XIndexAccess.idl>
27
28
29
30module com { module sun { module star { module util {
31
32
53published interface XSearchable: com::sun::star::uno::XInterface
54{
58 com::sun::star::util::XSearchDescriptor createSearchDescriptor();
59
62 com::sun::star::container::XIndexAccess findAll( [in] com::sun::star::util::XSearchDescriptor xDesc );
63
72 com::sun::star::uno::XInterface findFirst( [in] com::sun::star::util::XSearchDescriptor xDesc );
73
85 com::sun::star::uno::XInterface findNext( [in] com::sun::star::uno::XInterface xStartAt,
86 [in] com::sun::star::util::XSearchDescriptor xDesc );
87
88};
89
90
91}; }; }; };
92
93#endif
94
95/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XIndexAccess.idl
XInterface.idl
XSearchDescriptor.idl
com::sun::star::container::XIndexAccess
provides access to the elements of a collection through an index.
Definition: XIndexAccess.idl:40
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com::sun::star::util::XSearchDescriptor
specifies a string search operation.
Definition: XSearchDescriptor.idl:32
com::sun::star::util::XSearchable
enables the object to look for specified contents of the object (in particular, for a text range whic...
Definition: XSearchable.idl:54
com::sun::star::util::XSearchable::findFirst
com::sun::star::uno::XInterface findFirst([in] com::sun::star::util::XSearchDescriptor xDesc)
searches the contained texts for the next occurrence of whatever is specified.
com::sun::star::util::XSearchable::createSearchDescriptor
com::sun::star::util::XSearchDescriptor createSearchDescriptor()
creates a SearchDescriptor which contains properties that specify a search in this container.
com::sun::star::util::XSearchable::findAll
com::sun::star::container::XIndexAccess findAll([in] com::sun::star::util::XSearchDescriptor xDesc)
searches the contained texts for all occurrences of whatever is specified.
com::sun::star::util::XSearchable::findNext
com::sun::star::uno::XInterface findNext([in] com::sun::star::uno::XInterface xStartAt, [in] com::sun::star::util::XSearchDescriptor xDesc)
searches the contained texts for the next occurrence of whatever is specified.
com
Definition: Accessible.idl:22