xref: /trunk/main/cui/source/inc/cuifmsearch.hxx (revision c4eee24d)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef _CUI_FMSEARCH_HXX
25 #define _CUI_FMSEARCH_HXX
26 
27 #include <com/sun/star/sdbc/XResultSet.hpp>
28 
29 #include <svx/fmsearch.hxx> //CHINA001
30 
31 #define _SVSTDARR_STRINGSDTOR
32 #include <svl/svstdarr.hxx>
33 
34 #ifndef _DIALOG_HXX //autogen
35 #include <vcl/dialog.hxx>
36 #endif
37 
38 #ifndef _BUTTON_HXX //autogen
39 #include <vcl/button.hxx>
40 #endif
41 
42 #ifndef _FIXED_HXX //autogen
43 #include <vcl/fixed.hxx>
44 #endif
45 
46 #ifndef _EDIT_HXX //autogen
47 #include <vcl/edit.hxx>
48 #endif
49 #include <vcl/combobox.hxx>
50 #include <vcl/lstbox.hxx>
51 #include <tools/link.hxx>
52 #include <comphelper/uno3.hxx>
53 #include <comphelper/stl_types.hxx>
54 #include <tools/string.hxx>
55 
56 namespace svxform {
57     class FmSearchConfigItem;
58 }
59 
60 // ===================================================================================================
61 // = class FmSearchDialog - Dialog fuer Suchen in Formularen/Tabellen
62 // ===================================================================================================
63 
64 struct FmSearchProgress;
65 
66 class FmSearchEngine;
67 
68 class FmSearchDialog : public ModalDialog
69 {
70 	friend class FmSearchEngine;
71 
72 	// meine ganzen Controls
73     FixedLine       m_flSearchFor;
74 	RadioButton		m_rbSearchForText;
75 	RadioButton		m_rbSearchForNull;
76 	RadioButton		m_rbSearchForNotNull;
77 	ComboBox		m_cmbSearchText;
78     FixedLine       m_flWhere;
79 	FixedText		m_ftForm;
80 	ListBox			m_lbForm;
81 	RadioButton		m_rbAllFields;
82 	RadioButton		m_rbSingleField;
83 	ListBox			m_lbField;
84     FixedLine       m_flOptions;
85 	FixedText		m_ftPosition;
86 	ListBox			m_lbPosition;
87 	CheckBox		m_cbUseFormat;
88 	CheckBox		m_cbCase;
89 	CheckBox		m_cbBackwards;
90 	CheckBox		m_cbStartOver;
91 	CheckBox		m_cbWildCard;
92 	CheckBox		m_cbRegular;
93 	CheckBox		m_cbApprox;
94 	PushButton		m_pbApproxSettings;
95 	CheckBox		m_aHalfFullFormsCJK;
96 	CheckBox		m_aSoundsLikeCJK;
97 	PushButton		m_aSoundsLikeCJKSettings;
98     FixedLine       m_flState;
99 	FixedText		m_ftRecordLabel;
100 	FixedText		m_ftRecord;
101 	FixedText		m_ftHint;
102 	PushButton		m_pbSearchAgain;
103 	CancelButton	m_pbClose;
104 	HelpButton		m_pbHelp;
105     String          m_sSearch;
106     String          m_sCancel;
107 
108 	Window*			m_pPreSearchFocus;
109 
110 	Link	m_lnkFoundHandler;			// Handler fuer "gefunden"
111 	Link	m_lnkCanceledNotFoundHdl;	// Handler fuer Positionierung des Cursors
112 
113 	Link	m_lnkContextSupplier;		// fuer Suche in verschiedenen Kontexten
114 
115 	// ein Array, in dem ich mir fuer jeden Kontext das aktuell selektierte Feld merke
116 	::std::vector<String> m_arrContextFields;
117 
118 	// fuer die eigentliche Arbeit ...
119 	FmSearchEngine*	m_pSearchEngine;
120 
121 	Timer			m_aDelayedPaint;
122 		// siehe EnableSearchUI
123 
124 	::svxform::FmSearchConfigItem*		m_pConfig;
125 public:
126 	/**	hiermit kann in verschiedenen Saetzen von Feldern gesucht werden. Es gibt eine Reihe von Kontexten, deren Namen in
127 		strContexts stehen (getrennt durch ';'), der Benutzer kann einen davon auswaehlen.
128 		Wenn der Benutzer einen Kontext auswaehlt, wird lnkContextSupplier aufgerufen, er bekommt einen Zeiger auf eine
129 		FmSearchContext-Struktur, die gefuellt werden muss.
130 		Fuer die Suche gilt dann :
131 		a) bei formatierter Suche wird der Iterator selber verwendet (wie beim ersten Constructor auch)
132 		b) bei formatierter Suche wird NICHT der FormatKey an den Fields des Iterators verwendet, sondern die entsprechende
133 			TextComponent wird gefragt (deshalb auch die Verwendung des originalen Iterator, durch dessen Move werden hoffentlich
134 			die hinter den TextComponent-Interfaces stehenden Controls geupdatet)
135 		c) bei nicht formatierter Suche wird ein Clone des Iterators verwendet (da ich hier die TextComponent-Interfaces nicht
136 			fragen muss)
137 		(natuerlich zwingend erforderlich : der String Nummer i in strUsedFields eines Kontexts muss mit dem Interface Nummer i
138 		in arrFields des Kontexts korrespondieren)
139 	*/
140     FmSearchDialog(Window* pParent, const String& strInitialText, const ::std::vector< String >& _rContexts, sal_Int16 nInitialContext,
141 		const Link& lnkContextSupplier);
142 
143 	virtual ~FmSearchDialog();
144 
145 	/** der Found-Handler bekommt im "gefunden"-Fall einen Zeiger auf eine FmFoundRecordInformation-Struktur
146 		(dieser ist nur im Handler gueltig, wenn man sich also die Daten merken muss, nicht den Zeiger, sondern die
147 		Struktur kopieren)
148 		Dieser Handler MUSS gesetzt werden.
149 		Ausserdem sollte beachtet werden, dass waehrend des Handlers der Suchdialog immer noch modal ist
150 	*/
151 	void SetFoundHandler(const Link& lnk) { m_lnkFoundHandler = lnk; }
152 	/**
153 		Wenn die Suche abgebrochen oder erfolglos beendet wurde, wird im Suchdialog immer der aktuelle Datensatz angezeigt
154 		Damit das mit der eventuellen Anzeige des Aufrufers synchron geht, existiert dieser Handler (der nicht undbedingt gesetzt
155 		werden muss).
156 		Der dem Handler uebergebene Zeiger zeigt auf eine FmFoundRecordInformation-Struktur, bei der aPosition und eventuell
157 		(bei Suche mit Kontexten) nContext gueltig sind.
158 	*/
159 	void SetCanceledNotFoundHdl(const Link& lnk) { m_lnkCanceledNotFoundHdl = lnk; }
160 
161 	inline void SetActiveField(const String& strField);
162 
163 protected:
164 	virtual sal_Bool Close();
165 
166 	void Init(const String& strVisibleFields, const String& strInitialText);
167 		// nur von den Constructoren aus zu verwenden
168 
169 	void OnFound(const ::com::sun::star::uno::Any& aCursorPos, sal_Int16 nFieldPos);
170 
171 	void EnableSearchUI(sal_Bool bEnable);
172 		// beim Suchen in einem eigenen Thread moechte ich natuerlich die UI zum Starten/Parameter-Setzen der Suche disablen
173 		// Bei bEnable == sal_False wird fuer alle betroffenen Controls das Painten kurz aus- und mittels m_aDelayedPaint nach
174 		// einer kurzen Weile wieder angeschaltet. Wenn inzwischen eine Anforderung mit bEnable==sal_True kommt, wird der Timer gestoppt
175 		// und das Painten gleich wieder angeschaltet. Als Konsequenz dieses umstaendlichen Vorgehens ist kein Flackern zu sehen,
176 		// wenn man schnell hintereinander aus- und wieder einschaltet.
177 
178 	void EnableSearchForDependees(sal_Bool bEnable);
179 
180 	void EnableControlPaint(sal_Bool bEnable);
181 		// enabled (disabled) fuer alle wichtigen Controls ihr Paint
182 
183 	void InitContext(sal_Int16 nContext);
184 
185 	void LoadParams();
186 	void SaveParams() const;
187 
188 private:
189 	// Handler fuer die Controls
190 	DECL_LINK( OnClickedFieldRadios, Button* );
191 	DECL_LINK( OnClickedSearchAgain, Button* );
192 	DECL_LINK( OnClickedSpecialSettings, Button* );
193 
194 	DECL_LINK( OnSearchTextModified, ComboBox* );
195 
196 	DECL_LINK( OnPositionSelected, ListBox* );
197 	DECL_LINK( OnFieldSelected, ListBox* );
198 
199 	DECL_LINK( OnCheckBoxToggled, CheckBox* );
200 
201 	DECL_LINK( OnContextSelection, ListBox* );
202 
203 	// Such-Fortschritt
204 	DECL_LINK( OnSearchProgress, FmSearchProgress* );
205 
206 	DECL_LINK( OnDelayedPaint, void* );
207 		// siehe EnableSearchUI
208 
209 	void implMoveControls(Control** _ppControls, sal_Int32 _nControls, sal_Int32 _nUp, Control* _pToResize);
210 
211 	void initCommon( const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >& _rxCursor );
212 };
213 
214 inline void FmSearchDialog::SetActiveField(const String& strField)
215 {
216 	sal_uInt16 nInitialField = m_lbField.GetEntryPos(strField);
217 	if (nInitialField == COMBOBOX_ENTRY_NOTFOUND)
218 		nInitialField = 0;
219 	m_lbField.SelectEntryPos(nInitialField);
220 	LINK(this, FmSearchDialog, OnFieldSelected).Call(&m_lbField);
221 }
222 
223 #endif // _CUI_FMSEARCH_HXX
224