toolkit/source/controls/grid/gridcontrol.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 "gridcontrol.hxx"
  22 #include "grideventforwarder.hxx"
  23
  24 #include <com/sun/star/uno/XComponentContext.hpp>
  25 #include <com/sun/star/view/SelectionType.hpp>
  26 #include <com/sun/star/awt/grid/XGridControl.hpp>
  27 #include <com/sun/star/awt/grid/XGridDataModel.hpp>
  28 #include <com/sun/star/awt/grid/XGridRowSelection.hpp>
  29 #include <com/sun/star/awt/grid/XMutableGridDataModel.hpp>
  30 #include <com/sun/star/awt/grid/DefaultGridDataModel.hpp>
  31 #include <com/sun/star/awt/grid/SortableGridDataModel.hpp>
  32 #include <com/sun/star/awt/grid/DefaultGridColumnModel.hpp>
  33 #include <helper/property.hxx>
  34 #include <comphelper/diagnose_ex.hxx>
  35 #include <toolkit/controls/unocontrolbase.hxx>
  36 #include <toolkit/controls/unocontrolmodel.hxx>
  37 #include <toolkit/helper/listenermultiplexer.hxx>
  38
  39 #include <memory>
  40
  41 #include <helper/unopropertyarrayhelper.hxx>
  42
  43 using namespace ::com::sun::star;
  44 using namespace ::com::sun::star::uno;
  45 using namespace ::com::sun::star::awt;
  46 using namespace ::com::sun::star::awt::grid;
  47 using namespace ::com::sun::star::lang;
  48 using namespace ::com::sun::star::beans;
  49 using namespace ::com::sun::star::container;
  50 using namespace ::com::sun::star::view;
  51 using namespace ::com::sun::star::util;
  52
  53 namespace toolkit {
  54
  55 namespace
  56 {
  57     Reference< XGridDataModel > lcl_getDefaultDataModel_throw( const Reference<XComponentContext> & i_context )
  58     {
  59         Reference< XMutableGridDataModel > const xDelegatorModel( DefaultGridDataModel::create( i_context ), UNO_SET_THROW );
  60         Reference< XGridDataModel > const xDataModel( SortableGridDataModel::create( i_context, xDelegatorModel ), UNO_QUERY_THROW );
  61         return xDataModel;
  62     }
  63
  64     Reference< XGridColumnModel > lcl_getDefaultColumnModel_throw( const Reference<XComponentContext> & i_context )
  65     {
  66         Reference< XGridColumnModel > const xColumnModel = DefaultGridColumnModel::create( i_context );
  67         return xColumnModel;
  68     }
  69 }
  70
  71
  72 UnoGridModel::UnoGridModel( const css::uno::Reference< css::uno::XComponentContext >& rxContext )
  73         :UnoControlModel( rxContext )
  74 {
  75     ImplRegisterProperty( BASEPROPERTY_BACKGROUNDCOLOR );
  76     ImplRegisterProperty( BASEPROPERTY_BORDER );
  77     ImplRegisterProperty( BASEPROPERTY_BORDERCOLOR );
  78     ImplRegisterProperty( BASEPROPERTY_DEFAULTCONTROL );
  79     ImplRegisterProperty( BASEPROPERTY_ENABLED );
  80     ImplRegisterProperty( BASEPROPERTY_FILLCOLOR );
  81     ImplRegisterProperty( BASEPROPERTY_HELPTEXT );
  82     ImplRegisterProperty( BASEPROPERTY_HELPURL );
  83     ImplRegisterProperty( BASEPROPERTY_PRINTABLE );
  84     ImplRegisterProperty( BASEPROPERTY_SIZEABLE ); // resizable
  85     ImplRegisterProperty( BASEPROPERTY_HSCROLL );
  86     ImplRegisterProperty( BASEPROPERTY_VSCROLL );
  87     ImplRegisterProperty( BASEPROPERTY_TABSTOP );
  88     ImplRegisterProperty( BASEPROPERTY_GRID_SHOWROWHEADER );
  89     ImplRegisterProperty( BASEPROPERTY_ROW_HEADER_WIDTH );
  90     ImplRegisterProperty( BASEPROPERTY_GRID_SHOWCOLUMNHEADER );
  91     ImplRegisterProperty( BASEPROPERTY_COLUMN_HEADER_HEIGHT );
  92     ImplRegisterProperty( BASEPROPERTY_ROW_HEIGHT );
  93     ImplRegisterProperty( BASEPROPERTY_GRID_DATAMODEL, Any( lcl_getDefaultDataModel_throw( m_xContext ) ) );
  94     ImplRegisterProperty( BASEPROPERTY_GRID_COLUMNMODEL, Any( lcl_getDefaultColumnModel_throw( m_xContext ) ) );
  95     ImplRegisterProperty( BASEPROPERTY_GRID_SELECTIONMODE );
  96     ImplRegisterProperty( BASEPROPERTY_FONTRELIEF );
  97     ImplRegisterProperty( BASEPROPERTY_FONTEMPHASISMARK );
  98     ImplRegisterProperty( BASEPROPERTY_FONTDESCRIPTOR );
  99     ImplRegisterProperty( BASEPROPERTY_TEXTCOLOR );
 100     ImplRegisterProperty( BASEPROPERTY_TEXTLINECOLOR );
 101     ImplRegisterProperty( BASEPROPERTY_USE_GRID_LINES );
 102     ImplRegisterProperty( BASEPROPERTY_GRID_LINE_COLOR );
 103     ImplRegisterProperty( BASEPROPERTY_GRID_HEADER_BACKGROUND );
 104     ImplRegisterProperty( BASEPROPERTY_GRID_HEADER_TEXT_COLOR );
 105     ImplRegisterProperty( BASEPROPERTY_GRID_ROW_BACKGROUND_COLORS );
 106     ImplRegisterProperty( BASEPROPERTY_ACTIVE_SEL_BACKGROUND_COLOR );
 107     ImplRegisterProperty( BASEPROPERTY_INACTIVE_SEL_BACKGROUND_COLOR );
 108     ImplRegisterProperty( BASEPROPERTY_ACTIVE_SEL_TEXT_COLOR );
 109     ImplRegisterProperty( BASEPROPERTY_INACTIVE_SEL_TEXT_COLOR );
 110     ImplRegisterProperty( BASEPROPERTY_VERTICALALIGN );
 111 }
 112
 113
 114 UnoGridModel::UnoGridModel( const UnoGridModel& rModel )
 115     :UnoControlModel( rModel )
 116 {
 117     osl_atomic_increment( &m_refCount );
 118     {
 119         Reference< XGridDataModel > xDataModel;
 120         // clone the data model
 121         const Reference< XFastPropertySet > xCloneSource( &const_cast< UnoGridModel& >( rModel ) );
 122         try
 123         {
 124             const Reference< XCloneable > xCloneable( xCloneSource->getFastPropertyValue( BASEPROPERTY_GRID_DATAMODEL ), UNO_QUERY_THROW );
 125             xDataModel.set( xCloneable->createClone(), UNO_QUERY_THROW );
 126         }
 127         catch( const Exception& )
 128         {
 129             DBG_UNHANDLED_EXCEPTION("toolkit.controls");
 130         }
 131         if ( !xDataModel.is() )
 132             xDataModel = lcl_getDefaultDataModel_throw( m_xContext );
 133         std::unique_lock aGuard(m_aMutex);
 134         UnoControlModel::setFastPropertyValue_NoBroadcast( aGuard, BASEPROPERTY_GRID_DATAMODEL, Any( xDataModel ) );
 135             // do *not* use setFastPropertyValue here: The UnoControlModel ctor made a simple copy of all property values,
 136             // so before this call here, we share our data model with the own of the clone source. setFastPropertyValue,
 137             // then, disposes the old data model - which means the data model which in fact belongs to the clone source.
 138             // so, call the UnoControlModel's impl-method for setting the value.
 139
 140         // clone the column model
 141         Reference< XGridColumnModel > xColumnModel;
 142         try
 143         {
 144             const Reference< XCloneable > xCloneable( xCloneSource->getFastPropertyValue( BASEPROPERTY_GRID_COLUMNMODEL ), UNO_QUERY_THROW );
 145             xColumnModel.set( xCloneable->createClone(), UNO_QUERY_THROW );
 146         }
 147         catch( const Exception& )
 148         {
 149             DBG_UNHANDLED_EXCEPTION("toolkit.controls");
 150         }
 151         if ( !xColumnModel.is() )
 152             xColumnModel = lcl_getDefaultColumnModel_throw( m_xContext );
 153         UnoControlModel::setFastPropertyValue_NoBroadcast( aGuard, BASEPROPERTY_GRID_COLUMNMODEL, Any( xColumnModel ) );
 154             // same comment as above: do not use our own setPropertyValue here.
 155     }
 156     osl_atomic_decrement( &m_refCount );
 157 }
 158
 159
 160 rtl::Reference<UnoControlModel> UnoGridModel::Clone() const
 161 {
 162     return new UnoGridModel( *this );
 163 }
 164
 165
 166 namespace
 167 {
 168     void lcl_dispose_nothrow( const Any& i_component )
 169     {
 170         try
 171         {
 172             const Reference< XComponent > xComponent( i_component, UNO_QUERY );
 173             if (xComponent)
 174                 xComponent->dispose();
 175         }
 176         catch( const Exception& )
 177         {
 178             DBG_UNHANDLED_EXCEPTION("toolkit.controls");
 179         }
 180     }
 181 }
 182
 183
 184 void SAL_CALL UnoGridModel::dispose(  )
 185 {
 186     lcl_dispose_nothrow( getFastPropertyValue( BASEPROPERTY_GRID_COLUMNMODEL ) );
 187     lcl_dispose_nothrow( getFastPropertyValue( BASEPROPERTY_GRID_DATAMODEL ) );
 188
 189     UnoControlModel::dispose();
 190 }
 191
 192
 193 void UnoGridModel::setFastPropertyValue_NoBroadcast( std::unique_lock<std::mutex>& rGuard, sal_Int32 nHandle, const Any& rValue )
 194 {
 195     Any aOldSubModel;
 196     if ( ( nHandle == BASEPROPERTY_GRID_COLUMNMODEL ) || ( nHandle == BASEPROPERTY_GRID_DATAMODEL ) )
 197     {
 198         getFastPropertyValue( rGuard, aOldSubModel, nHandle );
 199         if ( aOldSubModel == rValue )
 200         {
 201             OSL_ENSURE( false, "UnoGridModel::setFastPropertyValue_NoBroadcast: setting the same value, again!" );
 202                 // shouldn't this have been caught by convertFastPropertyValue?
 203             aOldSubModel.clear();
 204         }
 205     }
 206
 207     UnoControlModel::setFastPropertyValue_NoBroadcast( rGuard, nHandle, rValue );
 208
 209     if ( aOldSubModel.hasValue() )
 210         lcl_dispose_nothrow( aOldSubModel );
 211 }
 212
 213
 214 OUString UnoGridModel::getServiceName()
 215 {
 216     return "com.sun.star.awt.grid.UnoControlGridModel";
 217 }
 218
 219
 220 Any UnoGridModel::ImplGetDefaultValue( sal_uInt16 nPropId ) const
 221 {
 222     switch( nPropId )
 223     {
 224         case BASEPROPERTY_DEFAULTCONTROL:
 225             return uno::Any( OUString("com.sun.star.awt.grid.UnoControlGrid") );
 226         case BASEPROPERTY_GRID_SELECTIONMODE:
 227             return uno::Any( SelectionType(1) );
 228         case BASEPROPERTY_GRID_SHOWROWHEADER:
 229         case BASEPROPERTY_USE_GRID_LINES:
 230             return uno::Any( false );
 231         case BASEPROPERTY_ROW_HEADER_WIDTH:
 232             return uno::Any( sal_Int32( 10 ) );
 233         case BASEPROPERTY_GRID_SHOWCOLUMNHEADER:
 234             return uno::Any( true );
 235         case BASEPROPERTY_COLUMN_HEADER_HEIGHT:
 236         case BASEPROPERTY_ROW_HEIGHT:
 237         case BASEPROPERTY_GRID_HEADER_BACKGROUND:
 238         case BASEPROPERTY_GRID_HEADER_TEXT_COLOR:
 239         case BASEPROPERTY_GRID_LINE_COLOR:
 240         case BASEPROPERTY_GRID_ROW_BACKGROUND_COLORS:
 241         case BASEPROPERTY_ACTIVE_SEL_BACKGROUND_COLOR:
 242         case BASEPROPERTY_INACTIVE_SEL_BACKGROUND_COLOR:
 243         case BASEPROPERTY_ACTIVE_SEL_TEXT_COLOR:
 244         case BASEPROPERTY_INACTIVE_SEL_TEXT_COLOR:
 245             return Any();
 246         default:
 247             return UnoControlModel::ImplGetDefaultValue( nPropId );
 248     }
 249
 250 }
 251
 252
 253 ::cppu::IPropertyArrayHelper& UnoGridModel::getInfoHelper()
 254 {
 255     static UnoPropertyArrayHelper aHelper( ImplGetPropertyIds() );
 256     return aHelper;
 257 }
 258
 259
 260 // XMultiPropertySet
 261 Reference< XPropertySetInfo > UnoGridModel::getPropertySetInfo(  )
 262 {
 263     static Reference< XPropertySetInfo > xInfo( createPropertySetInfo( getInfoHelper() ) );
 264     return xInfo;
 265 }
 266
 267
 268 //= UnoGridControl
 269
 270 UnoGridControl::UnoGridControl()
 271     :m_aSelectionListeners( *this )
 272     ,m_pEventForwarder( new toolkit::GridEventForwarder( *this ) )
 273 {
 274 }
 275
 276
 277 UnoGridControl::~UnoGridControl()
 278 {
 279 }
 280
 281
 282 OUString UnoGridControl::GetComponentServiceName() const
 283 {
 284     return "Grid";
 285 }
 286
 287
 288 void SAL_CALL UnoGridControl::dispose(  )
 289 {
 290     lang::EventObject aEvt;
 291     aEvt.Source = getXWeak();
 292     m_aSelectionListeners.disposeAndClear( aEvt );
 293     UnoControl::dispose();
 294 }
 295
 296
 297 void SAL_CALL UnoGridControl::createPeer( const uno::Reference< awt::XToolkit > & rxToolkit, const uno::Reference< awt::XWindowPeer >  & rParentPeer )
 298 {
 299     UnoControlBase::createPeer( rxToolkit, rParentPeer );
 300
 301     const Reference< XGridRowSelection > xGrid( getPeer(), UNO_QUERY_THROW );
 302     xGrid->addSelectionListener( &m_aSelectionListeners );
 303 }
 304
 305
 306 namespace
 307 {
 308     void lcl_setEventForwarding( const Reference< XControlModel >& i_gridControlModel, const std::unique_ptr< toolkit::GridEventForwarder >& i_listener,
 309         bool const i_add )
 310     {
 311         const Reference< XPropertySet > xModelProps( i_gridControlModel, UNO_QUERY );
 312         if ( !xModelProps.is() )
 313             return;
 314
 315         try
 316         {
 317             Reference< XContainer > const xColModel(
 318                 xModelProps->getPropertyValue("ColumnModel"),
 319                 UNO_QUERY_THROW );
 320             if ( i_add )
 321                 xColModel->addContainerListener( i_listener.get() );
 322             else
 323                 xColModel->removeContainerListener( i_listener.get() );
 324
 325             Reference< XGridDataModel > const xDataModel(
 326                 xModelProps->getPropertyValue("GridDataModel"),
 327                 UNO_QUERY_THROW
 328             );
 329             Reference< XMutableGridDataModel > const xMutableDataModel( xDataModel, UNO_QUERY );
 330             if ( xMutableDataModel.is() )
 331             {
 332                 if ( i_add )
 333                     xMutableDataModel->addGridDataListener( i_listener.get() );
 334                 else
 335                     xMutableDataModel->removeGridDataListener( i_listener.get() );
 336             }
 337         }
 338         catch( const Exception& )
 339         {
 340             DBG_UNHANDLED_EXCEPTION("toolkit.controls");
 341         }
 342     }
 343 }
 344
 345
 346 sal_Bool SAL_CALL UnoGridControl::setModel( const Reference< XControlModel >& i_model )
 347 {
 348     lcl_setEventForwarding( getModel(), m_pEventForwarder, false );
 349     if ( !UnoGridControl_Base::setModel( i_model ) )
 350         return false;
 351     lcl_setEventForwarding( getModel(), m_pEventForwarder, true );
 352     return true;
 353 }
 354
 355
 356 ::sal_Int32 UnoGridControl::getRowAtPoint(::sal_Int32 x, ::sal_Int32 y)
 357 {
 358     Reference< XGridControl > const xGrid ( getPeer(), UNO_QUERY_THROW );
 359     return xGrid->getRowAtPoint( x, y );
 360 }
 361
 362
 363 ::sal_Int32 UnoGridControl::getColumnAtPoint(::sal_Int32 x, ::sal_Int32 y)
 364 {
 365     Reference< XGridControl > const xGrid ( getPeer(), UNO_QUERY_THROW );
 366     return xGrid->getColumnAtPoint( x, y );
 367 }
 368
 369
 370 ::sal_Int32 SAL_CALL UnoGridControl::getCurrentColumn(  )
 371 {
 372     Reference< XGridControl > const xGrid ( getPeer(), UNO_QUERY_THROW );
 373     return xGrid->getCurrentColumn();
 374 }
 375
 376
 377 ::sal_Int32 SAL_CALL UnoGridControl::getCurrentRow(  )
 378 {
 379     Reference< XGridControl > const xGrid ( getPeer(), UNO_QUERY_THROW );
 380     return xGrid->getCurrentRow();
 381 }
 382
 383
 384 void SAL_CALL UnoGridControl::goToCell( ::sal_Int32 i_columnIndex, ::sal_Int32 i_rowIndex )
 385 {
 386     Reference< XGridControl > const xGrid ( getPeer(), UNO_QUERY_THROW );
 387     xGrid->goToCell( i_columnIndex, i_rowIndex );
 388 }
 389
 390
 391 void SAL_CALL UnoGridControl::selectRow( ::sal_Int32 i_rowIndex )
 392 {
 393     Reference< XGridRowSelection >( getPeer(), UNO_QUERY_THROW )->selectRow( i_rowIndex );
 394 }
 395
 396
 397 void SAL_CALL UnoGridControl::selectAllRows()
 398 {
 399     Reference< XGridRowSelection >( getPeer(), UNO_QUERY_THROW )->selectAllRows();
 400 }
 401
 402
 403 void SAL_CALL UnoGridControl::deselectRow( ::sal_Int32 i_rowIndex )
 404 {
 405     Reference< XGridRowSelection >( getPeer(), UNO_QUERY_THROW )->deselectRow( i_rowIndex );
 406 }
 407
 408
 409 void SAL_CALL UnoGridControl::deselectAllRows()
 410 {
 411     Reference< XGridRowSelection >( getPeer(), UNO_QUERY_THROW )->deselectAllRows();
 412 }
 413
 414
 415 css::uno::Sequence< ::sal_Int32 > SAL_CALL UnoGridControl::getSelectedRows()
 416 {
 417     return Reference< XGridRowSelection >( getPeer(), UNO_QUERY_THROW )->getSelectedRows();
 418 }
 419
 420
 421 sal_Bool SAL_CALL UnoGridControl::hasSelectedRows()
 422 {
 423     return Reference< XGridRowSelection >( getPeer(), UNO_QUERY_THROW )->hasSelectedRows();
 424 }
 425
 426
 427 sal_Bool SAL_CALL UnoGridControl::isRowSelected(::sal_Int32 index)
 428 {
 429     return Reference< XGridRowSelection >( getPeer(), UNO_QUERY_THROW )->isRowSelected( index );
 430 }
 431
 432
 433 void SAL_CALL UnoGridControl::addSelectionListener(const css::uno::Reference< css::awt::grid::XGridSelectionListener > & listener)
 434 {
 435     m_aSelectionListeners.addInterface( listener );
 436 }
 437
 438
 439 void SAL_CALL UnoGridControl::removeSelectionListener(const css::uno::Reference< css::awt::grid::XGridSelectionListener > & listener)
 440 {
 441     m_aSelectionListeners.removeInterface( listener );
 442 }
 443
 444 }
 445
 446 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 447 stardiv_Toolkit_GridControl_get_implementation(
 448     css::uno::XComponentContext *,
 449     css::uno::Sequence<css::uno::Any> const &)
 450 {
 451     return cppu::acquire(new toolkit::UnoGridControl());
 452 }
 453
 454 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 455 stardiv_Toolkit_GridControlModel_get_implementation(
 456     css::uno::XComponentContext *context,
 457     css::uno::Sequence<css::uno::Any> const &)
 458 {
 459     return cppu::acquire(new toolkit::UnoGridModel(context));
 460 }
 461
 462 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */