include/svx/fmsearch.hxx

   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 <com/sun/star/sdbc/XResultSet.hpp>
  24 #include <comphelper/uno3.hxx>
  25 #include <rtl/ustring.hxx>
  26 #include <svx/svxdllapi.h>
  27 #include <vcl/button.hxx>
  28 #include <vcl/combobox.hxx>
  29 #include <vcl/dialog.hxx>
  30 #include <vcl/edit.hxx>
  31 #include <vcl/fixed.hxx>
  32 #include <vcl/lstbox.hxx>
  33
  34 namespace com { namespace sun { namespace star {
  35     namespace util {
  36         class XNumberFormatsSupplier;
  37     }
  38 }}}
  39
  40 // Helper methods
  41
  42 SVX_DLLPUBLIC bool IsSearchableControl( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>& _xControl,
  43                                             OUString* pCurrentText = NULL);
  44     // check if the control has one of the interfaces we can use for searching
  45     // *pCurrentText will be filled with the current text of the control (as used when searching this control)
  46
  47
  48 // Helper structs
  49
  50 struct FmFoundRecordInformation
  51 {
  52     ::com::sun::star::uno::Any      aPosition;  // bookmark of the record in which the text was found
  53     sal_Int16       nFieldPos;  // ditto: the relative position of the column (in the string name of the field list in the constructor)
  54     sal_Int16       nContext;   // the context in which was searched and found (if the current search knows several contexts)
  55 };
  56
  57 // FmSearchContext - information for the search in different contexts
  58
  59 struct FmSearchContext
  60 {
  61     // [in]
  62     sal_Int16               nContext;       // the number of the context
  63     // [out]
  64     css::uno::Reference< css::sdbc::XResultSet>
  65                             xCursor;        // the iterator for the context
  66     OUString                strUsedFields;  // a list of field names separeted by ';'
  67     ::std::vector< css::uno::Reference< css::uno::XInterface > >
  68                             arrFields;      // the corresponding text interfaces for the fields in strUsedFields
  69     OUString                sFieldDisplayNames;     // if not empty: names to be displayed for the searchable fields (must have the same token count as strUsedFields!)
  70 };
  71
  72 #endif // INCLUDED_SVX_FMSEARCH_HXX
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */