vcl/source/control/ctrl.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 <comphelper/processfactory.hxx>
  21 #include <comphelper/lok.hxx>
  22
  23 #include <tools/rc.h>
  24 #include <vcl/svapp.hxx>
  25 #include <vcl/event.hxx>
  26 #include <vcl/ctrl.hxx>
  27 #include <vcl/floatwin.hxx>
  28 #include <vcl/decoview.hxx>
  29 #include <vcl/dialog.hxx>
  30 #include <vcl/salnativewidgets.hxx>
  31 #include <vcl/settings.hxx>
  32
  33 #include <textlayout.hxx>
  34 #include <svdata.hxx>
  35 #include <controldata.hxx>
  36
  37 using namespace vcl;
  38
  39 void Control::ImplInitControlData()
  40 {
  41     mbHasControlFocus       = false;
  42     mbShowAccelerator       = false;
  43     mpControlData   = new ImplControlData;
  44 }
  45
  46 Control::Control( WindowType nType ) :
  47     Window( nType )
  48 {
  49     ImplInitControlData();
  50 }
  51
  52 Control::Control( vcl::Window* pParent, WinBits nStyle ) :
  53     Window( WINDOW_CONTROL )
  54 {
  55     ImplInitControlData();
  56     ImplInit( pParent, nStyle, nullptr );
  57 }
  58
  59 Control::~Control()
  60 {
  61     disposeOnce();
  62 }
  63
  64 void Control::dispose()
  65 {
  66     delete mpControlData;
  67     mpControlData = nullptr;
  68     Window::dispose();
  69 }
  70
  71 void Control::EnableRTL( bool bEnable )
  72 {
  73     // convenience: for controls also switch layout mode
  74     SetLayoutMode( bEnable ? ComplexTextLayoutFlags::BiDiRtl | ComplexTextLayoutFlags::TextOriginLeft :
  75                                 ComplexTextLayoutFlags::TextOriginLeft );
  76     CompatStateChanged( StateChangedType::Mirroring );
  77     OutputDevice::EnableRTL(bEnable);
  78 }
  79
  80 void Control::Resize()
  81 {
  82     ImplClearLayoutData();
  83     Window::Resize();
  84 }
  85
  86 void Control::FillLayoutData() const
  87 {
  88 }
  89
  90 void Control::CreateLayoutData() const
  91 {
  92     SAL_WARN_IF( mpControlData->mpLayoutData, "vcl", "Control::CreateLayoutData: should be called with non-existent layout data only!" );
  93     mpControlData->mpLayoutData.reset( new vcl::ControlLayoutData );
  94 }
  95
  96 bool Control::HasLayoutData() const
  97 {
  98     return mpControlData && mpControlData->mpLayoutData != nullptr;
  99 }
 100
 101 void Control::SetText( const OUString& rStr )
 102 {
 103     ImplClearLayoutData();
 104     Window::SetText( rStr );
 105 }
 106
 107 ControlLayoutData::ControlLayoutData() : m_pParent( nullptr )
 108 {
 109 }
 110
 111 Rectangle ControlLayoutData::GetCharacterBounds( long nIndex ) const
 112 {
 113     return (nIndex >= 0 && nIndex < (long) m_aUnicodeBoundRects.size()) ? m_aUnicodeBoundRects[ nIndex ] : Rectangle();
 114 }
 115
 116 Rectangle Control::GetCharacterBounds( long nIndex ) const
 117 {
 118     if( !HasLayoutData() )
 119         FillLayoutData();
 120     return mpControlData->mpLayoutData ? mpControlData->mpLayoutData->GetCharacterBounds( nIndex ) : Rectangle();
 121 }
 122
 123 long ControlLayoutData::GetIndexForPoint( const Point& rPoint ) const
 124 {
 125     long nIndex = -1;
 126     for( long i = m_aUnicodeBoundRects.size()-1; i >= 0; i-- )
 127     {
 128         Point aTopLeft = m_aUnicodeBoundRects[i].TopLeft();
 129         Point aBottomRight = m_aUnicodeBoundRects[i].BottomRight();
 130         if (rPoint.X() >= aTopLeft.X() && rPoint.Y() >= aTopLeft.Y() &&
 131             rPoint.X() <= aBottomRight.X() && rPoint.Y() <= aBottomRight.Y())
 132         {
 133             nIndex = i;
 134             break;
 135         }
 136     }
 137     return nIndex;
 138 }
 139
 140 long Control::GetIndexForPoint( const Point& rPoint ) const
 141 {
 142     if( ! HasLayoutData() )
 143         FillLayoutData();
 144     return mpControlData->mpLayoutData ? mpControlData->mpLayoutData->GetIndexForPoint( rPoint ) : -1;
 145 }
 146
 147 long ControlLayoutData::GetLineCount() const
 148 {
 149     long nLines = m_aLineIndices.size();
 150     if( nLines == 0 && !m_aDisplayText.isEmpty() )
 151         nLines = 1;
 152     return nLines;
 153 }
 154
 155 Pair ControlLayoutData::GetLineStartEnd( long nLine ) const
 156 {
 157     Pair aPair( -1, -1 );
 158
 159     int nDisplayLines = m_aLineIndices.size();
 160     if( nLine >= 0 && nLine < nDisplayLines )
 161     {
 162         aPair.A() = m_aLineIndices[nLine];
 163         if( nLine+1 < nDisplayLines )
 164             aPair.B() = m_aLineIndices[nLine+1]-1;
 165         else
 166             aPair.B() = m_aDisplayText.getLength()-1;
 167     }
 168     else if( nLine == 0 && nDisplayLines == 0 && !m_aDisplayText.isEmpty() )
 169     {
 170         // special case for single line controls so the implementations
 171         // in that case do not have to fill in the line indices
 172         aPair.A() = 0;
 173         aPair.B() = m_aDisplayText.getLength()-1;
 174     }
 175     return aPair;
 176 }
 177
 178 Pair Control::GetLineStartEnd( long nLine ) const
 179 {
 180     if( !HasLayoutData() )
 181         FillLayoutData();
 182     return mpControlData->mpLayoutData ? mpControlData->mpLayoutData->GetLineStartEnd( nLine ) : Pair( -1, -1 );
 183 }
 184
 185 long ControlLayoutData::ToRelativeLineIndex( long nIndex ) const
 186 {
 187     // is the index sensible at all ?
 188     if( nIndex >= 0 && nIndex < m_aDisplayText.getLength() )
 189     {
 190         int nDisplayLines = m_aLineIndices.size();
 191         // if only 1 line exists, then absolute and relative index are
 192         // identical -> do nothing
 193         if( nDisplayLines > 1 )
 194         {
 195             int nLine;
 196             for( nLine = nDisplayLines-1; nLine >= 0; nLine-- )
 197             {
 198                 if( m_aLineIndices[nLine] <= nIndex )
 199                 {
 200                     nIndex -= m_aLineIndices[nLine];
 201                     break;
 202                 }
 203             }
 204             if( nLine < 0 )
 205             {
 206                 SAL_WARN_IF( nLine < 0, "vcl", "ToRelativeLineIndex failed" );
 207                 nIndex = -1;
 208             }
 209         }
 210     }
 211     else
 212         nIndex = -1;
 213
 214     return nIndex;
 215 }
 216
 217 long Control::ToRelativeLineIndex( long nIndex ) const
 218 {
 219     if( !HasLayoutData() )
 220         FillLayoutData();
 221     return mpControlData->mpLayoutData ? mpControlData->mpLayoutData->ToRelativeLineIndex( nIndex ) : -1;
 222 }
 223
 224 OUString Control::GetDisplayText() const
 225 {
 226     if( !HasLayoutData() )
 227         FillLayoutData();
 228     return mpControlData->mpLayoutData ? OUString(mpControlData->mpLayoutData->m_aDisplayText) : GetText();
 229 }
 230
 231 bool Control::EventNotify( NotifyEvent& rNEvt )
 232 {
 233     // tdf#91081 if control is not valid, skip the emission - chaining to the parent
 234     if (mpControlData)
 235     {
 236         if ( rNEvt.GetType() == MouseNotifyEvent::GETFOCUS )
 237         {
 238             if ( !mbHasControlFocus )
 239             {
 240                 mbHasControlFocus = true;
 241                 CompatStateChanged( StateChangedType::ControlFocus );
 242                 if ( ImplCallEventListenersAndHandler( VCLEVENT_CONTROL_GETFOCUS, [this] () { maGetFocusHdl.Call(*this); } ) )
 243                     // been destroyed within the handler
 244                     return true;
 245             }
 246         }
 247         else
 248         {
 249             if ( rNEvt.GetType() == MouseNotifyEvent::LOSEFOCUS )
 250             {
 251                 vcl::Window* pFocusWin = Application::GetFocusWindow();
 252                 if ( !pFocusWin || !ImplIsWindowOrChild( pFocusWin ) )
 253                 {
 254                     mbHasControlFocus = false;
 255                     CompatStateChanged( StateChangedType::ControlFocus );
 256                     if ( ImplCallEventListenersAndHandler( VCLEVENT_CONTROL_LOSEFOCUS, [this] () { maLoseFocusHdl.Call(*this); } ) )
 257                         // been destroyed within the handler
 258                         return true;
 259                 }
 260             }
 261         }
 262     }
 263     return Window::EventNotify( rNEvt );
 264 }
 265
 266 void Control::StateChanged( StateChangedType nStateChange )
 267 {
 268     if( nStateChange == StateChangedType::InitShow   ||
 269         nStateChange == StateChangedType::Visible    ||
 270         nStateChange == StateChangedType::Zoom       ||
 271         nStateChange == StateChangedType::Border     ||
 272         nStateChange == StateChangedType::ControlFont
 273         )
 274     {
 275         ImplClearLayoutData();
 276     }
 277     Window::StateChanged( nStateChange );
 278 }
 279
 280 void Control::AppendLayoutData( const Control& rSubControl ) const
 281 {
 282     if( !rSubControl.HasLayoutData() )
 283         rSubControl.FillLayoutData();
 284     if( !rSubControl.HasLayoutData() || rSubControl.mpControlData->mpLayoutData->m_aDisplayText.isEmpty() )
 285         return;
 286
 287     long nCurrentIndex = mpControlData->mpLayoutData->m_aDisplayText.getLength();
 288     mpControlData->mpLayoutData->m_aDisplayText += rSubControl.mpControlData->mpLayoutData->m_aDisplayText;
 289     int nLines = rSubControl.mpControlData->mpLayoutData->m_aLineIndices.size();
 290     int n;
 291     mpControlData->mpLayoutData->m_aLineIndices.push_back( nCurrentIndex );
 292     for( n = 1; n < nLines; n++ )
 293         mpControlData->mpLayoutData->m_aLineIndices.push_back( rSubControl.mpControlData->mpLayoutData->m_aLineIndices[n] + nCurrentIndex );
 294     int nRectangles = rSubControl.mpControlData->mpLayoutData->m_aUnicodeBoundRects.size();
 295         Rectangle aRel = const_cast<Control&>(rSubControl).GetWindowExtentsRelative( const_cast<Control*>(this) );
 296     for( n = 0; n < nRectangles; n++ )
 297     {
 298         Rectangle aRect = rSubControl.mpControlData->mpLayoutData->m_aUnicodeBoundRects[n];
 299         aRect.Move( aRel.Left(), aRel.Top() );
 300         mpControlData->mpLayoutData->m_aUnicodeBoundRects.push_back( aRect );
 301     }
 302 }
 303
 304 bool Control::ImplCallEventListenersAndHandler( sal_uLong nEvent, std::function<void()> const & callHandler )
 305 {
 306     VclPtr<Control> xThis(this);
 307
 308     CallEventListeners( nEvent );
 309
 310     if ( !xThis->IsDisposed() )
 311     {
 312         if (callHandler)
 313         {
 314             callHandler();
 315         }
 316
 317         if ( !xThis->IsDisposed() )
 318             return false;
 319     }
 320     return true;
 321 }
 322
 323 void Control::SetLayoutDataParent( const Control* pParent ) const
 324 {
 325     if( HasLayoutData() )
 326         mpControlData->mpLayoutData->m_pParent = pParent;
 327 }
 328
 329 void Control::ImplClearLayoutData() const
 330 {
 331     if (mpControlData)
 332         mpControlData->mpLayoutData.reset();
 333 }
 334
 335 void Control::ImplDrawFrame( OutputDevice* pDev, Rectangle& rRect )
 336 {
 337     // use a deco view to draw the frame
 338     // However, since there happens a lot of magic there, we need to fake some (style) settings
 339     // on the device
 340     AllSettings aOriginalSettings( pDev->GetSettings() );
 341
 342     AllSettings aNewSettings( aOriginalSettings );
 343     StyleSettings aStyle( aNewSettings.GetStyleSettings() );
 344
 345     // The *only known* clients of the Draw methods of the various VCL-controls are form controls:
 346     // During print preview, and during printing, Draw is called. Thus, drawing always happens with a
 347     // mono (colored) border
 348     aStyle.SetOptions( aStyle.GetOptions() | StyleSettingsOptions::Mono );
 349     aStyle.SetMonoColor( GetSettings().GetStyleSettings().GetMonoColor() );
 350
 351     aNewSettings.SetStyleSettings( aStyle );
 352     // #i67023# do not call data changed listeners for this fake
 353     // since they may understandably invalidate on settings changed
 354     pDev->OutputDevice::SetSettings( aNewSettings );
 355
 356     DecorationView aDecoView( pDev );
 357     rRect = aDecoView.DrawFrame( rRect, DrawFrameStyle::Out, DrawFrameFlags::WindowBorder );
 358
 359     pDev->OutputDevice::SetSettings( aOriginalSettings );
 360 }
 361
 362 void Control::SetShowAccelerator(bool bVal)
 363 {
 364     mbShowAccelerator = bVal;
 365 };
 366
 367 ControlLayoutData::~ControlLayoutData()
 368 {
 369     if( m_pParent )
 370         m_pParent->ImplClearLayoutData();
 371 }
 372
 373 Size Control::GetOptimalSize() const
 374 {
 375     return Size( GetTextWidth( GetText() ) + 2 * 12,
 376                  GetTextHeight() + 2 * 6 );
 377 }
 378
 379 void Control::SetReferenceDevice( OutputDevice* _referenceDevice )
 380 {
 381     if ( mpControlData->mpReferenceDevice == _referenceDevice )
 382         return;
 383
 384     mpControlData->mpReferenceDevice = _referenceDevice;
 385     Invalidate();
 386 }
 387
 388 OutputDevice* Control::GetReferenceDevice() const
 389 {
 390     return mpControlData->mpReferenceDevice;
 391 }
 392
 393 const vcl::Font& Control::GetCanonicalFont( const StyleSettings& _rStyle ) const
 394 {
 395     return _rStyle.GetLabelFont();
 396 }
 397
 398 const Color& Control::GetCanonicalTextColor( const StyleSettings& _rStyle ) const
 399 {
 400     return _rStyle.GetLabelTextColor();
 401 }
 402
 403 void Control::ApplySettings(vcl::RenderContext& rRenderContext)
 404 {
 405     const StyleSettings& rStyleSettings = rRenderContext.GetSettings().GetStyleSettings();
 406
 407     vcl::Font rFont(GetCanonicalFont(rStyleSettings));
 408     ApplyControlFont(rRenderContext, rFont);
 409
 410     ApplyControlForeground(rRenderContext, GetCanonicalTextColor(rStyleSettings));
 411     rRenderContext.SetTextFillColor();
 412 }
 413
 414 void Control::ImplInitSettings(const bool, const bool)
 415 {
 416     ApplySettings(*this);
 417 }
 418
 419 Rectangle Control::DrawControlText( OutputDevice& _rTargetDevice, const Rectangle& rRect, const OUString& _rStr,
 420     DrawTextFlags _nStyle, MetricVector* _pVector, OUString* _pDisplayText, const Size* i_pDeviceSize ) const
 421 {
 422     OUString rPStr = _rStr;
 423     DrawTextFlags nPStyle = _nStyle;
 424
 425     bool accel = ImplGetSVData()->maNWFData.mbEnableAccel;
 426     bool autoacc = ImplGetSVData()->maNWFData.mbAutoAccel;
 427
 428     if (!accel || (autoacc && !mbShowAccelerator))
 429     {
 430         rPStr = GetNonMnemonicString( _rStr );
 431         nPStyle &= ~DrawTextFlags::HideMnemonic;
 432     }
 433
 434     if ( !mpControlData->mpReferenceDevice || ( mpControlData->mpReferenceDevice == &_rTargetDevice ) )
 435     {
 436         const Rectangle aRet = _rTargetDevice.GetTextRect(rRect, rPStr, nPStyle);
 437         _rTargetDevice.DrawText(aRet, rPStr, nPStyle, _pVector, _pDisplayText);
 438         return aRet;
 439     }
 440
 441     ControlTextRenderer aRenderer( *this, _rTargetDevice, *mpControlData->mpReferenceDevice );
 442     return aRenderer.DrawText(rRect, rPStr, nPStyle, _pVector, _pDisplayText, i_pDeviceSize);
 443 }
 444
 445 Rectangle Control::GetControlTextRect( OutputDevice& _rTargetDevice, const Rectangle & rRect,
 446                                        const OUString& _rStr, DrawTextFlags _nStyle, Size* o_pDeviceSize ) const
 447 {
 448     OUString rPStr = _rStr;
 449     DrawTextFlags nPStyle = _nStyle;
 450
 451     bool accel = ImplGetSVData()->maNWFData.mbEnableAccel;
 452     bool autoacc = ImplGetSVData()->maNWFData.mbAutoAccel;
 453
 454     if (!accel || (autoacc && !mbShowAccelerator))
 455     {
 456         rPStr = GetNonMnemonicString( _rStr );
 457         nPStyle &= ~DrawTextFlags::HideMnemonic;
 458     }
 459
 460     if ( !mpControlData->mpReferenceDevice || ( mpControlData->mpReferenceDevice == &_rTargetDevice ) )
 461     {
 462         Rectangle aRet = _rTargetDevice.GetTextRect( rRect, rPStr, nPStyle );
 463         if (o_pDeviceSize)
 464         {
 465             *o_pDeviceSize = aRet.GetSize();
 466         }
 467         return aRet;
 468     }
 469
 470     ControlTextRenderer aRenderer( *this, _rTargetDevice, *mpControlData->mpReferenceDevice );
 471     return aRenderer.GetTextRect(rRect, rPStr, nPStyle, o_pDeviceSize);
 472 }
 473
 474 Font
 475 Control::GetUnzoomedControlPointFont() const
 476 {
 477     Font aFont(GetCanonicalFont(GetSettings().GetStyleSettings()));
 478     if (IsControlFont())
 479         aFont.Merge(GetControlFont());
 480     return aFont;
 481 }
 482
 483 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */