extensions/source/propctrlr/browserline.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: browserline.cxx,v $
  10  * $Revision: 1.20 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_extensions.hxx"
  33 #include "browserline.hxx"
  34
  35 /** === begin UNO includes === **/
  36 #include <com/sun/star/inspection/PropertyLineElement.hpp>
  37 #include <com/sun/star/graphic/XGraphicProvider.hpp>
  38 /** === end UNO includes === **/
  39
  40 #include <vcl/svapp.hxx>
  41 #include <tools/debug.hxx>
  42 #include <tools/diagnose_ex.h>
  43 #include <tools/urlobj.hxx>
  44 #include <toolkit/helper/vclunohelper.hxx>
  45
  46 #include <comphelper/processfactory.hxx>
  47 #include <comphelper/componentcontext.hxx>
  48
  49 //............................................................................
  50 namespace pcr
  51 {
  52 //............................................................................
  53
  54     /** === begin UNO using === **/
  55     using ::com::sun::star::uno::Reference;
  56     using ::com::sun::star::inspection::XPropertyControl;
  57     using ::com::sun::star::inspection::XPropertyControlContext;
  58     using ::com::sun::star::uno::UNO_QUERY_THROW;
  59     using ::com::sun::star::uno::Exception;
  60     using ::com::sun::star::graphic::XGraphicProvider;
  61     using ::com::sun::star::uno::Sequence;
  62     using ::com::sun::star::beans::PropertyValue;
  63     using ::com::sun::star::graphic::XGraphic;
  64     /** === end UNO using === **/
  65
  66     namespace PropertyLineElement = ::com::sun::star::inspection::PropertyLineElement;
  67
  68     //==================================================================
  69     //= OBrowserLine
  70     //==================================================================
  71     DBG_NAME(OBrowserLine)
  72     //------------------------------------------------------------------
  73
  74     OBrowserLine::OBrowserLine( const ::rtl::OUString& _rEntryName, Window* pParent )
  75             :m_sEntryName( _rEntryName )
  76             ,m_aFtTitle(pParent)
  77             ,m_pControlWindow( NULL )
  78             ,m_pBrowseButton(NULL)
  79             ,m_pAdditionalBrowseButton( NULL )
  80             ,m_pClickListener( NULL )
  81             ,m_pTheParent(pParent)
  82             ,m_nNameWidth(0)
  83             ,m_nEnableFlags( 0xFFFF )
  84             ,m_bIndentTitle( false )
  85             ,m_bReadOnly( false )
  86     {
  87         DBG_CTOR(OBrowserLine,NULL);
  88         m_aFtTitle.Show();
  89     }
  90
  91     //------------------------------------------------------------------
  92     OBrowserLine::~OBrowserLine()
  93     {
  94         implHideBrowseButton( true, false );
  95         implHideBrowseButton( false, false );
  96
  97         DBG_DTOR(OBrowserLine,NULL);
  98     }
  99
 100     //------------------------------------------------------------------
 101     void OBrowserLine::IndentTitle( bool _bIndent )
 102     {
 103         if ( m_bIndentTitle != _bIndent )
 104         {
 105             m_bIndentTitle = _bIndent;
 106             impl_layoutComponents();
 107         }
 108     }
 109
 110     //------------------------------------------------------------------
 111     void OBrowserLine::SetComponentHelpIds( const SmartId& _rHelpId, sal_uInt32 _bPrimaryButtonId, sal_uInt32 _nSecondaryButtonId )
 112     {
 113         if ( m_pControlWindow )
 114             m_pControlWindow->SetSmartHelpId( _rHelpId );
 115
 116         if ( m_pBrowseButton )
 117         {
 118             m_pBrowseButton->SetSmartHelpId( _rHelpId );
 119             m_pBrowseButton->SetUniqueId( _bPrimaryButtonId );
 120
 121             if ( m_pAdditionalBrowseButton )
 122             {
 123                 m_pAdditionalBrowseButton->SetSmartHelpId( _rHelpId );
 124                 m_pAdditionalBrowseButton->SetUniqueId( _nSecondaryButtonId );
 125             }
 126         }
 127     }
 128
 129     //------------------------------------------------------------------
 130     void OBrowserLine::setControl( const Reference< XPropertyControl >& _rxControl )
 131     {
 132         m_xControl = _rxControl;
 133         m_pControlWindow = m_xControl.is() ? VCLUnoHelper::GetWindow( _rxControl->getControlWindow() ) : NULL;
 134         DBG_ASSERT( m_pControlWindow, "OBrowserLine::setControl: setting NULL controls/windows is not allowed!" );
 135
 136         if ( m_pControlWindow )
 137         {
 138             m_pControlWindow->SetParent( m_pTheParent );
 139             m_pControlWindow->Show();
 140         }
 141         impl_layoutComponents();
 142     }
 143
 144     //------------------------------------------------------------------
 145     Window* OBrowserLine::GetRefWindow()
 146     {
 147         Window* pRefWindow=&m_aFtTitle;
 148
 149         if(m_pBrowseButton)
 150         {
 151             pRefWindow=(Window*)m_pBrowseButton;
 152         }
 153         else if ( m_pControlWindow )
 154         {
 155             pRefWindow = m_pControlWindow;
 156         }
 157         return pRefWindow;
 158     }
 159
 160     //------------------------------------------------------------------
 161     void OBrowserLine::SetTabOrder(Window* pRefWindow, sal_uInt16 nFlags )
 162     {
 163         m_aFtTitle.SetZOrder(pRefWindow,nFlags);
 164         if ( m_pControlWindow )
 165             m_pControlWindow->SetZOrder( (Window*)&m_aFtTitle, WINDOW_ZORDER_BEHIND );
 166
 167         if ( m_pBrowseButton )
 168             m_pBrowseButton->SetZOrder( m_pControlWindow, WINDOW_ZORDER_BEHIND );
 169
 170         if ( m_pAdditionalBrowseButton )
 171             m_pAdditionalBrowseButton->SetZOrder( m_pBrowseButton, WINDOW_ZORDER_BEHIND );
 172     }
 173
 174     //------------------------------------------------------------------
 175     sal_Bool OBrowserLine::GrabFocus()
 176     {
 177         sal_Bool bRes=sal_False;
 178
 179         if ( m_pControlWindow && m_pControlWindow->IsEnabled() )
 180         {
 181             m_pControlWindow->GrabFocus();
 182             bRes = sal_True;
 183         }
 184         else if ( m_pAdditionalBrowseButton && m_pAdditionalBrowseButton->IsEnabled() )
 185         {
 186             m_pAdditionalBrowseButton->GrabFocus();
 187             bRes = sal_True;
 188         }
 189         else if ( m_pBrowseButton && m_pBrowseButton->IsEnabled() )
 190         {
 191             m_pBrowseButton->GrabFocus();
 192             bRes = sal_True;
 193         }
 194         return bRes;
 195     }
 196
 197     //------------------------------------------------------------------
 198     void OBrowserLine::SetPosSizePixel( Point _rPos, Size _rSize )
 199     {
 200         m_aLinePos = _rPos;
 201         m_aOutputSize = _rSize;
 202
 203         impl_layoutComponents();
 204     }
 205
 206     //------------------------------------------------------------------
 207     void OBrowserLine::Show(sal_Bool bFlag)
 208     {
 209         m_aFtTitle.Show(bFlag);
 210         if ( m_pControlWindow )
 211             m_pControlWindow->Show( bFlag );
 212         if ( m_pBrowseButton )
 213             m_pBrowseButton->Show( bFlag );
 214         if ( m_pAdditionalBrowseButton )
 215             m_pAdditionalBrowseButton->Show( bFlag );
 216     }
 217
 218     //------------------------------------------------------------------
 219     void OBrowserLine::Hide()
 220     {
 221         Show(sal_False);
 222     }
 223
 224     //------------------------------------------------------------------
 225     sal_Bool OBrowserLine::IsVisible()
 226     {
 227         return m_aFtTitle.IsVisible();
 228     }
 229
 230     //------------------------------------------------------------------
 231     void OBrowserLine::impl_layoutComponents()
 232     {
 233         {
 234             Point aTitlePos( m_aLinePos.X(), m_aLinePos.Y() + 8 );
 235             Size aTitleSize( m_nNameWidth - 3, m_aOutputSize.Height() );
 236
 237             if ( m_bIndentTitle )
 238             {
 239                 Size aIndent( m_pTheParent->LogicToPixel( Size( 8, 0 ), MAP_APPFONT ) );
 240                 aTitlePos.X() += aIndent.Width();
 241                 aTitleSize.Width() -= aIndent.Width();
 242             }
 243             m_aFtTitle.SetPosSizePixel( aTitlePos, aTitleSize );
 244         }
 245
 246         sal_Int32 nBrowseButtonSize = m_aOutputSize.Height() - 4;
 247
 248         if ( m_pControlWindow )
 249         {
 250             Point aControlPos( m_aLinePos.X() + m_nNameWidth, m_aLinePos.Y() + 2 );
 251             m_pControlWindow->SetPosPixel( aControlPos );
 252
 253             Size aControlSize( m_aOutputSize.Width() - 4 - m_nNameWidth - nBrowseButtonSize - 4, m_pControlWindow->GetSizePixel().Height() );
 254             if ( m_pAdditionalBrowseButton )
 255                 aControlSize.Width() -= nBrowseButtonSize + 4;
 256             m_pControlWindow->SetSizePixel( aControlSize );
 257         }
 258
 259         if ( m_pBrowseButton )
 260         {
 261             Point aButtonPos( m_aOutputSize.Width() - 4 - nBrowseButtonSize, m_aLinePos.Y() + 2 );
 262             Size aButtonSize( nBrowseButtonSize, nBrowseButtonSize );
 263             m_pBrowseButton->SetPosSizePixel( aButtonPos, aButtonSize );
 264
 265             if ( m_pAdditionalBrowseButton )
 266             {
 267                 aButtonPos.X() -= nBrowseButtonSize + 4;
 268                 m_pAdditionalBrowseButton->SetPosSizePixel( aButtonPos, aButtonSize );
 269             }
 270         }
 271     }
 272
 273     //------------------------------------------------------------------
 274     void OBrowserLine::SetTitle(const XubString& _rNewTtile )
 275     {
 276         if ( GetTitle() == _rNewTtile )
 277             return;
 278         // #99102# --------------
 279         m_aFtTitle.SetText( _rNewTtile );
 280         if ( m_pControlWindow )
 281             m_pControlWindow->SetAccessibleName( _rNewTtile );
 282         if ( m_pBrowseButton )
 283             m_pBrowseButton->SetAccessibleName( _rNewTtile );
 284         FullFillTitleString();
 285     }
 286
 287     // #99102# ---------------------------------------------------------
 288     void OBrowserLine::FullFillTitleString()
 289     {
 290         if( m_pTheParent )
 291         {
 292             String aText = m_aFtTitle.GetText();
 293
 294             while( m_pTheParent->GetTextWidth( aText ) < m_nNameWidth )
 295                         aText.AppendAscii("...........");
 296
 297             // for Issue 69452
 298             if (Application::GetSettings().GetLayoutRTL())
 299             {
 300                 sal_Unicode cRTL_mark = 0x200F;
 301                 aText.Append(cRTL_mark);
 302             }
 303
 304             m_aFtTitle.SetText(aText);
 305         }
 306     }
 307
 308     //------------------------------------------------------------------
 309     XubString OBrowserLine::GetTitle() const
 310     {
 311         String sDisplayName = m_aFtTitle.GetText();
 312
 313     // for Issue 69452
 314     if (Application::GetSettings().GetLayoutRTL())
 315     {
 316         sal_Unicode cRTL_mark = 0x200F;
 317         sDisplayName.EraseTrailingChars(cRTL_mark);
 318     }
 319
 320         sDisplayName.EraseTrailingChars( '.' );
 321
 322         return sDisplayName;
 323     }
 324
 325     //------------------------------------------------------------------
 326     sal_Bool OBrowserLine::IsPropertyInputEnabled( ) const
 327     {
 328         return ( m_nEnableFlags & PropertyLineElement::InputControl ) != 0;
 329     }
 330
 331     //------------------------------------------------------------------
 332     void OBrowserLine::SetReadOnly( bool _bReadOnly )
 333     {
 334         if ( m_bReadOnly != _bReadOnly )
 335         {
 336             m_bReadOnly = _bReadOnly;
 337             implUpdateEnabledDisabled();
 338         }
 339     }
 340
 341     //------------------------------------------------------------------
 342     namespace
 343     {
 344         void implSetBitIfAffected( sal_uInt16& _nEnabledBits, sal_Int16 _nAffectedMask, sal_Int16 _nTestBit, bool _bSet )
 345         {
 346             if ( _nAffectedMask & _nTestBit )
 347             {
 348                 if ( _bSet )
 349                     _nEnabledBits |= _nTestBit;
 350                 else
 351                     _nEnabledBits &= ~_nTestBit;
 352             }
 353         }
 354
 355         void implEnable( Window* _pWindow, sal_uInt16 _nEnabledBits, sal_uInt16 _nMatchBits  )
 356         {
 357             if ( _pWindow )
 358                 _pWindow->Enable( ( _nEnabledBits & _nMatchBits ) == _nMatchBits );
 359         }
 360
 361         void implEnable( Window* _pWindow, bool _bEnable )
 362         {
 363             if ( _pWindow )
 364                 _pWindow->Enable( _bEnable );
 365         }
 366     }
 367
 368     //------------------------------------------------------------------
 369     void OBrowserLine::implUpdateEnabledDisabled()
 370     {
 371         implEnable( &m_aFtTitle,                m_nEnableFlags, PropertyLineElement::CompleteLine );
 372         if ( m_pControlWindow )
 373             implEnable( m_pControlWindow,       m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::InputControl );
 374
 375         if ( m_bReadOnly )
 376         {
 377             implEnable( m_pBrowseButton,            false );
 378             implEnable( m_pAdditionalBrowseButton,  false );
 379         }
 380         else
 381         {
 382             implEnable( m_pBrowseButton,            m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::PrimaryButton );
 383             implEnable( m_pAdditionalBrowseButton,  m_nEnableFlags, PropertyLineElement::CompleteLine | PropertyLineElement::SecondaryButton );
 384         }
 385     }
 386
 387     //------------------------------------------------------------------
 388     void OBrowserLine::EnablePropertyLine( bool _bEnable )
 389     {
 390         implSetBitIfAffected( m_nEnableFlags, PropertyLineElement::CompleteLine, PropertyLineElement::CompleteLine, _bEnable );
 391         implUpdateEnabledDisabled();
 392     }
 393
 394     //------------------------------------------------------------------
 395     void OBrowserLine::EnablePropertyControls( sal_Int16 _nControls, bool _bEnable )
 396     {
 397         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::InputControl, _bEnable );
 398         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::PrimaryButton, _bEnable );
 399         implSetBitIfAffected( m_nEnableFlags, _nControls, PropertyLineElement::SecondaryButton, _bEnable );
 400         implUpdateEnabledDisabled();
 401     }
 402
 403     //------------------------------------------------------------------
 404     PushButton& OBrowserLine::impl_ensureButton( bool _bPrimary )
 405     {
 406         PushButton*& rpButton = _bPrimary ? m_pBrowseButton : m_pAdditionalBrowseButton;
 407
 408         if ( !rpButton )
 409         {
 410             rpButton = new PushButton( m_pTheParent, WB_NOPOINTERFOCUS );
 411             rpButton->SetGetFocusHdl( LINK( this, OBrowserLine, OnButtonFocus ) );
 412             rpButton->SetClickHdl( LINK( this, OBrowserLine, OnButtonClicked ) );
 413             rpButton->SetText( String::CreateFromAscii( "..." ) );
 414         }
 415
 416         rpButton->Show();
 417
 418         impl_layoutComponents();
 419
 420         return *rpButton;
 421     }
 422
 423     //------------------------------------------------------------------
 424     void OBrowserLine::impl_getImagesFromURL_nothrow( const ::rtl::OUString& _rImageURL, Image& _out_rImage, Image& _out_rHCImage )
 425     {
 426         try
 427         {
 428             ::comphelper::ComponentContext aContext( ::comphelper::getProcessServiceFactory() );
 429             Reference< XGraphicProvider > xGraphicProvider( aContext.createComponent( "com.sun.star.graphic.GraphicProvider" ), UNO_QUERY_THROW );
 430
 431             Sequence< PropertyValue > aMediaProperties(1);
 432             aMediaProperties[0].Name = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "URL" ) );
 433             aMediaProperties[0].Value <<= _rImageURL;
 434
 435             Reference< XGraphic > xGraphic( xGraphicProvider->queryGraphic( aMediaProperties ), UNO_QUERY_THROW );
 436             _out_rImage = _out_rHCImage = Image( xGraphic );
 437
 438             // see if we find an HC version beside the normal graphic
 439             INetURLObject aURL( _rImageURL );
 440             ::rtl::OUString sBaseName( aURL.getBase() );
 441             aURL.setBase( sBaseName + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "_hc" ) ) );
 442             ::rtl::OUString sHCImageURL( aURL.GetMainURL( INetURLObject::NO_DECODE ) );
 443
 444             Reference< XGraphic > xHCGraphic;
 445             try
 446             {
 447                 aMediaProperties[0].Value <<= sHCImageURL;
 448                 xHCGraphic = xGraphicProvider->queryGraphic( aMediaProperties );
 449             }
 450             catch( const Exception& ) { }
 451
 452             if ( xHCGraphic.is() )
 453                 _out_rHCImage = Image( xHCGraphic );
 454         }
 455         catch( const Exception& )
 456         {
 457             DBG_UNHANDLED_EXCEPTION();
 458         }
 459     }
 460
 461     //------------------------------------------------------------------
 462     void OBrowserLine::ShowBrowseButton( const ::rtl::OUString& _rImageURL, sal_Bool _bPrimary )
 463     {
 464         PushButton& rButton( impl_ensureButton( _bPrimary ) );
 465
 466         OSL_PRECOND( _rImageURL.getLength(), "OBrowserLine::ShowBrowseButton: use the other version if you don't have an image!" );
 467         Image aImage, aHCImage;
 468         impl_getImagesFromURL_nothrow( _rImageURL, aImage, aHCImage );
 469
 470         rButton.SetModeImage( aImage, BMP_COLOR_NORMAL );
 471         rButton.SetModeImage( aHCImage, BMP_COLOR_HIGHCONTRAST );
 472     }
 473
 474     //------------------------------------------------------------------
 475     void OBrowserLine::ShowBrowseButton( const Image& _rImage, sal_Bool _bPrimary )
 476     {
 477         PushButton& rButton( impl_ensureButton( _bPrimary ) );
 478         if ( !!_rImage )
 479             rButton.SetModeImage( _rImage );
 480     }
 481
 482     //------------------------------------------------------------------
 483     void OBrowserLine::ShowBrowseButton( sal_Bool _bPrimary )
 484     {
 485         impl_ensureButton( _bPrimary );
 486     }
 487
 488     //------------------------------------------------------------------
 489     void OBrowserLine::implHideBrowseButton( sal_Bool _bPrimary, bool _bReLayout )
 490     {
 491         PushButton*& rpButton = _bPrimary ? m_pBrowseButton : m_pAdditionalBrowseButton;
 492
 493         if ( rpButton )
 494         {
 495             rpButton->Hide();
 496             delete rpButton;
 497             rpButton = NULL;
 498         }
 499
 500         if ( _bReLayout )
 501             impl_layoutComponents();
 502     }
 503
 504     //------------------------------------------------------------------
 505     void OBrowserLine::HideBrowseButton( sal_Bool _bPrimary )
 506     {
 507         implHideBrowseButton( _bPrimary, true );
 508     }
 509
 510     //------------------------------------------------------------------
 511     void OBrowserLine::SetTitleWidth(sal_uInt16 nWidth)
 512     {
 513         if (m_nNameWidth != nWidth+10)
 514         {
 515             m_nNameWidth = nWidth+10;
 516             impl_layoutComponents();
 517         }
 518         // #99102# ---------
 519         FullFillTitleString();
 520     }
 521
 522     //------------------------------------------------------------------
 523     void OBrowserLine::SetClickListener( IButtonClickListener* _pListener )
 524     {
 525         m_pClickListener = _pListener;
 526     }
 527
 528     //------------------------------------------------------------------
 529     IMPL_LINK( OBrowserLine, OnButtonClicked, PushButton*, _pButton )
 530     {
 531         if ( m_pClickListener )
 532             m_pClickListener->buttonClicked( this, _pButton == m_pBrowseButton );
 533
 534         return 0L;
 535     }
 536
 537     //------------------------------------------------------------------
 538     IMPL_LINK( OBrowserLine, OnButtonFocus, PushButton*, /*pPB*/ )
 539     {
 540         if ( m_xControl.is() )
 541         {
 542             try
 543             {
 544                 Reference< XPropertyControlContext > xContext( m_xControl->getControlContext(), UNO_QUERY_THROW );
 545                 xContext->focusGained( m_xControl );
 546             }
 547             catch( const Exception& )
 548             {
 549                 DBG_UNHANDLED_EXCEPTION();
 550             }
 551         }
 552         return 0;
 553     }
 554 //............................................................................
 555 } // namespace pcr
 556 //............................................................................
 557