svx/source/form/fmcontrolbordermanager.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
  21 #include <fmcontrolbordermanager.hxx>
  22
  23 #include <fmprop.hxx>
  24
  25 #include <com/sun/star/form/validation/XValidatableFormComponent.hpp>
  26 #include <com/sun/star/awt/XTextComponent.hpp>
  27 #include <com/sun/star/awt/XListBox.hpp>
  28 #include <tools/debug.hxx>
  29 #include <osl/diagnose.h>
  30
  31
  32 namespace svxform
  33 {
  34
  35
  36     using namespace ::com::sun::star::uno;
  37     using namespace ::com::sun::star::awt;
  38     using namespace ::com::sun::star::form::validation;
  39
  40
  41     //= helper
  42
  43
  44     static void setUnderline( const Reference< XVclWindowPeer >& _rxPeer, const UnderlineDescriptor& _rUnderline )
  45     {
  46         OSL_ENSURE( _rxPeer.is(), "setUnderline: invalid peer!" );
  47
  48         // the underline type is an aspect of the font
  49         FontDescriptor aFont;
  50         OSL_VERIFY( _rxPeer->getProperty( FM_PROP_FONT ) >>= aFont );
  51         aFont.Underline = _rUnderline.nUnderlineType;
  52         _rxPeer->setProperty( FM_PROP_FONT, makeAny( aFont ) );
  53         // the underline color is a separate property
  54         _rxPeer->setProperty( FM_PROP_TEXTLINECOLOR, makeAny( _rUnderline.nUnderlineColor ) );
  55     }
  56
  57
  58     static void getUnderline( const Reference< XVclWindowPeer >& _rxPeer, UnderlineDescriptor& _rUnderline )
  59     {
  60         OSL_ENSURE( _rxPeer.is(), "getUnderline: invalid peer!" );
  61
  62         FontDescriptor aFont;
  63         OSL_VERIFY( _rxPeer->getProperty( FM_PROP_FONT ) >>= aFont );
  64         _rUnderline.nUnderlineType = aFont.Underline;
  65
  66         OSL_VERIFY( _rxPeer->getProperty( FM_PROP_TEXTLINECOLOR ) >>= _rUnderline.nUnderlineColor );
  67     }
  68
  69
  70     static void getBorder( const Reference< XVclWindowPeer >& _rxPeer, BorderDescriptor& _rBorder )
  71     {
  72         OSL_ENSURE( _rxPeer.is(), "getBorder: invalid peer!" );
  73
  74         OSL_VERIFY( _rxPeer->getProperty( FM_PROP_BORDER ) >>= _rBorder.nBorderType );
  75         OSL_VERIFY( _rxPeer->getProperty( FM_PROP_BORDERCOLOR ) >>= _rBorder.nBorderColor );
  76     }
  77
  78
  79     static void setBorder( const Reference< XVclWindowPeer >& _rxPeer, const BorderDescriptor& _rBorder )
  80     {
  81         OSL_ENSURE( _rxPeer.is(), "setBorder: invalid peer!" );
  82
  83         _rxPeer->setProperty( FM_PROP_BORDER, makeAny( _rBorder.nBorderType ) );
  84         _rxPeer->setProperty( FM_PROP_BORDERCOLOR, makeAny( _rBorder.nBorderColor ) );
  85     }
  86
  87     ControlBorderManager::ControlBorderManager()
  88         :m_nFocusColor    ( 0x000000FF )
  89         ,m_nMouseHoveColor( 0x007098BE )
  90         ,m_nInvalidColor  ( 0x00FF0000 )
  91         ,m_bDynamicBorderColors( false )
  92     {
  93     }
  94
  95
  96     ControlBorderManager::~ControlBorderManager()
  97     {
  98     }
  99
 100
 101     bool ControlBorderManager::canColorBorder( const Reference< XVclWindowPeer >& _rxPeer )
 102     {
 103         OSL_PRECOND( _rxPeer.is(), "ControlBorderManager::canColorBorder: invalid peer!" );
 104
 105         PeerBag::const_iterator aPos = m_aColorableControls.find( _rxPeer );
 106         if ( aPos != m_aColorableControls.end() )
 107             return true;
 108
 109         aPos = m_aNonColorableControls.find( _rxPeer );
 110         if ( aPos != m_aNonColorableControls.end() )
 111             return false;
 112
 113         // this peer is not yet known
 114
 115         // no border coloring for controls which are not for text input
 116         // #i37434# / 2004-11-19 / frank.schoenheit@sun.com
 117         Reference< XTextComponent > xText( _rxPeer, UNO_QUERY );
 118         Reference< XListBox > xListBox( _rxPeer, UNO_QUERY );
 119         if ( xText.is() || xListBox.is() )
 120         {
 121             sal_Int16 nBorderStyle = VisualEffect::NONE;
 122             OSL_VERIFY( _rxPeer->getProperty( FM_PROP_BORDER ) >>= nBorderStyle );
 123             if ( nBorderStyle == VisualEffect::FLAT )
 124                 // if you change this to also accept LOOK3D, then this would also work, but look ugly
 125             {
 126                 m_aColorableControls.insert( _rxPeer );
 127                 return true;
 128             }
 129         }
 130
 131         m_aNonColorableControls.insert( _rxPeer );
 132         return false;
 133     }
 134
 135
 136     ControlStatus ControlBorderManager::getControlStatus( const Reference< XControl >& _rxControl )
 137     {
 138         ControlStatus nStatus = ControlStatus::NONE;
 139
 140         if ( _rxControl.get() == m_aFocusControl.xControl.get() )
 141             nStatus |= ControlStatus::Focused;
 142
 143         if ( _rxControl.get() == m_aMouseHoverControl.xControl.get() )
 144             nStatus |= ControlStatus::MouseHover;
 145
 146         if ( m_aInvalidControls.find( ControlData( _rxControl ) ) != m_aInvalidControls.end() )
 147             nStatus |= ControlStatus::Invalid;
 148
 149         return nStatus;
 150     }
 151
 152
 153     Color ControlBorderManager::getControlColorByStatus( ControlStatus _nStatus )
 154     {
 155         // "invalid" is ranked highest
 156         if ( _nStatus & ControlStatus::Invalid )
 157             return m_nInvalidColor;
 158
 159         // then, "focused" is more important than ...
 160         if ( _nStatus & ControlStatus::Focused )
 161             return m_nFocusColor;
 162
 163         // ... "mouse over"
 164         if ( _nStatus & ControlStatus::MouseHover )
 165             return m_nMouseHoveColor;
 166
 167         OSL_FAIL( "ControlBorderManager::getControlColorByStatus: invalid status!" );
 168         return Color(0);
 169     }
 170
 171
 172     void ControlBorderManager::updateBorderStyle( const Reference< XControl >& _rxControl, const Reference< XVclWindowPeer >& _rxPeer, const BorderDescriptor& _rFallback )
 173     {
 174         OSL_PRECOND( _rxControl.is() && _rxPeer.is(), "ControlBorderManager::updateBorderStyle: invalid parameters!" );
 175
 176         ControlStatus nStatus = getControlStatus( _rxControl );
 177         BorderDescriptor aBorder;
 178         aBorder.nBorderType =   ( nStatus == ControlStatus::NONE )
 179                             ?   _rFallback.nBorderType
 180                             :   VisualEffect::FLAT;
 181         aBorder.nBorderColor =   ( nStatus == ControlStatus::NONE )
 182                              ?   _rFallback.nBorderColor
 183                              :   getControlColorByStatus( nStatus );
 184         setBorder( _rxPeer, aBorder );
 185     }
 186
 187
 188     void ControlBorderManager::determineOriginalBorderStyle( const Reference< XControl >& _rxControl, BorderDescriptor& _rData ) const
 189     {
 190         _rData = ControlData();
 191         if ( m_aFocusControl.xControl.get() == _rxControl.get() )
 192         {
 193             _rData = m_aFocusControl;
 194         }
 195         else if ( m_aMouseHoverControl.xControl.get() == _rxControl.get() )
 196         {
 197             _rData = m_aMouseHoverControl;
 198         }
 199         else
 200         {
 201             ControlBag::const_iterator aPos = m_aInvalidControls.find( _rxControl );
 202             if ( aPos != m_aInvalidControls.end() )
 203             {
 204                 _rData = *aPos;
 205             }
 206             else
 207             {
 208                 Reference< XVclWindowPeer > xPeer( _rxControl->getPeer(), UNO_QUERY );
 209                 getBorder( xPeer, _rData );
 210             }
 211         }
 212     }
 213
 214
 215     void ControlBorderManager::controlStatusGained( const Reference< XInterface >& _rxControl, ControlData& _rControlData )
 216     {
 217         if ( _rxControl == _rControlData.xControl )
 218             // nothing to do - though suspicious
 219             return;
 220
 221         Reference< XControl > xAsControl( _rxControl, UNO_QUERY );
 222         DBG_ASSERT( xAsControl.is(), "ControlBorderManager::controlStatusGained: invalid control!" );
 223         if ( !xAsControl.is() )
 224             return;
 225
 226         try
 227         {
 228             Reference< XVclWindowPeer > xPeer( xAsControl->getPeer(), UNO_QUERY );
 229             if ( xPeer.is() && canColorBorder( xPeer ) )
 230             {
 231                 // remember the control and its current border color
 232                 _rControlData.xControl.clear(); // so determineOriginalBorderStyle doesn't get confused
 233
 234                 determineOriginalBorderStyle( xAsControl, _rControlData );
 235
 236                 _rControlData.xControl = xAsControl;
 237
 238                 updateBorderStyle( xAsControl, xPeer, _rControlData );
 239             }
 240         }
 241         catch( const Exception& )
 242         {
 243             OSL_FAIL( "ControlBorderManager::controlStatusGained: caught an exception!" );
 244         }
 245     }
 246
 247
 248     void ControlBorderManager::controlStatusLost( const Reference< XInterface >& _rxControl, ControlData& _rControlData )
 249     {
 250         if ( _rxControl != _rControlData.xControl )
 251             // nothing to do
 252             return;
 253
 254         OSL_PRECOND( _rControlData.xControl.is(), "ControlBorderManager::controlStatusLost: invalid control data - this will crash!" );
 255         try
 256         {
 257             Reference< XVclWindowPeer > xPeer( _rControlData.xControl->getPeer(), UNO_QUERY );
 258             if ( xPeer.is() && canColorBorder( xPeer ) )
 259             {
 260                 ControlData aPreviousStatus( _rControlData );
 261                 _rControlData = ControlData();
 262                 updateBorderStyle( aPreviousStatus.xControl, xPeer, aPreviousStatus );
 263             }
 264         }
 265         catch( const Exception& )
 266         {
 267             OSL_FAIL( "ControlBorderManager::controlStatusLost: caught an exception!" );
 268         }
 269     }
 270
 271
 272     void ControlBorderManager::enableDynamicBorderColor( )
 273     {
 274         m_bDynamicBorderColors = true;
 275     }
 276
 277
 278     void ControlBorderManager::disableDynamicBorderColor( )
 279     {
 280         m_bDynamicBorderColors = false;
 281         restoreAll();
 282     }
 283
 284
 285     void ControlBorderManager::setStatusColor( ControlStatus _nStatus, Color _nColor )
 286     {
 287         switch ( _nStatus )
 288         {
 289         case ControlStatus::Focused:
 290             m_nFocusColor = _nColor;
 291             break;
 292         case ControlStatus::MouseHover:
 293             m_nMouseHoveColor = _nColor;
 294             break;
 295         case ControlStatus::Invalid:
 296             m_nInvalidColor = _nColor;
 297             break;
 298         default:
 299             OSL_FAIL( "ControlBorderManager::setStatusColor: invalid status!" );
 300         }
 301     }
 302
 303
 304     void ControlBorderManager::restoreAll()
 305     {
 306         if ( m_aFocusControl.xControl.is() )
 307             controlStatusLost( m_aFocusControl.xControl, m_aFocusControl );
 308         if ( m_aMouseHoverControl.xControl.is() )
 309             controlStatusLost( m_aMouseHoverControl.xControl, m_aMouseHoverControl );
 310
 311         ControlBag aInvalidControls;
 312         m_aInvalidControls.swap( aInvalidControls );
 313
 314         for (const auto& rControl : aInvalidControls)
 315         {
 316             Reference< XVclWindowPeer > xPeer( rControl.xControl->getPeer(), UNO_QUERY );
 317             if ( xPeer.is() )
 318             {
 319                 updateBorderStyle( rControl.xControl, xPeer, rControl );
 320                 xPeer->setProperty( FM_PROP_HELPTEXT, makeAny( rControl.sOriginalHelpText ) );
 321                 setUnderline( xPeer, rControl );
 322             }
 323         }
 324     }
 325
 326
 327     void ControlBorderManager::focusGained( const Reference< XInterface >& _rxControl )
 328     {
 329         if ( m_bDynamicBorderColors )
 330             controlStatusGained( _rxControl, m_aFocusControl );
 331     }
 332
 333
 334     void ControlBorderManager::focusLost( const Reference< XInterface >& _rxControl )
 335     {
 336         if ( m_bDynamicBorderColors )
 337             controlStatusLost( _rxControl, m_aFocusControl );
 338     }
 339
 340
 341     void ControlBorderManager::mouseEntered( const Reference< XInterface >& _rxControl )
 342     {
 343         if ( m_bDynamicBorderColors )
 344             controlStatusGained( _rxControl, m_aMouseHoverControl );
 345     }
 346
 347
 348     void ControlBorderManager::mouseExited( const Reference< XInterface >& _rxControl )
 349     {
 350         if ( m_bDynamicBorderColors )
 351             controlStatusLost( _rxControl, m_aMouseHoverControl );
 352     }
 353
 354
 355     void ControlBorderManager::validityChanged( const Reference< XControl >& _rxControl, const Reference< XValidatableFormComponent >& _rxValidatable )
 356     {
 357         try
 358         {
 359             OSL_ENSURE( _rxControl.is(), "ControlBorderManager::validityChanged: invalid control!" );
 360             OSL_ENSURE( _rxValidatable.is(), "ControlBorderManager::validityChanged: invalid validatable!" );
 361
 362             Reference< XVclWindowPeer > xPeer( _rxControl.is() ? _rxControl->getPeer() : Reference< XWindowPeer >(), UNO_QUERY );
 363             if ( !xPeer.is() || !_rxValidatable.is() )
 364                 return;
 365
 366             ControlData aData( _rxControl );
 367
 368             if ( _rxValidatable->isValid() )
 369             {
 370                 ControlBag::iterator aPos = m_aInvalidControls.find( aData );
 371                 if ( aPos != m_aInvalidControls.end() )
 372                 {   // invalid before, valid now
 373                     ControlData aOriginalLayout( *aPos );
 374                     m_aInvalidControls.erase( aPos );
 375
 376                     // restore all the things we used to indicate invalidity
 377                     if ( m_bDynamicBorderColors )
 378                         updateBorderStyle( _rxControl, xPeer, aOriginalLayout );
 379                     xPeer->setProperty( FM_PROP_HELPTEXT, makeAny( aOriginalLayout.sOriginalHelpText ) );
 380                     setUnderline( xPeer, aOriginalLayout );
 381                 }
 382                 return;
 383             }
 384
 385             // we're here in the INVALID case
 386             if ( m_aInvalidControls.find( _rxControl ) == m_aInvalidControls.end() )
 387             {   // valid before, invalid now
 388
 389                 // remember the current border
 390                 determineOriginalBorderStyle( _rxControl, aData );
 391                 // and tool tip
 392                 xPeer->getProperty( FM_PROP_HELPTEXT ) >>= aData.sOriginalHelpText;
 393                 // and font
 394                 getUnderline( xPeer, aData );
 395
 396                 m_aInvalidControls.insert( aData );
 397
 398                 // update the border to the new invalidity
 399                 if ( m_bDynamicBorderColors && canColorBorder( xPeer ) )
 400                     updateBorderStyle( _rxControl, xPeer, aData );
 401                 else
 402                 {
 403                     // and also the new font
 404                     setUnderline( xPeer, UnderlineDescriptor( css::awt::FontUnderline::WAVE, m_nInvalidColor ) );
 405                 }
 406             }
 407
 408             // update the explanation for invalidity (this is always done, even if the validity did not change)
 409             Reference< XValidator > xValidator = _rxValidatable->getValidator();
 410             OSL_ENSURE( xValidator.is(), "ControlBorderManager::validityChanged: invalid, but no validator?" );
 411             OUString sExplainInvalidity = xValidator.is() ? xValidator->explainInvalid( _rxValidatable->getCurrentValue() ) : OUString();
 412             xPeer->setProperty( FM_PROP_HELPTEXT, makeAny( sExplainInvalidity ) );
 413         }
 414         catch( const Exception& )
 415         {
 416             OSL_FAIL( "ControlBorderManager::validityChanged: caught an exception!" );
 417         }
 418     }
 419
 420
 421 }
 422
 423
 424 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */