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