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