extensions/source/propctrlr/browserline.cxx

   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 "browserline.hxx"
  21
  22 #include <com/sun/star/uno/XComponentContext.hpp>
  23 #include <com/sun/star/inspection/PropertyLineElement.hpp>
  24 #include <com/sun/star/graphic/GraphicProvider.hpp>
  25 #include <com/sun/star/graphic/XGraphicProvider.hpp>
  26
  27 #include <comphelper/processfactory.hxx>
  28 #include <comphelper/propertyvalue.hxx>
  29 #include <comphelper/string.hxx>
  30 #include <tools/debug.hxx>
  31 #include <comphelper/diagnose_ex.hxx>
  32 #include <utility>
  33 #include <vcl/settings.hxx>
  34 #include <vcl/svapp.hxx>
  35 #include <vcl/weld.hxx>
  36 #include <vcl/weldutils.hxx>
  37
  38 namespace pcr
  39 {
  40
  41
  42     using ::com::sun::star::uno::Reference;
  43     using ::com::sun::star::uno::XComponentContext;
  44     using ::com::sun::star::inspection::XPropertyControl;
  45     using ::com::sun::star::inspection::XPropertyControlContext;
  46     using ::com::sun::star::uno::Exception;
  47     using ::com::sun::star::graphic::GraphicProvider;
  48     using ::com::sun::star::graphic::XGraphicProvider;
  49     using ::com::sun::star::uno::Sequence;
  50     using ::com::sun::star::graphic::XGraphic;
  51
  52     namespace PropertyLineElement = ::com::sun::star::inspection::PropertyLineElement;
  53
  54     OBrowserLine::OBrowserLine(OUString aEntryName, weld::Container* pParent, weld::SizeGroup* pLabelGroup,
  55                                weld::Container* pInitialControlParent)
  56         : m_sEntryName(std::move(aEntryName))
  57         , m_xBuilder(Application::CreateBuilder(pParent, "modules/spropctrlr/ui/browserline.ui"))
  58         , m_xContainer(m_xBuilder->weld_container("BrowserLine"))
  59         , m_xFtTitle(m_xBuilder->weld_label("label"))
  60         , m_xBrowseButton(m_xBuilder->weld_button("browse"))
  61         , m_xAdditionalBrowseButton(m_xBuilder->weld_button("morebrowse"))
  62         , m_pInitialControlParent(pInitialControlParent) // controls start with this as their parent and need to be moved into m_xContainer
  63         , m_pParent(pParent)
  64         , m_pControlWindow( nullptr )
  65         , m_pBrowseButton(nullptr)
  66         , m_pAdditionalBrowseButton( nullptr )
  67         , m_pClickListener( nullptr )
  68         , m_nNameWidth(0)
  69         , m_nEnableFlags( 0xFFFF )
  70         , m_bIndentTitle( false )
  71         , m_bReadOnly( false )
  72     {
  73         pLabelGroup->add_widget(m_xFtTitle.get());
  74     }
  75
  76     OBrowserLine::~OBrowserLine()
  77     {
  78         implHideBrowseButton(true);
  79         implHideBrowseButton(false);
  80         m_pParent->move(m_xContainer.get(), nullptr);
  81     }
  82
  83     void OBrowserLine::IndentTitle( bool _bIndent )
  84     {
  85         if ( m_bIndentTitle != _bIndent )
  86         {
  87             m_bIndentTitle = _bIndent;
  88         }
  89     }
  90
  91     void OBrowserLine::SetComponentHelpIds(const OUString& rHelpId)
  92     {
  93         if (m_pControlWindow)
  94             m_pControlWindow->set_help_id(rHelpId);
  95
  96         if ( m_pBrowseButton )
  97         {
  98             m_pBrowseButton->set_help_id(rHelpId);
  99
 100             if ( m_pAdditionalBrowseButton )
 101             {
 102                 m_pAdditionalBrowseButton->set_help_id(rHelpId);
 103             }
 104         }
 105     }
 106
 107     void OBrowserLine::setControl( const Reference< XPropertyControl >& rxControl )
 108     {
 109         m_xControl = rxControl;
 110         auto xWindow = m_xControl->getControlWindow();
 111         if (weld::TransportAsXWindow* pTunnel = dynamic_cast<weld::TransportAsXWindow*>(xWindow.get()))
 112             m_pControlWindow = pTunnel->getWidget();
 113         else
 114             m_pControlWindow = nullptr;
 115         DBG_ASSERT( m_pControlWindow, "OBrowserLine::setControl: setting NULL controls/windows is not allowed!" );
 116
 117         if ( m_pControlWindow )
 118         {
 119             m_pInitialControlParent->move(m_pControlWindow, m_xContainer.get());
 120             m_pControlWindow->set_grid_left_attach(1);
 121             m_xFtTitle->set_mnemonic_widget(m_pControlWindow);
 122             m_pControlWindow->show();
 123         }
 124     }
 125
 126     bool OBrowserLine::GrabFocus()
 127     {
 128         bool bRes=false;
 129
 130         if (m_pControlWindow && m_pControlWindow->get_sensitive())
 131         {
 132             m_pControlWindow->grab_focus();
 133             bRes = true;
 134         }
 135         else if ( m_pAdditionalBrowseButton && m_pAdditionalBrowseButton->get_sensitive() )
 136         {
 137             m_pAdditionalBrowseButton->grab_focus();
 138             bRes = true;
 139         }
 140         else if ( m_pBrowseButton && m_pBrowseButton->get_sensitive() )
 141         {
 142             m_pBrowseButton->grab_focus();
 143             bRes = true;
 144         }
 145         return bRes;
 146     }
 147
 148     void OBrowserLine::Show(bool bFlag)
 149     {
 150         m_xFtTitle->set_visible(bFlag);
 151         if (m_pControlWindow)
 152             m_pControlWindow->set_visible( bFlag );
 153         if ( m_pBrowseButton )
 154             m_pBrowseButton->set_visible( bFlag );
 155         if ( m_pAdditionalBrowseButton )
 156             m_pAdditionalBrowseButton->set_visible( bFlag );
 157     }
 158
 159     void OBrowserLine::Hide()
 160     {
 161         Show(false);
 162     }
 163
 164     void OBrowserLine::SetTitle(const OUString& rNewTitle )
 165     {
 166         if ( GetTitle() == rNewTitle )
 167             return;
 168         m_xFtTitle->set_label( rNewTitle );
 169         if (m_pControlWindow)
 170             m_pControlWindow->set_accessible_name(rNewTitle);
 171         if ( m_pBrowseButton )
 172             m_pBrowseButton->set_accessible_name( rNewTitle );
 173         FullFillTitleString();
 174     }
 175
 176     void OBrowserLine::FullFillTitleString()
 177     {
 178         OUStringBuffer aText(m_xFtTitle->get_label());
 179
 180         int n10DotsWidth = m_xFtTitle->get_pixel_size("..........").Width();
 181         int nTextWidth = m_xFtTitle->get_pixel_size(OUString::unacquired(aText)).Width();
 182         int nDiff = m_nNameWidth - nTextWidth;
 183         int nExtraChars = (nDiff * 10) / n10DotsWidth;
 184         for (int i = 0; i < nExtraChars; ++i)
 185             aText.append(".");
 186
 187         // for Issue 69452
 188         if (AllSettings::GetLayoutRTL())
 189         {
 190             sal_Unicode const cRTL_mark = 0x200F;
 191             aText.append( cRTL_mark );
 192         }
 193
 194         m_xFtTitle->set_label(aText.makeStringAndClear());
 195     }
 196
 197     OUString OBrowserLine::GetTitle() const
 198     {
 199         OUString sDisplayName = m_xFtTitle->get_label();
 200
 201         // for Issue 69452
 202         if (AllSettings::GetLayoutRTL())
 203         {
 204             sal_Unicode const cRTL_mark = 0x200F;
 205             sDisplayName = comphelper::string::stripEnd(sDisplayName, cRTL_mark);
 206         }
 207
 208         sDisplayName = comphelper::string::stripEnd(sDisplayName, '.');
 209
 210         return sDisplayName;
 211     }
 212
 213     void OBrowserLine::SetReadOnly( bool _bReadOnly )
 214     {
 215         if ( m_bReadOnly != _bReadOnly )
 216         {
 217             m_bReadOnly = _bReadOnly;
 218             implUpdateEnabledDisabled();
 219         }
 220     }
 221
 222     namespace
 223     {
 224         void implSetBitIfAffected(sal_uInt16& nEnabledBits, sal_Int16 _nAffectedMask, sal_Int16 _nTestBit, bool _bSet)
 225         {
 226             if ( _nAffectedMask & _nTestBit )
 227             {
 228                 if ( _bSet )
 229                     nEnabledBits |= _nTestBit;
 230                 else
 231                     nEnabledBits &= ~_nTestBit;
 232             }
 233         }
 234
 235         void implEnable(weld::Widget* pWindow, bool bEnable)
 236         {
 237             // tdf#138131 get_sensitive comparison as bodge for
 238             // vcl's recursive Enable behavior
 239             if (pWindow && pWindow->get_sensitive() != bEnable)
 240                 pWindow->set_sensitive(bEnable);
 241         }
 242
 243         void implEnable(weld::Widget* pWindow, sal_uInt16 nEnabledBits, sal_uInt16 nMatchBits)
 244         {
 245             bool bEnable = ((nEnabledBits & nMatchBits) == nMatchBits);
 246             implEnable(pWindow, bEnable);
 247         }
 248     }
 249
 250     void OBrowserLine::implUpdateEnabledDisabled()
 251     {
 252         implEnable( m_xFtTitle.get(),           m_nEnableFlags, PropertyLineElement::CompleteLine );
 253         if ( m_pControlWindow )
 254             implEnable( m_pControlWindow,       m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::InputControl );
 255
 256         if ( m_bReadOnly )
 257         {
 258             implEnable( m_pBrowseButton,            false );
 259             implEnable( m_pAdditionalBrowseButton,  false );
 260         }
 261         else
 262         {
 263             implEnable( m_pBrowseButton,            m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::PrimaryButton );
 264             implEnable( m_pAdditionalBrowseButton,  m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::SecondaryButton );
 265         }
 266     }
 267
 268     void OBrowserLine::EnablePropertyLine( bool _bEnable )
 269     {
 270         implSetBitIfAffected( m_nEnableFlags, PropertyLineElement::CompleteLine, PropertyLineElement::CompleteLine, _bEnable );
 271         implUpdateEnabledDisabled();
 272     }
 273
 274
 275     void OBrowserLine::EnablePropertyControls( sal_Int16 _nControls, bool _bEnable )
 276     {
 277         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::InputControl, _bEnable );
 278         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::PrimaryButton, _bEnable );
 279         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::SecondaryButton, _bEnable );
 280         implUpdateEnabledDisabled();
 281     }
 282
 283     weld::Button& OBrowserLine::impl_ensureButton(bool bPrimary)
 284     {
 285         weld::Button* pButton;
 286         if (bPrimary)
 287             pButton = m_pBrowseButton;
 288         else
 289             pButton = m_pAdditionalBrowseButton;
 290
 291         if (!pButton )
 292         {
 293             if (bPrimary)
 294                 pButton = m_pBrowseButton = m_xBrowseButton.get();
 295             else
 296                 pButton = m_pAdditionalBrowseButton = m_xAdditionalBrowseButton.get();
 297             pButton->connect_focus_in(LINK(this, OBrowserLine, OnButtonFocus));
 298             pButton->connect_clicked(LINK(this, OBrowserLine, OnButtonClicked));
 299         }
 300
 301         pButton->show();
 302
 303         return *pButton;
 304     }
 305
 306     void OBrowserLine::ShowBrowseButton( const OUString& rImageURL, bool bPrimary )
 307     {
 308         weld::Button& rButton( impl_ensureButton( bPrimary ) );
 309
 310         OSL_PRECOND( !rImageURL.isEmpty(), "OBrowserLine::ShowBrowseButton: use the other version if you don't have an image!" );
 311         Reference<XGraphic> xGraphic;
 312         try
 313         {
 314             Reference< XComponentContext > xContext( ::comphelper::getProcessComponentContext() );
 315             Reference< XGraphicProvider > xGraphicProvider( GraphicProvider::create(xContext) );
 316
 317             Sequence aMediaProperties{ comphelper::makePropertyValue("URL", rImageURL) };
 318
 319             xGraphic = Reference<XGraphic>(xGraphicProvider->queryGraphic(aMediaProperties), css::uno::UNO_SET_THROW);
 320         }
 321         catch( const Exception& )
 322         {
 323             DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
 324         }
 325
 326         rButton.set_image(xGraphic);
 327     }
 328
 329     void OBrowserLine::ShowBrowseButton(const css::uno::Reference<css::graphic::XGraphic>& rGraphic, bool bPrimary)
 330     {
 331         weld::Button& rButton( impl_ensureButton( bPrimary ) );
 332         rButton.set_image(rGraphic);
 333     }
 334
 335     void OBrowserLine::ShowBrowseButton( bool bPrimary )
 336     {
 337         impl_ensureButton(bPrimary);
 338     }
 339
 340     void OBrowserLine::implHideBrowseButton(bool bPrimary)
 341     {
 342         if (bPrimary)
 343         {
 344             if (m_pBrowseButton)
 345             {
 346                 m_pBrowseButton->hide();
 347                 m_pBrowseButton->connect_focus_in(Link<weld::Widget&, void>());
 348                 m_pBrowseButton = nullptr;
 349             }
 350         }
 351         else
 352         {
 353             if (m_pAdditionalBrowseButton)
 354             {
 355                 m_pAdditionalBrowseButton->hide();
 356                 m_pAdditionalBrowseButton->connect_focus_in(Link<weld::Widget&, void>());
 357                 m_pAdditionalBrowseButton = nullptr;
 358             }
 359         }
 360     }
 361
 362     void OBrowserLine::HideBrowseButton(bool bPrimary)
 363     {
 364         implHideBrowseButton(bPrimary);
 365     }
 366
 367     void OBrowserLine::SetTitleWidth(sal_uInt16 nWidth)
 368     {
 369         int nMinDotsWidth = m_xFtTitle->get_pixel_size("...").Width();
 370         if (m_nNameWidth != nWidth + nMinDotsWidth)
 371             m_nNameWidth = nWidth + nMinDotsWidth;
 372         FullFillTitleString();
 373     }
 374
 375     void OBrowserLine::SetClickListener( IButtonClickListener* _pListener )
 376     {
 377         m_pClickListener = _pListener;
 378     }
 379
 380     IMPL_LINK(OBrowserLine, OnButtonClicked, weld::Button&, rButton, void)
 381     {
 382         if ( m_pClickListener )
 383             m_pClickListener->buttonClicked(this, &rButton == m_pBrowseButton);
 384     }
 385
 386     IMPL_LINK_NOARG( OBrowserLine, OnButtonFocus, weld::Widget&, void )
 387     {
 388         if ( m_xControl.is() )
 389         {
 390             try
 391             {
 392                 Reference< XPropertyControlContext > xContext( m_xControl->getControlContext(), css::uno::UNO_SET_THROW );
 393                 xContext->focusGained( m_xControl );
 394             }
 395             catch( const Exception& )
 396             {
 397                 DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
 398             }
 399         }
 400     }
 401
 402 } // namespace pcr
 403
 404 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */