sdext/source/presenter/PresenterPaneContainer.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PresenterPaneContainer.cxx,v $
  10  *
  11  * $Revision: 1.5 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 // MARKER(update_precomp.py): autogen include statement, do not remove
  33 #include "precompiled_sdext.hxx"
  34
  35 #include "PresenterPaneContainer.hxx"
  36 #include "PresenterPaneBase.hxx"
  37 #include <com/sun/star/awt/XGraphics.hpp>
  38 #include <com/sun/star/beans/XPropertySet.hpp>
  39 #include <com/sun/star/container/XChild.hpp>
  40 #include <com/sun/star/drawing/framework/ResourceId.hpp>
  41 #include <vector>
  42
  43 using namespace ::com::sun::star;
  44 using namespace ::com::sun::star::uno;
  45 using namespace ::com::sun::star::drawing::framework;
  46 using ::rtl::OUString;
  47
  48 namespace sdext { namespace presenter {
  49
  50 PresenterPaneContainer::PresenterPaneContainer (
  51     const Reference<XComponentContext>& rxContext)
  52     : PresenterPaneContainerInterfaceBase(m_aMutex),
  53       maPanes(),
  54       mxPresenterHelper()
  55 {
  56     Reference<lang::XMultiComponentFactory> xFactory (rxContext->getServiceManager());
  57     if (xFactory.is())
  58     {
  59         mxPresenterHelper = Reference<drawing::XPresenterHelper>(
  60             xFactory->createInstanceWithContext(
  61                 OUString::createFromAscii("com.sun.star.comp.Draw.PresenterHelper"),
  62                 rxContext),
  63             UNO_QUERY_THROW);
  64     }
  65 }
  66
  67
  68
  69
  70 PresenterPaneContainer::~PresenterPaneContainer (void)
  71 {
  72 }
  73
  74
  75
  76
  77 void PresenterPaneContainer::PreparePane (
  78     const Reference<XResourceId>& rxPaneId,
  79     const OUString& rsViewURL,
  80     const OUString& rsTitle,
  81     const OUString& rsAccessibleTitle,
  82     const bool bIsOpaque,
  83     const ViewInitializationFunction& rViewInitialization,
  84     const double nLeft,
  85     const double nTop,
  86     const double nRight,
  87     const double nBottom)
  88 {
  89     if ( ! rxPaneId.is())
  90         return;
  91
  92     SharedPaneDescriptor pPane (FindPaneURL(rxPaneId->getResourceURL()));
  93     if (pPane.get() == NULL)
  94     {
  95         // No entry found for the given pane id.  Create a new one.
  96         SharedPaneDescriptor pDescriptor (new PaneDescriptor());
  97         pDescriptor->mxPaneId = rxPaneId;
  98         pDescriptor->msViewURL = rsViewURL;
  99         pDescriptor->mxPane = NULL;
 100         if (rsTitle.indexOf('%') < 0)
 101         {
 102             pDescriptor->msTitle = rsTitle;
 103             pDescriptor->msTitleTemplate = OUString();
 104         }
 105         else
 106         {
 107             pDescriptor->msTitleTemplate = rsTitle;
 108             pDescriptor->msTitle = OUString();
 109         }
 110         pDescriptor->msAccessibleTitleTemplate = rsAccessibleTitle;
 111         pDescriptor->maViewInitialization = rViewInitialization;
 112         pDescriptor->mnLeft = nLeft;
 113         pDescriptor->mnTop = nTop;
 114         pDescriptor->mnRight = nRight;
 115         pDescriptor->mnBottom = nBottom;
 116         pDescriptor->mbIsActive = true;
 117         pDescriptor->mbIsOpaque = bIsOpaque;
 118         pDescriptor->maSpriteProvider = PaneDescriptor::SpriteProvider();
 119         pDescriptor->mbIsSprite = false;
 120         pDescriptor->maCalloutAnchorLocation = awt::Point(-1,-1);
 121         pDescriptor->mbHasCalloutAnchor = false;
 122
 123         maPanes.push_back(pDescriptor);
 124     }
 125 }
 126
 127
 128
 129
 130 void SAL_CALL PresenterPaneContainer::disposing (void)
 131 {
 132     PaneList::iterator iPane (maPanes.begin());
 133     PaneList::const_iterator iEnd (maPanes.end());
 134     for ( ; iPane!=iEnd; ++iPane)
 135         if ((*iPane)->mxPaneId.is())
 136             RemovePane((*iPane)->mxPaneId);
 137 }
 138
 139
 140
 141
 142 PresenterPaneContainer::SharedPaneDescriptor
 143     PresenterPaneContainer::StorePane (const rtl::Reference<PresenterPaneBase>& rxPane)
 144 {
 145     SharedPaneDescriptor pDescriptor;
 146
 147     if (rxPane.is())
 148     {
 149         OUString sPaneURL;
 150         Reference<XResourceId> xPaneId (rxPane->getResourceId());
 151         if (xPaneId.is())
 152             sPaneURL = xPaneId->getResourceURL();
 153
 154         pDescriptor = FindPaneURL(sPaneURL);
 155         if (pDescriptor.get() == NULL)
 156             PreparePane(xPaneId, OUString(), OUString(), OUString(),
 157                 false, ViewInitializationFunction(), 0,0,0,0);
 158         pDescriptor = FindPaneURL(sPaneURL);
 159         if (pDescriptor.get() != NULL)
 160         {
 161             Reference<awt::XWindow> xWindow (rxPane->getWindow());
 162             pDescriptor->mxContentWindow = xWindow;
 163             pDescriptor->mxPaneId = xPaneId;
 164             pDescriptor->mxPane = rxPane;
 165             pDescriptor->mxPane->SetTitle(pDescriptor->msTitle);
 166
 167             // When there is a call out anchor location set then tell the
 168             // window about it.
 169             if (pDescriptor->mbHasCalloutAnchor)
 170                 pDescriptor->mxPane->SetCalloutAnchor(pDescriptor->maCalloutAnchorLocation);
 171
 172             if (xWindow.is())
 173                 xWindow->addEventListener(this);
 174         }
 175     }
 176
 177     return pDescriptor;
 178 }
 179
 180
 181
 182
 183 PresenterPaneContainer::SharedPaneDescriptor
 184     PresenterPaneContainer::StoreBorderWindow(
 185         const Reference<XResourceId>& rxPaneId,
 186         const Reference<awt::XWindow>& rxBorderWindow)
 187 {
 188     // The content window may not be present.  Use the resource URL of the
 189     // pane id as key.
 190     OUString sPaneURL;
 191     if (rxPaneId.is())
 192         sPaneURL = rxPaneId->getResourceURL();
 193
 194     SharedPaneDescriptor pDescriptor (FindPaneURL(sPaneURL));
 195     if (pDescriptor.get() != NULL)
 196     {
 197         pDescriptor->mxBorderWindow = rxBorderWindow;
 198         return pDescriptor;
 199     }
 200     else
 201         return SharedPaneDescriptor();
 202 }
 203
 204
 205
 206
 207 PresenterPaneContainer::SharedPaneDescriptor
 208     PresenterPaneContainer::StoreView (
 209         const Reference<XView>& rxView,
 210         const SharedBitmapDescriptor& rpViewBackground)
 211 {
 212     SharedPaneDescriptor pDescriptor;
 213
 214     if (rxView.is())
 215     {
 216         OUString sPaneURL;
 217         Reference<XResourceId> xViewId (rxView->getResourceId());
 218         if (xViewId.is())
 219         {
 220             Reference<XResourceId> xPaneId (xViewId->getAnchor());
 221             if (xPaneId.is())
 222                 sPaneURL = xPaneId->getResourceURL();
 223         }
 224
 225         pDescriptor = FindPaneURL(sPaneURL);
 226         if (pDescriptor.get() != NULL)
 227         {
 228             pDescriptor->mxView = rxView;
 229             pDescriptor->mpViewBackground = rpViewBackground;
 230             pDescriptor->mxPane->SetBackground(rpViewBackground);
 231             try
 232             {
 233                 if ( ! pDescriptor->maViewInitialization.empty())
 234                     pDescriptor->maViewInitialization(rxView);
 235
 236                 // Activate or deactivate the pane/view.
 237                 if ( ! pDescriptor->maActivator.empty())
 238                     pDescriptor->maActivator(pDescriptor->mbIsActive);
 239             }
 240             catch (RuntimeException&)
 241             {
 242                 OSL_ASSERT(false);
 243             }
 244         }
 245     }
 246
 247     return pDescriptor;
 248 }
 249
 250
 251
 252
 253 PresenterPaneContainer::SharedPaneDescriptor
 254     PresenterPaneContainer::RemovePane (const Reference<XResourceId>& rxPaneId)
 255 {
 256     SharedPaneDescriptor pDescriptor (FindPaneId(rxPaneId));
 257     if (pDescriptor.get() != NULL)
 258     {
 259         if (pDescriptor->mxContentWindow.is())
 260             pDescriptor->mxContentWindow->removeEventListener(this);
 261         pDescriptor->mxContentWindow = NULL;
 262         pDescriptor->mxBorderWindow = NULL;
 263         pDescriptor->mxPane = NULL;
 264         pDescriptor->mxView = NULL;
 265         pDescriptor->mbIsActive = false;
 266     }
 267     return pDescriptor;
 268 }
 269
 270
 271
 272
 273
 274 PresenterPaneContainer::SharedPaneDescriptor
 275     PresenterPaneContainer::RemoveView (const Reference<XView>& rxView)
 276 {
 277     SharedPaneDescriptor pDescriptor;
 278
 279     if (rxView.is())
 280     {
 281         OUString sPaneURL;
 282         Reference<XResourceId> xViewId (rxView->getResourceId());
 283         if (xViewId.is())
 284         {
 285             Reference<XResourceId> xPaneId (xViewId->getAnchor());
 286             if (xPaneId.is())
 287                 sPaneURL = xPaneId->getResourceURL();
 288         }
 289
 290         pDescriptor = FindPaneURL(sPaneURL);
 291         if (pDescriptor.get() != NULL)
 292         {
 293             pDescriptor->mxView = NULL;
 294             pDescriptor->mpViewBackground = SharedBitmapDescriptor();
 295         }
 296     }
 297
 298     return pDescriptor;
 299 }
 300
 301
 302
 303
 304 PresenterPaneContainer::SharedPaneDescriptor PresenterPaneContainer::FindBorderWindow (
 305     const Reference<awt::XWindow>& rxBorderWindow)
 306 {
 307     PaneList::const_iterator iPane;
 308     PaneList::iterator iEnd (maPanes.end());
 309     for (iPane=maPanes.begin(); iPane!=iEnd; ++iPane)
 310     {
 311         if ((*iPane)->mxBorderWindow == rxBorderWindow)
 312             return *iPane;
 313     }
 314     return SharedPaneDescriptor();
 315 }
 316
 317
 318
 319
 320 PresenterPaneContainer::SharedPaneDescriptor PresenterPaneContainer::FindContentWindow (
 321     const Reference<awt::XWindow>& rxContentWindow)
 322 {
 323     PaneList::const_iterator iPane;
 324     PaneList::iterator iEnd (maPanes.end());
 325     for (iPane=maPanes.begin(); iPane!=iEnd; ++iPane)
 326     {
 327         if ((*iPane)->mxContentWindow == rxContentWindow)
 328             return *iPane;
 329     }
 330     return SharedPaneDescriptor();
 331 }
 332
 333
 334
 335
 336 PresenterPaneContainer::SharedPaneDescriptor PresenterPaneContainer::FindPaneURL (
 337     const OUString& rsPaneURL)
 338 {
 339     PaneList::const_iterator iPane;
 340     PaneList::const_iterator iEnd (maPanes.end());
 341     for (iPane=maPanes.begin(); iPane!=iEnd; ++iPane)
 342     {
 343         if ((*iPane)->mxPaneId->getResourceURL() == rsPaneURL)
 344             return *iPane;
 345     }
 346     return SharedPaneDescriptor();
 347 }
 348
 349
 350
 351
 352 PresenterPaneContainer::SharedPaneDescriptor PresenterPaneContainer::FindPaneId (
 353     const Reference<XResourceId>& rxPaneId)
 354 {
 355     PaneList::iterator iEnd (maPanes.end());
 356
 357     if ( ! rxPaneId.is())
 358         return SharedPaneDescriptor();
 359
 360     PaneList::iterator iPane;
 361     for (iPane=maPanes.begin(); iPane!=iEnd; ++iPane)
 362     {
 363         if (rxPaneId->compareTo((*iPane)->mxPaneId) == 0)
 364             return *iPane;
 365     }
 366     return SharedPaneDescriptor();
 367 }
 368
 369
 370
 371
 372 PresenterPaneContainer::SharedPaneDescriptor PresenterPaneContainer::FindViewURL (
 373     const OUString& rsViewURL)
 374 {
 375     PaneList::iterator iEnd (maPanes.end());
 376     PaneList::iterator iPane;
 377     for (iPane=maPanes.begin(); iPane!=iEnd; ++iPane)
 378     {
 379         if (rsViewURL == (*iPane)->msViewURL)
 380             return *iPane;
 381     }
 382     return SharedPaneDescriptor();
 383 }
 384
 385
 386
 387
 388 ::rtl::OUString PresenterPaneContainer::GetPaneURLForViewURL (const ::rtl::OUString& rsViewURL)
 389 {
 390     SharedPaneDescriptor pDescriptor (FindViewURL(rsViewURL));
 391     if (pDescriptor.get() != NULL)
 392         if (pDescriptor->mxPaneId.is())
 393             return pDescriptor->mxPaneId->getResourceURL();
 394     return OUString();
 395 }
 396
 397
 398
 399
 400 void PresenterPaneContainer::ToTop (const SharedPaneDescriptor& rpDescriptor)
 401 {
 402     if (rpDescriptor.get() != NULL)
 403     {
 404         // Find iterator for pDescriptor.
 405         PaneList::iterator iPane;
 406         PaneList::iterator iEnd (maPanes.end());
 407         for (iPane=maPanes.begin(); iPane!=iEnd; ++iPane)
 408             if (iPane->get() == rpDescriptor.get())
 409                 break;
 410         OSL_ASSERT(iPane!=iEnd);
 411         if (iPane == iEnd)
 412             return;
 413
 414         if (mxPresenterHelper.is())
 415             mxPresenterHelper->toTop(rpDescriptor->mxBorderWindow);
 416
 417         maPanes.erase(iPane);
 418         maPanes.push_back(rpDescriptor);
 419     }
 420 }
 421
 422
 423
 424
 425 //----- XEventListener --------------------------------------------------------
 426
 427 void SAL_CALL PresenterPaneContainer::disposing (
 428     const com::sun::star::lang::EventObject& rEvent)
 429     throw (com::sun::star::uno::RuntimeException)
 430 {
 431     SharedPaneDescriptor pDescriptor (
 432         FindContentWindow(Reference<awt::XWindow>(rEvent.Source, UNO_QUERY)));
 433     if (pDescriptor.get() != NULL)
 434     {
 435         RemovePane(pDescriptor->mxPaneId);
 436     }
 437 }
 438
 439
 440
 441
 442 //===== PresenterPaneContainer::PaneDescriptor ================================
 443
 444 void PresenterPaneContainer::PaneDescriptor::SetActivationState (const bool bIsActive)
 445 {
 446     mbIsActive = bIsActive;
 447     if ( ! maActivator.empty())
 448         maActivator(mbIsActive);
 449 }
 450
 451 } } // end of namespace ::sdext::presenter