Line data Source code
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 : #include "propertyeditor.hxx"
21 : #include "browserpage.hxx"
22 : #include "linedescriptor.hxx"
23 :
24 : #include <tools/debug.hxx>
25 :
26 :
27 : namespace pcr
28 : {
29 :
30 :
31 : #define LAYOUT_BORDER_LEFT 3
32 : #define LAYOUT_BORDER_TOP 3
33 : #define LAYOUT_BORDER_RIGHT 3
34 : #define LAYOUT_BORDER_BOTTOM 3
35 :
36 : using ::com::sun::star::uno::Any;
37 : using ::com::sun::star::inspection::XPropertyControl;
38 : using ::com::sun::star::uno::Reference;
39 :
40 :
41 : // class OPropertyEditor
42 :
43 :
44 4 : OPropertyEditor::OPropertyEditor( vcl::Window* pParent, WinBits nWinStyle)
45 : :Control(pParent, nWinStyle)
46 : ,m_aTabControl( this )
47 : ,m_pListener(NULL)
48 : ,m_pObserver(NULL)
49 : ,m_nNextId(1)
50 : ,m_bHasHelpSection( false )
51 : ,m_nMinHelpLines( 0 )
52 4 : ,m_nMaxHelpLines( 0 )
53 : {
54 :
55 4 : m_aTabControl.Show();
56 4 : m_aTabControl.SetDeactivatePageHdl(LINK(this, OPropertyEditor, OnPageDeactivate));
57 4 : m_aTabControl.SetActivatePageHdl(LINK(this, OPropertyEditor, OnPageActivate));
58 4 : m_aTabControl.SetBackground(GetBackground());
59 4 : m_aTabControl.SetPaintTransparent(true);
60 4 : }
61 :
62 :
63 12 : OPropertyEditor::~OPropertyEditor()
64 : {
65 4 : Hide();
66 4 : ClearAll();
67 8 : }
68 :
69 :
70 8 : void OPropertyEditor::ClearAll()
71 : {
72 8 : m_nNextId=1;
73 8 : sal_uInt16 nCount = m_aTabControl.GetPageCount();
74 8 : for(long i = nCount-1; i >= 0; --i)
75 : {
76 0 : sal_uInt16 nID = m_aTabControl.GetPageId((sal_uInt16)i);
77 0 : OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(nID));
78 0 : if (pPage)
79 : {
80 0 : pPage->EnableInput(false);
81 0 : m_aTabControl.RemovePage(nID);
82 0 : delete pPage;
83 : }
84 : }
85 8 : m_aTabControl.Clear();
86 :
87 : {
88 8 : MapStringToPageId aEmpty;
89 8 : m_aPropertyPageIds.swap( aEmpty );
90 : }
91 :
92 16 : while ( !m_aHiddenPages.empty() )
93 : {
94 0 : delete m_aHiddenPages.begin()->second.pPage;
95 0 : m_aHiddenPages.erase( m_aHiddenPages.begin() );
96 : }
97 8 : }
98 :
99 :
100 0 : sal_Int32 OPropertyEditor::getMinimumHeight()
101 : {
102 0 : sal_Int32 nMinHeight( LAYOUT_BORDER_TOP + LAYOUT_BORDER_BOTTOM );
103 :
104 0 : if ( m_aTabControl.GetPageCount() > 0 )
105 : {
106 0 : sal_uInt16 nFirstID = m_aTabControl.GetPageId( 0 );
107 :
108 : // reserve space for the tabs themself
109 0 : Rectangle aTabArea( m_aTabControl.GetTabBounds( nFirstID ) );
110 0 : nMinHeight += aTabArea.GetHeight();
111 :
112 : // ask the page how much it requires
113 0 : OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( nFirstID ) );
114 0 : if ( pPage )
115 0 : nMinHeight += pPage->getMinimumHeight();
116 : }
117 : else
118 0 : nMinHeight += 250; // arbitrary ...
119 :
120 0 : return nMinHeight;
121 : }
122 :
123 :
124 0 : sal_Int32 OPropertyEditor::getMinimumWidth()
125 : {
126 0 : sal_uInt16 nCount = m_aTabControl.GetPageCount();
127 0 : sal_Int32 nPageMinWidth = 0;
128 0 : for(long i = nCount-1; i >= 0; --i)
129 : {
130 0 : sal_uInt16 nID = m_aTabControl.GetPageId((sal_uInt16)i);
131 0 : OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(nID));
132 0 : if (pPage)
133 : {
134 0 : sal_Int32 nCurPageMinWidth = pPage->getMinimumWidth();
135 0 : if( nCurPageMinWidth > nPageMinWidth )
136 0 : nPageMinWidth = nCurPageMinWidth;
137 : }
138 : }
139 0 : return nPageMinWidth+6;
140 : }
141 :
142 :
143 4 : void OPropertyEditor::CommitModified()
144 : {
145 : // commit all of my pages, if necessary
146 :
147 4 : sal_uInt16 nCount = m_aTabControl.GetPageCount();
148 4 : for ( sal_uInt16 i=0; i<nCount; ++i )
149 : {
150 0 : sal_uInt16 nID = m_aTabControl.GetPageId( i );
151 0 : OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( nID ) );
152 :
153 0 : if ( pPage && pPage->getListBox().IsModified() )
154 0 : pPage->getListBox().CommitModified();
155 : }
156 4 : }
157 :
158 :
159 0 : void OPropertyEditor::GetFocus()
160 : {
161 0 : m_aTabControl.GrabFocus();
162 0 : }
163 :
164 :
165 0 : OBrowserPage* OPropertyEditor::getPage( const OUString& _rPropertyName )
166 : {
167 0 : OBrowserPage* pPage = NULL;
168 0 : MapStringToPageId::const_iterator aPropertyPageIdPos = m_aPropertyPageIds.find( _rPropertyName );
169 0 : if ( aPropertyPageIdPos != m_aPropertyPageIds.end() )
170 0 : pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( aPropertyPageIdPos->second ) );
171 0 : return pPage;
172 : }
173 :
174 :
175 0 : const OBrowserPage* OPropertyEditor::getPage( const OUString& _rPropertyName ) const
176 : {
177 0 : return const_cast< OPropertyEditor* >( this )->getPage( _rPropertyName );
178 : }
179 :
180 :
181 0 : OBrowserPage* OPropertyEditor::getPage( sal_uInt16& _rPageId )
182 : {
183 0 : return static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( _rPageId ) );
184 : }
185 :
186 :
187 0 : const OBrowserPage* OPropertyEditor::getPage( sal_uInt16& _rPageId ) const
188 : {
189 0 : return const_cast< OPropertyEditor* >( this )->getPage( _rPageId );
190 : }
191 :
192 :
193 4 : void OPropertyEditor::Resize()
194 : {
195 : Rectangle aPlayground(
196 : Point( LAYOUT_BORDER_LEFT, LAYOUT_BORDER_TOP ),
197 : Size(
198 8 : GetOutputSizePixel().Width() - LAYOUT_BORDER_LEFT - LAYOUT_BORDER_RIGHT,
199 8 : GetOutputSizePixel().Height() - LAYOUT_BORDER_TOP - LAYOUT_BORDER_BOTTOM
200 : )
201 8 : );
202 :
203 4 : Rectangle aTabArea( aPlayground );
204 4 : m_aTabControl.SetPosSizePixel( aTabArea.TopLeft(), aTabArea.GetSize() );
205 4 : }
206 :
207 :
208 0 : sal_uInt16 OPropertyEditor::AppendPage( const OUString & _rText, const OString& _rHelpId )
209 : {
210 : // obtain a new id
211 0 : sal_uInt16 nId = m_nNextId++;
212 : // insert the id
213 0 : m_aTabControl.InsertPage(nId, _rText);
214 :
215 : // create a new page
216 0 : OBrowserPage* pPage = new OBrowserPage(&m_aTabControl);
217 0 : pPage->SetText( _rText );
218 : // some knittings
219 0 : pPage->SetSizePixel(m_aTabControl.GetTabPageSizePixel());
220 0 : pPage->getListBox().SetListener(m_pListener);
221 0 : pPage->getListBox().SetObserver(m_pObserver);
222 0 : pPage->getListBox().EnableHelpSection( m_bHasHelpSection );
223 0 : pPage->getListBox().SetHelpLineLimites( m_nMinHelpLines, m_nMaxHelpLines );
224 0 : pPage->SetHelpId( _rHelpId );
225 :
226 : // immediately activate the page
227 0 : m_aTabControl.SetTabPage(nId, pPage);
228 0 : m_aTabControl.SetCurPageId(nId);
229 :
230 0 : return nId;
231 : }
232 :
233 :
234 4 : void OPropertyEditor::SetHelpId( const OString& rHelpId )
235 : {
236 4 : Control::SetHelpId("");
237 4 : m_aTabControl.SetHelpId(rHelpId);
238 4 : }
239 :
240 :
241 0 : void OPropertyEditor::RemovePage(sal_uInt16 nID)
242 : {
243 0 : OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(nID));
244 :
245 0 : if (pPage)
246 0 : pPage->EnableInput(false);
247 0 : m_aTabControl.RemovePage(nID);
248 0 : if (pPage)
249 0 : delete pPage;
250 0 : }
251 :
252 :
253 0 : void OPropertyEditor::SetPage(sal_uInt16 nId)
254 : {
255 0 : m_aTabControl.SetCurPageId(nId);
256 0 : }
257 :
258 :
259 4 : sal_uInt16 OPropertyEditor::GetCurPage()
260 : {
261 4 : if(m_aTabControl.GetPageCount()>0)
262 0 : return m_aTabControl.GetCurPageId();
263 : else
264 4 : return 0;
265 : }
266 :
267 :
268 8 : void OPropertyEditor::Update(const ::std::mem_fun_t<void,OBrowserListBox>& _aUpdateFunction)
269 : {
270 : // forward this to all our pages
271 8 : sal_uInt16 nCount = m_aTabControl.GetPageCount();
272 8 : for (sal_uInt16 i=0;i<nCount;++i)
273 : {
274 0 : sal_uInt16 nID = m_aTabControl.GetPageId(i);
275 0 : OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(nID));
276 0 : if (pPage)
277 0 : _aUpdateFunction(&pPage->getListBox());
278 : }
279 8 : }
280 :
281 4 : void OPropertyEditor::EnableUpdate()
282 : {
283 4 : Update(::std::mem_fun(&OBrowserListBox::EnableUpdate));
284 4 : }
285 :
286 4 : void OPropertyEditor::DisableUpdate()
287 : {
288 4 : Update(::std::mem_fun(&OBrowserListBox::DisableUpdate));
289 4 : }
290 :
291 :
292 16 : void OPropertyEditor::forEachPage( PageOperation _pOperation, const void* _pArgument )
293 : {
294 16 : sal_uInt16 nCount = m_aTabControl.GetPageCount();
295 16 : for ( sal_uInt16 i=0; i<nCount; ++i )
296 : {
297 0 : sal_uInt16 nID = m_aTabControl.GetPageId(i);
298 0 : OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( nID ) );
299 0 : if ( !pPage )
300 0 : continue;
301 0 : (this->*_pOperation)( *pPage, _pArgument );
302 : }
303 16 : }
304 :
305 :
306 0 : void OPropertyEditor::setPageLineListener( OBrowserPage& _rPage, const void* )
307 : {
308 0 : _rPage.getListBox().SetListener( m_pListener );
309 0 : }
310 :
311 :
312 4 : void OPropertyEditor::SetLineListener(IPropertyLineListener* _pListener)
313 : {
314 4 : m_pListener = _pListener;
315 4 : forEachPage( &OPropertyEditor::setPageLineListener );
316 4 : }
317 :
318 :
319 0 : void OPropertyEditor::setPageControlObserver( OBrowserPage& _rPage, const void* )
320 : {
321 0 : _rPage.getListBox().SetObserver( m_pObserver );
322 0 : }
323 :
324 :
325 4 : void OPropertyEditor::SetControlObserver( IPropertyControlObserver* _pObserver )
326 : {
327 4 : m_pObserver = _pObserver;
328 4 : forEachPage( &OPropertyEditor::setPageControlObserver );
329 4 : }
330 :
331 :
332 4 : void OPropertyEditor::EnableHelpSection( bool _bEnable )
333 : {
334 4 : m_bHasHelpSection = _bEnable;
335 4 : forEachPage( &OPropertyEditor::enableHelpSection );
336 4 : }
337 :
338 :
339 :
340 :
341 0 : void OPropertyEditor::SetHelpText( const OUString& _rHelpText )
342 : {
343 0 : forEachPage( &OPropertyEditor::setHelpSectionText, &_rHelpText );
344 0 : }
345 :
346 :
347 4 : void OPropertyEditor::SetHelpLineLimites( sal_Int32 _nMinLines, sal_Int32 _nMaxLines )
348 : {
349 4 : m_nMinHelpLines = _nMinLines;
350 4 : m_nMaxHelpLines = _nMaxLines;
351 4 : forEachPage( &OPropertyEditor::setHelpLineLimits );
352 4 : }
353 :
354 :
355 0 : void OPropertyEditor::enableHelpSection( OBrowserPage& _rPage, const void* )
356 : {
357 0 : _rPage.getListBox().EnableHelpSection( m_bHasHelpSection );
358 0 : }
359 :
360 :
361 0 : void OPropertyEditor::setHelpSectionText( OBrowserPage& _rPage, const void* _pPointerToOUString )
362 : {
363 : OSL_ENSURE( _pPointerToOUString, "OPropertyEditor::setHelpSectionText: invalid argument!" );
364 0 : if ( !_pPointerToOUString )
365 0 : return;
366 :
367 0 : const OUString& rText( *(const OUString*)_pPointerToOUString );
368 0 : _rPage.getListBox().SetHelpText( rText );
369 : }
370 :
371 :
372 0 : void OPropertyEditor::setHelpLineLimits( OBrowserPage& _rPage, const void* )
373 : {
374 0 : _rPage.getListBox().SetHelpLineLimites( m_nMinHelpLines, m_nMaxHelpLines );
375 0 : }
376 :
377 :
378 0 : sal_uInt16 OPropertyEditor::InsertEntry( const OLineDescriptor& rData, sal_uInt16 _nPageId, sal_uInt16 nPos )
379 : {
380 : // let the current page handle this
381 0 : OBrowserPage* pPage = getPage( _nPageId );
382 : DBG_ASSERT( pPage, "OPropertyEditor::InsertEntry: don't have such a page!" );
383 0 : if ( !pPage )
384 0 : return EDITOR_LIST_ENTRY_NOTFOUND;
385 :
386 0 : sal_uInt16 nEntry = pPage->getListBox().InsertEntry( rData, nPos );
387 :
388 : OSL_ENSURE( m_aPropertyPageIds.find( rData.sName ) == m_aPropertyPageIds.end(),
389 : "OPropertyEditor::InsertEntry: property already present in the map!" );
390 0 : m_aPropertyPageIds.insert( MapStringToPageId::value_type( rData.sName, _nPageId ) );
391 :
392 0 : return nEntry;
393 : }
394 :
395 :
396 0 : void OPropertyEditor::RemoveEntry( const OUString& _rName )
397 : {
398 0 : OBrowserPage* pPage = getPage( _rName );
399 0 : if ( pPage )
400 : {
401 0 : OSL_VERIFY( pPage->getListBox().RemoveEntry( _rName ) );
402 :
403 : OSL_ENSURE( m_aPropertyPageIds.find( _rName ) != m_aPropertyPageIds.end(),
404 : "OPropertyEditor::RemoveEntry: property not present in the map!" );
405 0 : m_aPropertyPageIds.erase( _rName );
406 : }
407 0 : }
408 :
409 :
410 0 : void OPropertyEditor::ChangeEntry( const OLineDescriptor& rData )
411 : {
412 0 : OBrowserPage* pPage = getPage( rData.sName );
413 0 : if ( pPage )
414 0 : pPage->getListBox().ChangeEntry( rData, EDITOR_LIST_REPLACE_EXISTING );
415 0 : }
416 :
417 :
418 0 : void OPropertyEditor::SetPropertyValue( const OUString& rEntryName, const Any& _rValue, bool _bUnknownValue )
419 : {
420 0 : OBrowserPage* pPage = getPage( rEntryName );
421 0 : if ( pPage )
422 0 : pPage->getListBox().SetPropertyValue( rEntryName, _rValue, _bUnknownValue );
423 0 : }
424 :
425 :
426 0 : sal_uInt16 OPropertyEditor::GetPropertyPos( const OUString& rEntryName ) const
427 : {
428 0 : sal_uInt16 nVal=EDITOR_LIST_ENTRY_NOTFOUND;
429 0 : const OBrowserPage* pPage = getPage( rEntryName );
430 0 : if ( pPage )
431 0 : nVal = pPage->getListBox().GetPropertyPos( rEntryName );
432 0 : return nVal;
433 : }
434 :
435 :
436 0 : void OPropertyEditor::ShowPropertyPage( sal_uInt16 _nPageId, bool _bShow )
437 : {
438 0 : if ( !_bShow )
439 : {
440 0 : sal_uInt16 nPagePos = m_aTabControl.GetPagePos( _nPageId );
441 0 : if ( TAB_PAGE_NOTFOUND == nPagePos )
442 0 : return;
443 : DBG_ASSERT( m_aHiddenPages.find( _nPageId ) == m_aHiddenPages.end(), "OPropertyEditor::ShowPropertyPage: page already hidden!" );
444 :
445 0 : m_aHiddenPages[ _nPageId ] = HiddenPage( nPagePos, m_aTabControl.GetTabPage( _nPageId ) );
446 0 : m_aTabControl.RemovePage( _nPageId );
447 : }
448 : else
449 : {
450 0 : ::std::map< sal_uInt16, HiddenPage >::iterator aPagePos = m_aHiddenPages.find( _nPageId );
451 0 : if ( aPagePos == m_aHiddenPages.end() )
452 0 : return;
453 :
454 0 : aPagePos->second.pPage->SetSizePixel( m_aTabControl.GetTabPageSizePixel() );
455 0 : m_aTabControl.InsertPage( aPagePos->first, aPagePos->second.pPage->GetText(), aPagePos->second.nPos );
456 0 : m_aTabControl.SetTabPage( aPagePos->first, aPagePos->second.pPage );
457 :
458 0 : m_aHiddenPages.erase( aPagePos );
459 : }
460 : }
461 :
462 :
463 0 : void OPropertyEditor::EnablePropertyControls( const OUString& _rEntryName, sal_Int16 _nControls, bool _bEnable )
464 : {
465 0 : for ( sal_uInt16 i = 0; i < m_aTabControl.GetPageCount(); ++i )
466 : {
467 0 : OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( m_aTabControl.GetPageId( i ) ) );
468 0 : if ( pPage )
469 0 : pPage->getListBox().EnablePropertyControls( _rEntryName, _nControls, _bEnable );
470 : }
471 0 : }
472 :
473 :
474 0 : void OPropertyEditor::EnablePropertyLine( const OUString& _rEntryName, bool _bEnable )
475 : {
476 0 : for ( sal_uInt16 i = 0; i < m_aTabControl.GetPageCount(); ++i )
477 : {
478 0 : OBrowserPage* pPage = static_cast< OBrowserPage* >( m_aTabControl.GetTabPage( m_aTabControl.GetPageId( i ) ) );
479 0 : if ( pPage )
480 0 : pPage->getListBox().EnablePropertyLine( _rEntryName, _bEnable );
481 : }
482 0 : }
483 :
484 :
485 0 : Reference< XPropertyControl > OPropertyEditor::GetPropertyControl(const OUString& rEntryName)
486 : {
487 0 : Reference< XPropertyControl > xControl;
488 : // let the current page handle this
489 0 : OBrowserPage* pPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage(m_aTabControl.GetCurPageId()));
490 0 : if (pPage)
491 0 : xControl = pPage->getListBox().GetPropertyControl(rEntryName);
492 0 : return xControl;
493 : }
494 :
495 :
496 0 : IMPL_LINK_NOARG(OPropertyEditor, OnPageActivate)
497 : {
498 0 : if (m_aPageActivationHandler.IsSet())
499 0 : m_aPageActivationHandler.Call(NULL);
500 0 : return 0L;
501 : }
502 :
503 :
504 0 : IMPL_LINK_NOARG(OPropertyEditor, OnPageDeactivate)
505 : {
506 : // commit the data on the current (to-be-decativated) tab page
507 : // (79404)
508 0 : sal_Int32 nCurrentId = m_aTabControl.GetCurPageId();
509 0 : OBrowserPage* pCurrentPage = static_cast<OBrowserPage*>(m_aTabControl.GetTabPage((sal_uInt16)nCurrentId));
510 0 : if ( !pCurrentPage )
511 0 : return 1L;
512 :
513 0 : if ( pCurrentPage->getListBox().IsModified() )
514 0 : pCurrentPage->getListBox().CommitModified();
515 :
516 0 : return 1L;
517 : }
518 :
519 :
520 12 : } // namespace pcr
521 :
522 :
523 :
524 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
