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 "ViewTabBar.hxx"
21 :
22 : #include "ViewShell.hxx"
23 : #include "ViewShellBase.hxx"
24 : #include "DrawViewShell.hxx"
25 : #include "FrameView.hxx"
26 : #include "EventMultiplexer.hxx"
27 : #include "framework/FrameworkHelper.hxx"
28 : #include "framework/Pane.hxx"
29 : #include "DrawController.hxx"
30 :
31 : #include "sdresid.hxx"
32 : #include "strings.hrc"
33 : #include "helpids.h"
34 : #include "Client.hxx"
35 : #include <vcl/svapp.hxx>
36 : #include <vcl/tabpage.hxx>
37 : #include <vcl/settings.hxx>
38 :
39 : #include <osl/mutex.hxx>
40 : #include <sfx2/viewfrm.hxx>
41 : #include <com/sun/star/drawing/framework/ResourceId.hpp>
42 : #include <com/sun/star/drawing/framework/XControllerManager.hpp>
43 : #include <com/sun/star/lang/XUnoTunnel.hpp>
44 : #include <com/sun/star/lang/DisposedException.hpp>
45 : #include <comphelper/processfactory.hxx>
46 : #include <comphelper/servicehelper.hxx>
47 : #include <tools/diagnose_ex.h>
48 :
49 : using namespace ::com::sun::star;
50 : using namespace ::com::sun::star::uno;
51 : using namespace ::com::sun::star::drawing::framework;
52 : using ::sd::framework::FrameworkHelper;
53 : using ::sd::tools::EventMultiplexerEvent;
54 :
55 : namespace sd {
56 :
57 : namespace {
58 1040 : bool IsEqual (const TabBarButton& rButton1, const TabBarButton& rButton2)
59 : {
60 : return (
61 1040 : (rButton1.ResourceId.is()
62 1040 : && rButton2.ResourceId.is()
63 1040 : && rButton1.ResourceId->compareTo(rButton2.ResourceId)==0)
64 1872 : || rButton1.ButtonLabel == rButton2.ButtonLabel);
65 : }
66 :
67 104 : class TabBarControl : public ::TabControl
68 : {
69 : public:
70 : TabBarControl (
71 : vcl::Window* pParentWindow,
72 : const ::rtl::Reference<ViewTabBar>& rpViewTabBar);
73 : virtual void Paint (const Rectangle& rRect) SAL_OVERRIDE;
74 : virtual void ActivatePage (void) SAL_OVERRIDE;
75 : private:
76 : ::rtl::Reference<ViewTabBar> mpViewTabBar;
77 : };
78 :
79 : } // end of anonymous namespace
80 :
81 52 : ViewTabBar::ViewTabBar (
82 : const Reference<XResourceId>& rxViewTabBarId,
83 : const Reference<frame::XController>& rxController)
84 : : ViewTabBarInterfaceBase(maMutex),
85 52 : mpTabControl(new TabBarControl(GetAnchorWindow(rxViewTabBarId,rxController), this)),
86 : mxController(rxController),
87 : maTabBarButtons(),
88 : mpTabPage(NULL),
89 : mxViewTabBarId(rxViewTabBarId),
90 104 : mpViewShellBase(NULL)
91 : {
92 : // Set one new tab page for all tab entries. We need it only to
93 : // determine the height of the tab bar.
94 52 : mpTabPage.reset(new TabPage (mpTabControl.get()));
95 52 : mpTabPage->Hide();
96 :
97 : // add some space before the tabitems
98 52 : mpTabControl->SetItemsOffset(Point(5, 3));
99 :
100 : // Tunnel through the controller and use the ViewShellBase to obtain the
101 : // view frame.
102 : try
103 : {
104 52 : Reference<lang::XUnoTunnel> xTunnel (mxController, UNO_QUERY_THROW);
105 : DrawController* pController = reinterpret_cast<DrawController*>(
106 52 : xTunnel->getSomething(DrawController::getUnoTunnelId()));
107 52 : mpViewShellBase = pController->GetViewShellBase();
108 : }
109 0 : catch (const RuntimeException&)
110 : {
111 : }
112 :
113 : // Register as listener at XConfigurationController.
114 52 : Reference<XControllerManager> xControllerManager (mxController, UNO_QUERY);
115 52 : if (xControllerManager.is())
116 : {
117 52 : mxConfigurationController = xControllerManager->getConfigurationController();
118 52 : if (mxConfigurationController.is())
119 : {
120 52 : mxConfigurationController->addConfigurationChangeListener(
121 : this,
122 : FrameworkHelper::msResourceActivationEvent,
123 52 : Any());
124 : }
125 : }
126 :
127 52 : mpTabControl->Show();
128 :
129 104 : if (mpViewShellBase != NULL
130 104 : && rxViewTabBarId->isBoundToURL(
131 52 : FrameworkHelper::msCenterPaneURL, AnchorBindingMode_DIRECT))
132 : {
133 52 : mpViewShellBase->SetViewTabBar(this);
134 52 : }
135 52 : }
136 :
137 104 : ViewTabBar::~ViewTabBar (void)
138 : {
139 104 : }
140 :
141 52 : void ViewTabBar::disposing (void)
142 : {
143 104 : if (mpViewShellBase != NULL
144 104 : && mxViewTabBarId->isBoundToURL(
145 52 : FrameworkHelper::msCenterPaneURL, AnchorBindingMode_DIRECT))
146 : {
147 52 : mpViewShellBase->SetViewTabBar(NULL);
148 : }
149 :
150 52 : if (mxConfigurationController.is())
151 : {
152 : // Unregister listener from XConfigurationController.
153 : try
154 : {
155 52 : mxConfigurationController->removeConfigurationChangeListener(this);
156 : }
157 0 : catch (const lang::DisposedException&)
158 : {
159 : // Receiving a disposed exception is the normal case. Is there
160 : // a way to avoid it?
161 : }
162 52 : mxConfigurationController = NULL;
163 : }
164 :
165 : {
166 52 : const SolarMutexGuard aSolarGuard;
167 : // Set all references to the one tab page to NULL and delete the page.
168 312 : for (sal_uInt16 nIndex=0; nIndex<mpTabControl->GetPageCount(); ++nIndex)
169 260 : mpTabControl->SetTabPage(nIndex, NULL);
170 52 : mpTabPage.reset();
171 52 : mpTabControl.reset();
172 : }
173 :
174 52 : mxController = NULL;
175 52 : }
176 :
177 52 : vcl::Window* ViewTabBar::GetAnchorWindow(
178 : const Reference<XResourceId>& rxViewTabBarId,
179 : const Reference<frame::XController>& rxController)
180 : {
181 52 : vcl::Window* pWindow = NULL;
182 52 : ViewShellBase* pBase = NULL;
183 :
184 : // Tunnel through the controller and use the ViewShellBase to obtain the
185 : // view frame.
186 : try
187 : {
188 52 : Reference<lang::XUnoTunnel> xTunnel (rxController, UNO_QUERY_THROW);
189 : DrawController* pController = reinterpret_cast<DrawController*>(
190 52 : xTunnel->getSomething(DrawController::getUnoTunnelId()));
191 52 : pBase = pController->GetViewShellBase();
192 : }
193 0 : catch (const RuntimeException&)
194 : {
195 : }
196 :
197 : // The ViewTabBar supports at the moment only the center pane.
198 104 : if (rxViewTabBarId.is()
199 104 : && rxViewTabBarId->isBoundToURL(
200 52 : FrameworkHelper::msCenterPaneURL, AnchorBindingMode_DIRECT))
201 : {
202 52 : if (pBase != NULL && pBase->GetViewFrame() != NULL)
203 52 : pWindow = &pBase->GetViewFrame()->GetWindow();
204 : }
205 :
206 : // The rest is (at the moment) just for the emergency case.
207 52 : if (pWindow == NULL)
208 : {
209 0 : Reference<XPane> xPane;
210 : try
211 : {
212 0 : Reference<XControllerManager> xControllerManager (rxController, UNO_QUERY_THROW);
213 : Reference<XConfigurationController> xCC (
214 0 : xControllerManager->getConfigurationController());
215 0 : if (xCC.is())
216 0 : xPane = Reference<XPane>(xCC->getResource(rxViewTabBarId->getAnchor()), UNO_QUERY);
217 : }
218 0 : catch (const RuntimeException&)
219 : {
220 : }
221 :
222 : // Tunnel through the XWindow to the VCL side.
223 : try
224 : {
225 0 : Reference<lang::XUnoTunnel> xTunnel (xPane, UNO_QUERY_THROW);
226 : framework::Pane* pPane = reinterpret_cast<framework::Pane*>(
227 0 : xTunnel->getSomething(framework::Pane::getUnoTunnelId()));
228 0 : if (pPane != NULL)
229 0 : pWindow = pPane->GetWindow()->GetParent();
230 : }
231 0 : catch (const RuntimeException&)
232 : {
233 0 : }
234 : }
235 :
236 52 : return pWindow;
237 : }
238 :
239 : //----- XConfigurationChangeListener ------------------------------------------
240 :
241 100 : void SAL_CALL ViewTabBar::notifyConfigurationChange (
242 : const ConfigurationChangeEvent& rEvent)
243 : throw (RuntimeException, std::exception)
244 : {
245 300 : if (rEvent.Type.equals(FrameworkHelper::msResourceActivationEvent)
246 300 : && rEvent.ResourceId->getResourceURL().match(FrameworkHelper::msViewURLPrefix)
247 324 : && rEvent.ResourceId->isBoundTo(mxViewTabBarId->getAnchor(), AnchorBindingMode_DIRECT))
248 : {
249 0 : UpdateActiveButton();
250 : }
251 100 : }
252 :
253 : //----- XEventListener --------------------------------------------------------
254 :
255 0 : void SAL_CALL ViewTabBar::disposing(
256 : const lang::EventObject& rEvent)
257 : throw (RuntimeException, std::exception)
258 : {
259 0 : if (rEvent.Source == mxConfigurationController)
260 : {
261 0 : mxConfigurationController = NULL;
262 0 : mxController = NULL;
263 : }
264 0 : }
265 :
266 : //----- XTabBar ---------------------------------------------------------------
267 :
268 260 : void SAL_CALL ViewTabBar::addTabBarButtonAfter (
269 : const TabBarButton& rButton,
270 : const TabBarButton& rAnchor)
271 : throw (::com::sun::star::uno::RuntimeException, std::exception)
272 : {
273 260 : const SolarMutexGuard aSolarGuard;
274 260 : AddTabBarButton(rButton, rAnchor);
275 260 : }
276 :
277 0 : void SAL_CALL ViewTabBar::appendTabBarButton (const TabBarButton& rButton)
278 : throw (::com::sun::star::uno::RuntimeException, std::exception)
279 : {
280 0 : const SolarMutexGuard aSolarGuard;
281 0 : AddTabBarButton(rButton);
282 0 : }
283 :
284 0 : void SAL_CALL ViewTabBar::removeTabBarButton (const TabBarButton& rButton)
285 : throw (::com::sun::star::uno::RuntimeException, std::exception)
286 : {
287 0 : const SolarMutexGuard aSolarGuard;
288 0 : RemoveTabBarButton(rButton);
289 0 : }
290 :
291 260 : sal_Bool SAL_CALL ViewTabBar::hasTabBarButton (const TabBarButton& rButton)
292 : throw (::com::sun::star::uno::RuntimeException, std::exception)
293 : {
294 260 : const SolarMutexGuard aSolarGuard;
295 260 : return HasTabBarButton(rButton);
296 : }
297 :
298 0 : Sequence<TabBarButton> SAL_CALL ViewTabBar::getTabBarButtons (void)
299 : throw (::com::sun::star::uno::RuntimeException, std::exception)
300 : {
301 0 : const SolarMutexGuard aSolarGuard;
302 0 : return GetTabBarButtons();
303 : }
304 :
305 : //----- XResource -------------------------------------------------------------
306 :
307 52 : Reference<XResourceId> SAL_CALL ViewTabBar::getResourceId (void)
308 : throw (RuntimeException, std::exception)
309 : {
310 52 : return mxViewTabBarId;
311 : }
312 :
313 168 : sal_Bool SAL_CALL ViewTabBar::isAnchorOnly (void)
314 : throw (RuntimeException, std::exception)
315 : {
316 168 : return false;
317 : }
318 :
319 : //----- XUnoTunnel ------------------------------------------------------------
320 :
321 : namespace
322 : {
323 : class theViewTabBarUnoTunnelId : public rtl::Static< UnoTunnelIdInit, theViewTabBarUnoTunnelId > {};
324 : }
325 :
326 0 : const Sequence<sal_Int8>& ViewTabBar::getUnoTunnelId (void)
327 : {
328 0 : return theViewTabBarUnoTunnelId::get().getSeq();
329 : }
330 :
331 0 : sal_Int64 SAL_CALL ViewTabBar::getSomething (const Sequence<sal_Int8>& rId)
332 : throw (RuntimeException, std::exception)
333 : {
334 0 : sal_Int64 nResult = 0;
335 :
336 0 : if (rId.getLength() == 16
337 0 : && memcmp(getUnoTunnelId().getConstArray(), rId.getConstArray(), 16) == 0)
338 : {
339 0 : nResult = reinterpret_cast<sal_Int64>(this);
340 : }
341 :
342 0 : return nResult;
343 : }
344 :
345 0 : bool ViewTabBar::ActivatePage (void)
346 : {
347 : try
348 : {
349 0 : Reference<XControllerManager> xControllerManager (mxController,UNO_QUERY_THROW);
350 : Reference<XConfigurationController> xConfigurationController (
351 0 : xControllerManager->getConfigurationController());
352 0 : if ( ! xConfigurationController.is())
353 0 : throw RuntimeException();
354 0 : Reference<XView> xView;
355 : try
356 : {
357 0 : xView = Reference<XView>(xConfigurationController->getResource(
358 : ResourceId::create(
359 : ::comphelper::getProcessComponentContext(),
360 0 : FrameworkHelper::msCenterPaneURL)),
361 0 : UNO_QUERY);
362 : }
363 0 : catch (const DeploymentException&)
364 : {
365 : }
366 :
367 0 : Client* pIPClient = NULL;
368 0 : if (mpViewShellBase != NULL)
369 0 : pIPClient = dynamic_cast<Client*>(mpViewShellBase->GetIPClient());
370 0 : if (pIPClient==NULL || ! pIPClient->IsObjectInPlaceActive())
371 : {
372 0 : sal_uInt16 nIndex (mpTabControl->GetCurPageId() - 1);
373 0 : if (nIndex < maTabBarButtons.size())
374 : {
375 0 : xConfigurationController->requestResourceActivation(
376 0 : maTabBarButtons[nIndex].ResourceId,
377 0 : ResourceActivationMode_REPLACE);
378 : }
379 :
380 0 : return true;
381 : }
382 : else
383 : {
384 : // When we run into this else branch then we have an active OLE
385 : // object. We ignore the request to switch views. Additionally
386 : // we put the active tab back to the one for the current view.
387 0 : UpdateActiveButton();
388 0 : }
389 : }
390 0 : catch (const RuntimeException&)
391 : {
392 : DBG_UNHANDLED_EXCEPTION();
393 : }
394 :
395 0 : return false;
396 : }
397 :
398 468 : int ViewTabBar::GetHeight (void)
399 : {
400 468 : int nHeight (0);
401 :
402 468 : if (!maTabBarButtons.empty())
403 : {
404 : TabPage* pActivePage (mpTabControl->GetTabPage(
405 468 : mpTabControl->GetCurPageId()));
406 468 : if (pActivePage!=NULL && mpTabControl->IsReallyVisible())
407 244 : nHeight = pActivePage->GetPosPixel().Y();
408 :
409 468 : if (nHeight <= 0)
410 : // Using a default when the real height can not be determined.
411 : // To get correct height this method should be called when the
412 : // control is visible.
413 224 : nHeight = 21;
414 : }
415 :
416 468 : return nHeight;
417 : }
418 :
419 260 : void ViewTabBar::AddTabBarButton (
420 : const ::com::sun::star::drawing::framework::TabBarButton& rButton,
421 : const ::com::sun::star::drawing::framework::TabBarButton& rAnchor)
422 : {
423 : sal_uInt32 nIndex;
424 :
425 832 : if ( ! rAnchor.ResourceId.is()
426 1040 : || (rAnchor.ResourceId->getResourceURL().isEmpty()
427 0 : && rAnchor.ButtonLabel.isEmpty()))
428 : {
429 52 : nIndex = 0;
430 : }
431 : else
432 : {
433 520 : for (nIndex=0; nIndex<maTabBarButtons.size(); ++nIndex)
434 : {
435 520 : if (IsEqual(maTabBarButtons[nIndex], rAnchor))
436 : {
437 208 : ++nIndex;
438 208 : break;
439 : }
440 : }
441 : }
442 :
443 260 : AddTabBarButton(rButton,nIndex);
444 260 : }
445 :
446 0 : void ViewTabBar::AddTabBarButton (
447 : const ::com::sun::star::drawing::framework::TabBarButton& rButton)
448 : {
449 0 : AddTabBarButton(rButton, maTabBarButtons.size());
450 0 : }
451 :
452 260 : void ViewTabBar::AddTabBarButton (
453 : const ::com::sun::star::drawing::framework::TabBarButton& rButton,
454 : sal_Int32 nPosition)
455 : {
456 260 : if (nPosition>=0
457 260 : && nPosition<=mpTabControl->GetPageCount())
458 : {
459 260 : sal_uInt16 nIndex ((sal_uInt16)nPosition);
460 :
461 : // Insert the button into our local array.
462 260 : maTabBarButtons.insert(maTabBarButtons.begin()+nIndex, rButton);
463 260 : UpdateTabBarButtons();
464 260 : UpdateActiveButton();
465 : }
466 260 : }
467 :
468 0 : void ViewTabBar::RemoveTabBarButton (
469 : const ::com::sun::star::drawing::framework::TabBarButton& rButton)
470 : {
471 : sal_uInt16 nIndex;
472 0 : for (nIndex=0; nIndex<maTabBarButtons.size(); ++nIndex)
473 : {
474 0 : if (IsEqual(maTabBarButtons[nIndex], rButton))
475 : {
476 0 : maTabBarButtons.erase(maTabBarButtons.begin()+nIndex);
477 0 : UpdateTabBarButtons();
478 0 : UpdateActiveButton();
479 0 : break;
480 : }
481 : }
482 0 : }
483 :
484 260 : bool ViewTabBar::HasTabBarButton (
485 : const ::com::sun::star::drawing::framework::TabBarButton& rButton)
486 : {
487 260 : bool bResult (false);
488 :
489 780 : for (sal_uInt32 nIndex=0; nIndex<maTabBarButtons.size(); ++nIndex)
490 : {
491 520 : if (IsEqual(maTabBarButtons[nIndex], rButton))
492 : {
493 0 : bResult = true;
494 0 : break;
495 : }
496 : }
497 :
498 260 : return bResult;
499 : }
500 :
501 : ::com::sun::star::uno::Sequence<com::sun::star::drawing::framework::TabBarButton>
502 0 : ViewTabBar::GetTabBarButtons (void)
503 : {
504 0 : sal_uInt32 nCount (maTabBarButtons.size());
505 : ::com::sun::star::uno::Sequence<com::sun::star::drawing::framework::TabBarButton>
506 0 : aList (nCount);
507 :
508 0 : for (sal_uInt32 nIndex=0; nIndex<nCount; ++nIndex)
509 0 : aList[nIndex] = maTabBarButtons[nIndex];
510 :
511 0 : return aList;
512 : }
513 :
514 260 : void ViewTabBar::UpdateActiveButton (void)
515 : {
516 260 : Reference<XView> xView;
517 260 : if (mpViewShellBase != NULL)
518 520 : xView = FrameworkHelper::Instance(*mpViewShellBase)->GetView(
519 520 : mxViewTabBarId->getAnchor());
520 260 : if (xView.is())
521 : {
522 260 : Reference<XResourceId> xViewId (xView->getResourceId());
523 260 : for (sal_uInt16 nIndex=0; nIndex<maTabBarButtons.size(); ++nIndex)
524 : {
525 260 : if (maTabBarButtons[nIndex].ResourceId->compareTo(xViewId) == 0)
526 : {
527 260 : mpTabControl->SetCurPageId(nIndex+1);
528 260 : mpTabControl->::TabControl::ActivatePage();
529 260 : break;
530 : }
531 260 : }
532 260 : }
533 260 : }
534 :
535 260 : void ViewTabBar::UpdateTabBarButtons (void)
536 : {
537 260 : TabBarButtonList::const_iterator iTab;
538 260 : sal_uInt16 nPageCount (mpTabControl->GetPageCount());
539 : sal_uInt16 nIndex;
540 1040 : for (iTab=maTabBarButtons.begin(),nIndex=1; iTab!=maTabBarButtons.end(); ++iTab,++nIndex)
541 : {
542 : // Create a new tab when there are not enough.
543 780 : if (nPageCount < nIndex)
544 260 : mpTabControl->InsertPage(nIndex, iTab->ButtonLabel);
545 :
546 : // Update the tab.
547 780 : mpTabControl->SetPageText(nIndex, iTab->ButtonLabel);
548 780 : mpTabControl->SetHelpText(nIndex, iTab->HelpText);
549 780 : mpTabControl->SetTabPage(nIndex, mpTabPage.get());
550 : }
551 :
552 : // Delete tabs that are no longer used.
553 260 : for (; nIndex<=nPageCount; ++nIndex)
554 0 : mpTabControl->RemovePage(nIndex);
555 :
556 260 : mpTabPage->Hide();
557 260 : }
558 :
559 : //===== TabBarControl =========================================================
560 :
561 52 : TabBarControl::TabBarControl (
562 : vcl::Window* pParentWindow,
563 : const ::rtl::Reference<ViewTabBar>& rpViewTabBar)
564 : : ::TabControl(pParentWindow),
565 52 : mpViewTabBar(rpViewTabBar)
566 : {
567 52 : }
568 :
569 25 : void TabBarControl::Paint (const Rectangle& rRect)
570 : {
571 25 : Color aOriginalFillColor (GetFillColor());
572 25 : Color aOriginalLineColor (GetLineColor());
573 :
574 : // Because the actual window background is transparent--to avoid
575 : // flickering due to multiple background paintings by this and by child
576 : // windows--we have to paint the background for this control explicitly:
577 : // the actual control is not painted over its whole bounding box.
578 25 : SetFillColor (GetSettings().GetStyleSettings().GetDialogColor());
579 25 : SetLineColor ();
580 25 : DrawRect (rRect);
581 25 : ::TabControl::Paint (rRect);
582 :
583 25 : SetFillColor (aOriginalFillColor);
584 25 : SetLineColor (aOriginalLineColor);
585 25 : }
586 :
587 0 : void TabBarControl::ActivatePage (void)
588 : {
589 0 : if (mpViewTabBar->ActivatePage())
590 : {
591 : // Call the parent so that the correct tab is highlighted.
592 0 : this->::TabControl::ActivatePage();
593 : }
594 0 : }
595 :
596 114 : } // end of namespace sd
597 :
598 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
