LibreOffice Module svx (master) 1
fmsearch.hxx
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
20#ifndef INCLUDED_SVX_FMSEARCH_HXX
21#define INCLUDED_SVX_FMSEARCH_HXX
22
23#include <rtl/ustring.hxx>
24#include <svx/svxdllapi.h>
25
26#include <com/sun/star/uno/Reference.hxx>
27
28#include <vector>
29
30namespace com::sun::star::sdbc { class XResultSet; }
31
32// Helper methods
33
34SVXCORE_DLLPUBLIC bool IsSearchableControl( const css::uno::Reference< css::uno::XInterface>& _xControl,
35 OUString* pCurrentText = nullptr);
36 // check if the control has one of the interfaces we can use for searching
37 // *pCurrentText will be filled with the current text of the control (as used when searching this control)
38
39
40// Helper structs
41
43{
44 css::uno::Any aPosition; // bookmark of the record in which the text was found
45 sal_Int16 nFieldPos; // ditto: the relative position of the column (in the string name of the field list in the constructor)
46 sal_Int16 nContext; // the context in which was searched and found (if the current search knows several contexts)
47};
48
49// FmSearchContext - information for the search in different contexts
50
52{
53 // [in]
54 sal_Int16 nContext; // the number of the context
55 // [out]
56 css::uno::Reference< css::sdbc::XResultSet>
57 xCursor; // the iterator for the context
58 OUString strUsedFields; // a list of field names separated by ';'
59 ::std::vector< css::uno::Reference< css::uno::XInterface > >
60 arrFields; // the corresponding text interfaces for the fields in strUsedFields
61 OUString sFieldDisplayNames; // if not empty: names to be displayed for the searchable fields (must have the same token count as strUsedFields!)
62};
63
64#endif // INCLUDED_SVX_FMSEARCH_HXX
65
66/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SVXCORE_DLLPUBLIC bool IsSearchableControl(const css::uno::Reference< css::uno::XInterface > &_xControl, OUString *pCurrentText=nullptr)
Definition: fmshimp.cxx:468
css::uno::Any aPosition
Definition: fmsearch.hxx:44
::std::vector< css::uno::Reference< css::uno::XInterface > > arrFields
Definition: fmsearch.hxx:60
css::uno::Reference< css::sdbc::XResultSet > xCursor
Definition: fmsearch.hxx:57
sal_Int16 nContext
Definition: fmsearch.hxx:54
OUString sFieldDisplayNames
Definition: fmsearch.hxx:61
OUString strUsedFields
Definition: fmsearch.hxx:58
#define SVXCORE_DLLPUBLIC
Definition: svxdllapi.h:35