binfilter/inc/bf_svx/fmsearch.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: fmsearch.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _FMSEARCH_HXX
  32 #define _FMSEARCH_HXX
  33
  34 #ifndef _COM_SUN_STAR_SDBC_XRESULTSET_HPP_
  35 #include <com/sun/star/sdbc/XResultSet.hpp>
  36 #endif
  37
  38 #define _SVSTDARR_STRINGSDTOR
  39 #include <bf_svtools/svstdarr.hxx>
  40
  41 #ifndef _DIALOG_HXX //autogen
  42 #include <vcl/dialog.hxx>
  43 #endif
  44
  45 #ifndef _BUTTON_HXX //autogen
  46 #include <vcl/button.hxx>
  47 #endif
  48
  49 #ifndef _FIXED_HXX //autogen
  50 #include <vcl/fixed.hxx>
  51 #endif
  52
  53 #ifndef _EDIT_HXX //autogen
  54 #include <vcl/edit.hxx>
  55 #endif
  56
  57 #ifndef _SV_COMBOBOX_HXX //autogen
  58 #include <vcl/combobox.hxx>
  59 #endif
  60
  61 #ifndef _SV_LSTBOX_HXX //autogen
  62 #include <vcl/lstbox.hxx>
  63 #endif
  64
  65 #ifndef _LINK_HXX //autogen
  66 #include <tools/link.hxx>
  67 #endif
  68
  69
  70 #ifndef _COMPHELPER_UNO3_HXX_
  71 #include <comphelper/uno3.hxx>
  72 #endif
  73 #ifndef _COMPHELPER_STLTYPES_HXX_
  74 #include <comphelper/stl_types.hxx>
  75 #endif
  76 FORWARD_DECLARE_INTERFACE(util,XNumberFormatsSupplier)
  77 namespace binfilter {
  78
  79 //FORWARD_DECLARE_INTERFACE(uno,Reference)
  80 //STRIP008 FORWARD_DECLARE_INTERFACE(util,XNumberFormatsSupplier)
  81
  82 // ===================================================================================================
  83 // moegliche Rueckgabewerte fuer den Found-Handler
  84 #define FM_SEARCH_GETFOCUS_ASYNC        0x0001
  85     // setzt den Fokus auf den Dialog nicht sofort nach dem Aufruf des Found-Handlers, sondern postet sich selber dafuer
  86     // ein Ereignis
  87
  88 #define MAX_HISTORY_ENTRIES             50
  89
  90 // ===================================================================================================
  91 // Hilfsmethoden
  92
  93     // check if the control has one of the interfaces we can use for searching
  94     // *pCurrentText will be filled with the current text of the control (as used when searching this control)
  95
  96 // ===================================================================================================
  97 // Hilfsstrukturen
  98
  99 struct FmFoundRecordInformation
 100 {
 101     ::com::sun::star::uno::Any          aPosition;      // Bookmark des Datensatzes, in dem der Text gefunden wurde
 102     sal_Int16           nFieldPos;      // dito : die relative Position der Spalte (im Stringnamen in Feldliste im Constructor)
 103     sal_Int16           nContext;       // Kontext, in dem gesucht und gefunden wurde (falls die aktuelle Suche verschiedene solche kennt)
 104 };
 105
 106 DECLARE_STL_VECTOR( ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>, InterfaceArray);
 107     // TODO : use stl
 108
 109 // ===================================================================================================
 110 // = struct FmSearchContext - Informationen fuer Suche in verschiedenen Kontexten
 111 // ===================================================================================================
 112
 113 struct FmSearchContext
 114 {
 115     // [in]
 116     sal_Int16                                   nContext;               // die Nummer des Kontextes
 117     // [out]
 118     ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet>                       xCursor;                // der Iterator fuer diesen Kontext
 119     String                                      strUsedFields;  // eine Liste von durch ';' getrennten Feldnamen
 120     InterfaceArray                      arrFields;              // die korrespondierenden Text-Interfaces fuer die Felder in strUsedFields
 121     String                                      sFieldDisplayNames;             // if not empty : names to be displayed for the searchable fields (must have the same token count as strUsedFields !)
 122 };
 123
 124 // ===================================================================================================
 125 // = class FmSearchDialog - Dialog fuer Suchen in Formularen/Tabellen
 126 // ===================================================================================================
 127
 128 namespace svxform {
 129     class FmSearchConfigItem;
 130 }
 131
 132 class FmSearchEngine;
 133 struct FmSearchProgress;
 134
 135
 136 }//end of namespace binfilter
 137 #endif // _FMSEARCH_HXX