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/string.hxx>
  29 #include <tools/debug.hxx>
  30 #include <tools/diagnose_ex.h>
  31 #include <toolkit/helper/vclunohelper.hxx>
  32 #include <vcl/svapp.hxx>
  33 #include <vcl/settings.hxx>
  34
  35
  36 namespace pcr
  37 {
  38
  39
  40     using ::com::sun::star::uno::Reference;
  41     using ::com::sun::star::uno::XComponentContext;
  42     using ::com::sun::star::inspection::XPropertyControl;
  43     using ::com::sun::star::inspection::XPropertyControlContext;
  44     using ::com::sun::star::uno::UNO_QUERY_THROW;
  45     using ::com::sun::star::uno::Exception;
  46     using ::com::sun::star::graphic::GraphicProvider;
  47     using ::com::sun::star::graphic::XGraphicProvider;
  48     using ::com::sun::star::uno::Sequence;
  49     using ::com::sun::star::beans::PropertyValue;
  50     using ::com::sun::star::graphic::XGraphic;
  51
  52     namespace PropertyLineElement = ::com::sun::star::inspection::PropertyLineElement;
  53
  54     OBrowserLine::OBrowserLine( const OUString& _rEntryName, vcl::Window* pParent )
  55             :m_sEntryName( _rEntryName )
  56             ,m_aFtTitle(VclPtr<FixedText>::Create(pParent))
  57             ,m_pControlWindow( nullptr )
  58             ,m_pBrowseButton(nullptr)
  59             ,m_pAdditionalBrowseButton( nullptr )
  60             ,m_pClickListener( nullptr )
  61             ,m_pTheParent(pParent)
  62             ,m_nNameWidth(0)
  63             ,m_nEnableFlags( 0xFFFF )
  64             ,m_bIndentTitle( false )
  65             ,m_bReadOnly( false )
  66     {
  67         m_aFtTitle->Show();
  68     }
  69
  70     OBrowserLine::~OBrowserLine()
  71     {
  72         implHideBrowseButton(true);
  73         implHideBrowseButton(false);
  74         m_aFtTitle.disposeAndClear();
  75     }
  76
  77
  78     void OBrowserLine::IndentTitle( bool _bIndent )
  79     {
  80         if ( m_bIndentTitle != _bIndent )
  81         {
  82             m_bIndentTitle = _bIndent;
  83             impl_layoutComponents();
  84         }
  85     }
  86
  87     void OBrowserLine::SetComponentHelpIds(const OString& _rHelpId)
  88     {
  89         if ( m_pControlWindow )
  90             m_pControlWindow->SetHelpId( _rHelpId );
  91
  92         if ( m_pBrowseButton )
  93         {
  94             m_pBrowseButton->SetHelpId( _rHelpId );
  95
  96             if ( m_pAdditionalBrowseButton )
  97             {
  98                 m_pAdditionalBrowseButton->SetHelpId( _rHelpId );
  99             }
 100         }
 101     }
 102
 103     void OBrowserLine::setControl( const Reference< XPropertyControl >& _rxControl )
 104     {
 105         m_xControl = _rxControl;
 106         m_pControlWindow = m_xControl.is() ? VCLUnoHelper::GetWindow( _rxControl->getControlWindow() ) : VclPtr<vcl::Window>();
 107         DBG_ASSERT( m_pControlWindow, "OBrowserLine::setControl: setting NULL controls/windows is not allowed!" );
 108
 109         if ( m_pControlWindow )
 110         {
 111             m_pControlWindow->SetParent( m_pTheParent );
 112             m_pControlWindow->Show();
 113         }
 114         impl_layoutComponents();
 115     }
 116
 117
 118     vcl::Window* OBrowserLine::GetRefWindow()
 119     {
 120         vcl::Window* pRefWindow = m_aFtTitle.get();
 121
 122         if(m_pBrowseButton)
 123         {
 124             pRefWindow=static_cast<vcl::Window*>(m_pBrowseButton);
 125         }
 126         else if ( m_pControlWindow )
 127         {
 128             pRefWindow = m_pControlWindow;
 129         }
 130         return pRefWindow;
 131     }
 132
 133
 134     void OBrowserLine::SetTabOrder(vcl::Window* pRefWindow, ZOrderFlags nFlags )
 135     {
 136         m_aFtTitle->SetZOrder(pRefWindow,nFlags);
 137         if ( m_pControlWindow )
 138             m_pControlWindow->SetZOrder( m_aFtTitle.get(), ZOrderFlags::Behind );
 139
 140         if ( m_pBrowseButton && m_pControlWindow )
 141             m_pBrowseButton->SetZOrder( m_pControlWindow, ZOrderFlags::Behind );
 142
 143         if ( m_pAdditionalBrowseButton && m_pBrowseButton )
 144             m_pAdditionalBrowseButton->SetZOrder( m_pBrowseButton, ZOrderFlags::Behind );
 145     }
 146
 147
 148     bool OBrowserLine::GrabFocus()
 149     {
 150         bool bRes=false;
 151
 152         if ( m_pControlWindow && m_pControlWindow->IsEnabled() )
 153         {
 154             m_pControlWindow->GrabFocus();
 155             bRes = true;
 156         }
 157         else if ( m_pAdditionalBrowseButton && m_pAdditionalBrowseButton->IsEnabled() )
 158         {
 159             m_pAdditionalBrowseButton->GrabFocus();
 160             bRes = true;
 161         }
 162         else if ( m_pBrowseButton && m_pBrowseButton->IsEnabled() )
 163         {
 164             m_pBrowseButton->GrabFocus();
 165             bRes = true;
 166         }
 167         return bRes;
 168     }
 169
 170
 171     void OBrowserLine::SetPosSizePixel( Point _rPos, Size _rSize )
 172     {
 173         m_aLinePos = _rPos;
 174         m_aOutputSize = _rSize;
 175
 176         impl_layoutComponents();
 177     }
 178
 179
 180     void OBrowserLine::Show(bool bFlag)
 181     {
 182         m_aFtTitle->Show(bFlag);
 183         if ( m_pControlWindow )
 184             m_pControlWindow->Show( bFlag );
 185         if ( m_pBrowseButton )
 186             m_pBrowseButton->Show( bFlag );
 187         if ( m_pAdditionalBrowseButton )
 188             m_pAdditionalBrowseButton->Show( bFlag );
 189     }
 190
 191
 192     void OBrowserLine::Hide()
 193     {
 194         Show(false);
 195     }
 196
 197
 198     bool OBrowserLine::IsVisible()
 199     {
 200         return m_aFtTitle->IsVisible();
 201     }
 202
 203
 204     void OBrowserLine::impl_layoutComponents()
 205     {
 206         {
 207             Point aTitlePos( m_aLinePos.X(), m_aLinePos.Y() + 8 );
 208             Size aTitleSize( m_nNameWidth - 3, m_aOutputSize.Height() );
 209
 210             if ( m_bIndentTitle )
 211             {
 212                 Size aIndent( m_pTheParent->LogicToPixel(Size(8, 0), MapMode(MapUnit::MapAppFont)) );
 213                 aTitlePos.AdjustX(aIndent.Width() );
 214                 aTitleSize.AdjustWidth( -(aIndent.Width()) );
 215             }
 216             m_aFtTitle->SetPosSizePixel( aTitlePos, aTitleSize );
 217         }
 218
 219         sal_Int32 nBrowseButtonSize = m_aOutputSize.Height() - 4;
 220
 221         if ( m_pControlWindow )
 222         {
 223             Point aControlPos( m_aLinePos.X() + m_nNameWidth, m_aLinePos.Y() + 2 );
 224             m_pControlWindow->SetPosPixel( aControlPos );
 225
 226             Size aControlSize( m_aOutputSize.Width() - 4 - m_nNameWidth - nBrowseButtonSize - 4, m_pControlWindow->GetSizePixel().Height() );
 227             if ( m_pAdditionalBrowseButton )
 228                 aControlSize.AdjustWidth( -(nBrowseButtonSize + 4) );
 229             m_pControlWindow->SetSizePixel( aControlSize );
 230         }
 231
 232         if ( m_pBrowseButton )
 233         {
 234             Point aButtonPos( m_aOutputSize.Width() - 4 - nBrowseButtonSize, m_aLinePos.Y() + 2 );
 235             Size aButtonSize( nBrowseButtonSize, nBrowseButtonSize );
 236             m_pBrowseButton->SetPosSizePixel( aButtonPos, aButtonSize );
 237
 238             if ( m_pAdditionalBrowseButton )
 239             {
 240                 aButtonPos.AdjustX( -(nBrowseButtonSize + 4) );
 241                 m_pAdditionalBrowseButton->SetPosSizePixel( aButtonPos, aButtonSize );
 242             }
 243         }
 244     }
 245
 246
 247     void OBrowserLine::SetTitle(const OUString& _rNewTitle )
 248     {
 249         if ( GetTitle() == _rNewTitle )
 250             return;
 251         m_aFtTitle->SetText( _rNewTitle );
 252         if ( m_pControlWindow )
 253             m_pControlWindow->SetAccessibleName( _rNewTitle );
 254         if ( m_pBrowseButton )
 255             m_pBrowseButton->SetAccessibleName( _rNewTitle );
 256         FullFillTitleString();
 257     }
 258
 259     void OBrowserLine::FullFillTitleString()
 260     {
 261         if( m_pTheParent )
 262         {
 263             OUStringBuffer aText( m_aFtTitle->GetText() );
 264
 265             while( m_pTheParent->GetTextWidth( aText.toString() ) < m_nNameWidth )
 266                         aText.append("...........");
 267
 268             // for Issue 69452
 269             if (AllSettings::GetLayoutRTL())
 270             {
 271                 sal_Unicode const cRTL_mark = 0x200F;
 272                 aText.append( OUString(cRTL_mark) );
 273             }
 274
 275             m_aFtTitle->SetText( aText.makeStringAndClear() );
 276         }
 277     }
 278
 279
 280     OUString OBrowserLine::GetTitle() const
 281     {
 282         OUString sDisplayName = m_aFtTitle->GetText();
 283
 284         // for Issue 69452
 285         if (AllSettings::GetLayoutRTL())
 286         {
 287             sal_Unicode const cRTL_mark = 0x200F;
 288             sDisplayName = comphelper::string::stripEnd(sDisplayName, cRTL_mark);
 289         }
 290
 291         sDisplayName = comphelper::string::stripEnd(sDisplayName, '.');
 292
 293         return sDisplayName;
 294     }
 295
 296
 297     void OBrowserLine::SetReadOnly( bool _bReadOnly )
 298     {
 299         if ( m_bReadOnly != _bReadOnly )
 300         {
 301             m_bReadOnly = _bReadOnly;
 302             implUpdateEnabledDisabled();
 303         }
 304     }
 305
 306
 307     namespace
 308     {
 309         void implSetBitIfAffected( sal_uInt16& _nEnabledBits, sal_Int16 _nAffectedMask, sal_Int16 _nTestBit, bool _bSet )
 310         {
 311             if ( _nAffectedMask & _nTestBit )
 312             {
 313                 if ( _bSet )
 314                     _nEnabledBits |= _nTestBit;
 315                 else
 316                     _nEnabledBits &= ~_nTestBit;
 317             }
 318         }
 319
 320         void implEnable( vcl::Window* _pWindow, sal_uInt16 _nEnabledBits, sal_uInt16 _nMatchBits  )
 321         {
 322             if ( _pWindow )
 323                 _pWindow->Enable( ( _nEnabledBits & _nMatchBits ) == _nMatchBits );
 324         }
 325
 326         void implEnable( vcl::Window* _pWindow, bool _bEnable )
 327         {
 328             if ( _pWindow )
 329                 _pWindow->Enable( _bEnable );
 330         }
 331     }
 332
 333
 334     void OBrowserLine::implUpdateEnabledDisabled()
 335     {
 336         implEnable( m_aFtTitle.get(),           m_nEnableFlags, PropertyLineElement::CompleteLine );
 337         if ( m_pControlWindow )
 338             implEnable( m_pControlWindow,       m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::InputControl );
 339
 340         if ( m_bReadOnly )
 341         {
 342             implEnable( m_pBrowseButton,            false );
 343             implEnable( m_pAdditionalBrowseButton,  false );
 344         }
 345         else
 346         {
 347             implEnable( m_pBrowseButton,            m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::PrimaryButton );
 348             implEnable( m_pAdditionalBrowseButton,  m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::SecondaryButton );
 349         }
 350     }
 351
 352
 353     void OBrowserLine::EnablePropertyLine( bool _bEnable )
 354     {
 355         implSetBitIfAffected( m_nEnableFlags, PropertyLineElement::CompleteLine, PropertyLineElement::CompleteLine, _bEnable );
 356         implUpdateEnabledDisabled();
 357     }
 358
 359
 360     void OBrowserLine::EnablePropertyControls( sal_Int16 _nControls, bool _bEnable )
 361     {
 362         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::InputControl, _bEnable );
 363         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::PrimaryButton, _bEnable );
 364         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::SecondaryButton, _bEnable );
 365         implUpdateEnabledDisabled();
 366     }
 367
 368
 369     PushButton& OBrowserLine::impl_ensureButton( bool _bPrimary )
 370     {
 371         VclPtr<PushButton>& rpButton = _bPrimary ? m_pBrowseButton : m_pAdditionalBrowseButton;
 372
 373         if ( !rpButton )
 374         {
 375             rpButton = VclPtr<PushButton>::Create( m_pTheParent, WB_NOPOINTERFOCUS );
 376             rpButton->SetGetFocusHdl( LINK( this, OBrowserLine, OnButtonFocus ) );
 377             rpButton->SetClickHdl( LINK( this, OBrowserLine, OnButtonClicked ) );
 378             rpButton->SetText("...");
 379         }
 380
 381         rpButton->Show();
 382
 383         impl_layoutComponents();
 384
 385         return *rpButton;
 386     }
 387
 388
 389     void OBrowserLine::ShowBrowseButton( const OUString& _rImageURL, bool _bPrimary )
 390     {
 391         PushButton& rButton( impl_ensureButton( _bPrimary ) );
 392
 393         OSL_PRECOND( !_rImageURL.isEmpty(), "OBrowserLine::ShowBrowseButton: use the other version if you don't have an image!" );
 394         Image aImage;
 395         try
 396         {
 397             Reference< XComponentContext > xContext( ::comphelper::getProcessComponentContext() );
 398             Reference< XGraphicProvider > xGraphicProvider( GraphicProvider::create(xContext) );
 399
 400             Sequence< PropertyValue > aMediaProperties(1);
 401             aMediaProperties[0].Name = "URL";
 402             aMediaProperties[0].Value <<= _rImageURL;
 403
 404             Reference< XGraphic > xGraphic( xGraphicProvider->queryGraphic( aMediaProperties ), css::uno::UNO_SET_THROW );
 405             aImage = Image( xGraphic );
 406         }
 407         catch( const Exception& )
 408         {
 409             DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
 410         }
 411
 412         rButton.SetModeImage( aImage );
 413     }
 414
 415     void OBrowserLine::ShowBrowseButton( const Image& _rImage, bool _bPrimary )
 416     {
 417         PushButton& rButton( impl_ensureButton( _bPrimary ) );
 418         if ( !!_rImage )
 419             rButton.SetModeImage( _rImage );
 420     }
 421
 422     void OBrowserLine::ShowBrowseButton( bool _bPrimary )
 423     {
 424         impl_ensureButton( _bPrimary );
 425     }
 426
 427     void OBrowserLine::implHideBrowseButton(bool _bPrimary)
 428     {
 429         VclPtr<PushButton>& rpButton = _bPrimary ? m_pBrowseButton : m_pAdditionalBrowseButton;
 430
 431         if ( rpButton )
 432         {
 433             rpButton->Hide();
 434             rpButton.disposeAndClear();
 435         }
 436     }
 437
 438     void OBrowserLine::HideBrowseButton(bool _bPrimary)
 439     {
 440         implHideBrowseButton(_bPrimary);
 441         impl_layoutComponents();
 442     }
 443
 444     void OBrowserLine::SetTitleWidth(sal_uInt16 nWidth)
 445     {
 446         if (m_nNameWidth != nWidth+10)
 447         {
 448             m_nNameWidth = nWidth+10;
 449             impl_layoutComponents();
 450         }
 451         FullFillTitleString();
 452     }
 453
 454
 455     void OBrowserLine::SetClickListener( IButtonClickListener* _pListener )
 456     {
 457         m_pClickListener = _pListener;
 458     }
 459
 460
 461     IMPL_LINK( OBrowserLine, OnButtonClicked, Button*, _pButton, void )
 462     {
 463         if ( m_pClickListener )
 464             m_pClickListener->buttonClicked( this, _pButton == m_pBrowseButton );
 465     }
 466
 467
 468     IMPL_LINK_NOARG( OBrowserLine, OnButtonFocus, Control&, void )
 469     {
 470         if ( m_xControl.is() )
 471         {
 472             try
 473             {
 474                 Reference< XPropertyControlContext > xContext( m_xControl->getControlContext(), css::uno::UNO_SET_THROW );
 475                 xContext->focusGained( m_xControl );
 476             }
 477             catch( const Exception& )
 478             {
 479                 DBG_UNHANDLED_EXCEPTION("extensions.propctrlr");
 480             }
 481         }
 482     }
 483
 484 } // namespace pcr
 485
 486
 487 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */