sfx2/source/sidebar/SidebarToolBox.cxx

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 #include "sfx2/sidebar/SidebarToolBox.hxx"
  20 #include "ToolBoxBackground.hxx"
  21 #include "sfx2/sidebar/ControllerFactory.hxx"
  22 #include "sfx2/sidebar/Theme.hxx"
  23 #include "sfx2/sidebar/Tools.hxx"
  24
  25 #include <vcl/gradient.hxx>
  26 #include <toolkit/helper/vclunohelper.hxx>
  27 #include <svtools/miscopt.hxx>
  28 #include <framework/imageproducer.hxx>
  29 #include <com/sun/star/frame/XSubToolbarController.hpp>
  30
  31
  32 using namespace ::com::sun::star;
  33 using namespace ::com::sun::star::uno;
  34 using ::rtl::OUString;
  35
  36
  37 namespace sfx2 { namespace sidebar {
  38
  39
  40 SidebarToolBox::SidebarToolBox (
  41     Window* pParentWindow,
  42     const ResId& rResId,
  43     const cssu::Reference<css::frame::XFrame>& rxFrame)
  44     : ToolBox(pParentWindow, rResId),
  45       mbParentIsBorder(false),
  46       maItemSeparator(Theme::GetImage(Theme::Image_ToolBoxItemSeparator)),
  47       maControllers(),
  48       mbAreHandlersRegistered(false)
  49 {
  50     SetBackground(Wallpaper());
  51     SetPaintTransparent(true);
  52     SetToolboxButtonSize( TOOLBOX_BUTTONSIZE_SMALL );
  53
  54     if (rxFrame.is())
  55     {
  56         const sal_uInt16 nItemCount (GetItemCount());
  57         if (nItemCount == 1)
  58         {
  59             // When there is only one item then make that as wide as
  60             // the tool box.
  61             CreateController(GetItemId(0), rxFrame, GetSizePixel().Width());
  62         }
  63         else
  64             for (sal_uInt16 nItemIndex=0; nItemIndex<nItemCount; ++nItemIndex)
  65                 CreateController(GetItemId(nItemIndex), rxFrame, 0);
  66         UpdateIcons(rxFrame);
  67
  68         SetSizePixel(CalcWindowSizePixel());
  69
  70         RegisterHandlers();
  71     }
  72
  73 #ifdef DEBUG
  74     SetText(A2S("SidebarToolBox"));
  75 #endif
  76 }
  77
  78
  79
  80
  81 SidebarToolBox::SidebarToolBox (Window* pParentWindow)
  82     : ToolBox(pParentWindow, 0),
  83       mbParentIsBorder(false),
  84       maItemSeparator(Theme::GetImage(Theme::Image_ToolBoxItemSeparator)),
  85       maControllers(),
  86       mbAreHandlersRegistered(false)
  87 {
  88     SetBackground(Wallpaper());
  89     SetPaintTransparent(true);
  90     SetToolboxButtonSize( TOOLBOX_BUTTONSIZE_SMALL );
  91
  92 #ifdef DEBUG
  93     SetText(A2S("SidebarToolBox"));
  94 #endif
  95 }
  96
  97 extern "C" SAL_DLLPUBLIC_EXPORT Window* SAL_CALL makeSidebarToolBox(Window *pParent)
  98 {
  99     return new SidebarToolBox(pParent);
 100 }
 101
 102 SidebarToolBox::~SidebarToolBox (void)
 103 {
 104     ControllerContainer aControllers;
 105     aControllers.swap(maControllers);
 106     for (ControllerContainer::iterator iController(aControllers.begin()), iEnd(aControllers.end());
 107          iController!=iEnd;
 108          ++iController)
 109     {
 110         Reference<lang::XComponent> xComponent (iController->second.mxController, UNO_QUERY);
 111         if (xComponent.is())
 112             xComponent->dispose();
 113     }
 114
 115     if (mbAreHandlersRegistered)
 116     {
 117         SetDropdownClickHdl(Link());
 118         SetClickHdl(Link());
 119         SetDoubleClickHdl(Link());
 120         SetSelectHdl(Link());
 121         SetActivateHdl(Link());
 122         SetDeactivateHdl(Link());
 123     }
 124 }
 125
 126 void SidebarToolBox::InsertItem(const OUString& rCommand,
 127         const com::sun::star::uno::Reference<com::sun::star::frame::XFrame>& rFrame,
 128         ToolBoxItemBits nBits, sal_uInt16 nPos)
 129 {
 130     ToolBox::InsertItem(rCommand, rFrame, nBits, nPos);
 131
 132     CreateController(GetItemId(rCommand), rFrame, 0);
 133     RegisterHandlers();
 134 }
 135
 136 void SidebarToolBox::SetBorderWindow (const Window* pBorderWindow)
 137 {
 138     if (pBorderWindow != GetParent())
 139     {
 140         OSL_ASSERT("SetBorderWindow can only handle parent as border window");
 141         return;
 142     }
 143
 144     if ( ! mbParentIsBorder)
 145     {
 146         mbParentIsBorder = true;
 147
 148         setPosSizePixel (
 149             GetPosPixel().X(),
 150             GetPosPixel().Y(),
 151             GetSizePixel().Width(),
 152             GetSizePixel().Height(),
 153             WINDOW_POSSIZE_ALL);
 154     }
 155 }
 156
 157
 158
 159
 160 void SidebarToolBox::Paint (const Rectangle& rRect)
 161 {
 162     ToolBox::Paint(rRect);
 163
 164     if (Theme::GetBoolean(Theme::Bool_UseToolBoxItemSeparator))
 165     {
 166         const sal_Int32 nSeparatorY ((GetSizePixel().Height() - maItemSeparator.GetSizePixel().Height())/2);
 167         const sal_uInt16 nItemCount (GetItemCount());
 168         int nLastRight (-1);
 169         for (sal_uInt16 nIndex=0; nIndex<nItemCount; ++nIndex)
 170         {
 171             const Rectangle aItemBoundingBox (GetItemPosRect(nIndex));
 172             if (nLastRight >= 0)
 173             {
 174                 const int nSeparatorX ((nLastRight + aItemBoundingBox.Left() - 1) / 2);
 175                 DrawImage(Point(nSeparatorX,nSeparatorY), maItemSeparator);
 176             }
 177
 178             nLastRight = aItemBoundingBox.Right();
 179         }
 180     }
 181 }
 182
 183
 184
 185
 186 Point SidebarToolBox::GetPosPixel (void) const
 187 {
 188     if (mbParentIsBorder)
 189     {
 190         const Point aParentPoint (GetParent()->GetPosPixel());
 191         const Point aChildPoint (ToolBox::GetPosPixel());
 192         return Point(
 193             aParentPoint.X() + aChildPoint.X(),
 194             aParentPoint.Y() + aChildPoint.Y());
 195     }
 196     else
 197         return ToolBox::GetPosPixel();
 198 }
 199
 200
 201
 202
 203 void SidebarToolBox::setPosSizePixel (
 204     long nX,
 205     long nY,
 206     long nWidth,
 207     long nHeight,
 208     sal_uInt16 nFlags)
 209 {
 210     if (mbParentIsBorder)
 211     {
 212         const Point aRelativePosition (static_cast<ToolBoxBackground*>(GetParent())->SetToolBoxChild(
 213                 this,
 214                 nX,
 215                 nY,
 216                 nWidth,
 217                 nHeight,
 218                 nFlags));
 219         ToolBox::setPosSizePixel(
 220             aRelativePosition.X(),
 221             aRelativePosition.Y(),
 222             nWidth,
 223             nHeight,
 224             nFlags);
 225     }
 226     else
 227         ToolBox::setPosSizePixel(nX, nY, nWidth, nHeight, nFlags);
 228 }
 229
 230
 231
 232
 233 long SidebarToolBox::Notify (NotifyEvent& rEvent)
 234 {
 235     if (rEvent.GetType() == EVENT_KEYINPUT)
 236     {
 237         if (rEvent.GetKeyEvent()->GetKeyCode().GetCode() == KEY_TAB)
 238         {
 239             // Special handling for transferring handling of KEY_TAB
 240             // that becomes necessary because of our parent that is
 241             // not the dialog but a background control.
 242             return DockingWindow::Notify(rEvent);
 243         }
 244     }
 245     return ToolBox::Notify(rEvent);
 246 }
 247
 248
 249
 250
 251 void SidebarToolBox::CreateController (
 252     const sal_uInt16 nItemId,
 253     const cssu::Reference<css::frame::XFrame>& rxFrame,
 254     const sal_Int32 nItemWidth)
 255 {
 256     ItemDescriptor aDescriptor;
 257
 258     const OUString sCommandName (GetItemCommand(nItemId));
 259
 260     aDescriptor.mxController = sfx2::sidebar::ControllerFactory::CreateToolBoxController(
 261         this,
 262         nItemId,
 263         sCommandName,
 264         rxFrame,
 265         VCLUnoHelper::GetInterface(this),
 266         nItemWidth);
 267     if (aDescriptor.mxController.is())
 268     {
 269         aDescriptor.maURL = sfx2::sidebar::Tools::GetURL(sCommandName);
 270         aDescriptor.msCurrentCommand = sCommandName;
 271
 272         maControllers.insert(::std::make_pair(nItemId, aDescriptor));
 273     }
 274 }
 275
 276
 277
 278
 279 Reference<frame::XToolbarController> SidebarToolBox::GetControllerForItemId (const sal_uInt16 nItemId) const
 280 {
 281     ControllerContainer::const_iterator iController (maControllers.find(nItemId));
 282     if (iController != maControllers.end())
 283         return iController->second.mxController;
 284     else
 285         return NULL;
 286 }
 287
 288
 289
 290
 291 void SidebarToolBox::SetController(
 292     const sal_uInt16 nItemId,
 293     const cssu::Reference<css::frame::XToolbarController>& rxController,
 294     const ::rtl::OUString& rsCommandName)
 295 {
 296     ItemDescriptor aDescriptor;
 297     aDescriptor.mxController = rxController;
 298     aDescriptor.maURL = sfx2::sidebar::Tools::GetURL(rsCommandName);
 299     aDescriptor.msCurrentCommand = rsCommandName;
 300
 301     ControllerContainer::iterator iController (maControllers.find(nItemId));
 302     if (iController != maControllers.end())
 303     {
 304         Reference<lang::XComponent> xComponent (iController->second.mxController, UNO_QUERY);
 305         if (xComponent.is())
 306             xComponent->dispose();
 307
 308         iController->second = aDescriptor;
 309     }
 310     else
 311     {
 312         maControllers[nItemId] = aDescriptor;
 313     }
 314
 315     if (rxController.is())
 316         RegisterHandlers();
 317 }
 318
 319
 320
 321
 322 void SidebarToolBox::UpdateIcons (const Reference<frame::XFrame>& rxFrame)
 323 {
 324     for (ControllerContainer::iterator iController(maControllers.begin()), iEnd(maControllers.end());
 325          iController!=iEnd;
 326          ++iController)
 327     {
 328         const ::rtl::OUString sCommandURL (iController->second.msCurrentCommand);
 329         Image aImage (framework::GetImageFromURL(rxFrame, sCommandURL, false));
 330         SetItemImage(iController->first, aImage);
 331     }
 332 }
 333
 334
 335
 336
 337 sal_uInt16 SidebarToolBox::GetItemIdForSubToolbarName (const OUString& rsSubToolbarName) const
 338 {
 339     for (ControllerContainer::const_iterator iController(maControllers.begin()), iEnd(maControllers.end());
 340          iController!=iEnd;
 341          ++iController)
 342     {
 343         Reference<frame::XToolbarController> xController (iController->second.mxController);
 344         Reference<frame::XSubToolbarController> xSubToolbarController (xController, UNO_QUERY);
 345         if (xSubToolbarController.is())
 346         {
 347             const OUString sName (xSubToolbarController->getSubToolbarName());
 348             if (sName.equals(rsSubToolbarName))
 349                 return iController->first;
 350         }
 351     }
 352     return 0;
 353 }
 354
 355
 356
 357
 358 void SidebarToolBox::RegisterHandlers (void)
 359 {
 360     if ( ! mbAreHandlersRegistered)
 361     {
 362         mbAreHandlersRegistered = true;
 363         SetDropdownClickHdl(LINK(this, SidebarToolBox, DropDownClickHandler));
 364         SetClickHdl(LINK(this, SidebarToolBox, ClickHandler));
 365         SetDoubleClickHdl(LINK(this, SidebarToolBox, DoubleClickHandler));
 366         SetSelectHdl(LINK(this, SidebarToolBox, SelectHandler));
 367         SetActivateHdl(LINK(this, SidebarToolBox, ActivateToolBox));
 368         SetDeactivateHdl(LINK(this, SidebarToolBox, DeactivateToolBox));
 369     }
 370 }
 371
 372
 373
 374
 375 IMPL_LINK(SidebarToolBox, DropDownClickHandler, ToolBox*, pToolBox)
 376 {
 377     if (pToolBox != NULL)
 378     {
 379         Reference<frame::XToolbarController> xController (GetControllerForItemId(pToolBox->GetCurItemId()));
 380         if (xController.is())
 381         {
 382             Reference<awt::XWindow> xWindow = xController->createPopupWindow();
 383             if (xWindow.is() )
 384                 xWindow->setFocus();
 385         }
 386     }
 387     return 1;
 388 }
 389
 390
 391
 392
 393 IMPL_LINK(SidebarToolBox, ClickHandler, ToolBox*, pToolBox)
 394 {
 395     if (pToolBox == NULL)
 396         return 0;
 397
 398     Reference<frame::XToolbarController> xController (GetControllerForItemId(pToolBox->GetCurItemId()));
 399     if (xController.is())
 400         xController->click();
 401
 402     return 1;
 403 }
 404
 405
 406
 407
 408 IMPL_LINK(SidebarToolBox, DoubleClickHandler, ToolBox*, pToolBox)
 409 {
 410     if (pToolBox == NULL)
 411         return 0;
 412
 413     Reference<frame::XToolbarController> xController (GetControllerForItemId(pToolBox->GetCurItemId()));
 414     if (xController.is())
 415         xController->doubleClick();
 416
 417     return 1;
 418 }
 419
 420
 421
 422
 423 IMPL_LINK(SidebarToolBox, SelectHandler, ToolBox*, pToolBox)
 424 {
 425     if (pToolBox == NULL)
 426         return 0;
 427
 428     Reference<frame::XToolbarController> xController (GetControllerForItemId(pToolBox->GetCurItemId()));
 429     if (xController.is())
 430         xController->execute((sal_Int16)pToolBox->GetModifier());
 431
 432     return 1;
 433 }
 434
 435
 436
 437
 438 IMPL_LINK(SidebarToolBox, ActivateToolBox, ToolBox*, EMPTYARG)
 439 {
 440     return 1;
 441 }
 442
 443
 444
 445
 446 IMPL_LINK(SidebarToolBox, DeactivateToolBox, ToolBox*, EMPTYARG)
 447 {
 448     return 1;
 449 }
 450
 451
 452
 453 } } // end of namespace sfx2::sidebar