forms/source/solar/component/navbarcontrol.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 "navbarcontrol.hxx"
  22 #include "frm_strings.hxx"
  23 #include "frm_module.hxx"
  24 #include "FormComponent.hxx"
  25 #include "componenttools.hxx"
  26 #include "navtoolbar.hxx"
  27 #include "commandimageprovider.hxx"
  28 #include "commanddescriptionprovider.hxx"
  29
  30 #include <com/sun/star/awt/XView.hpp>
  31 #include <com/sun/star/awt/PosSize.hpp>
  32 #include <com/sun/star/form/runtime/FormFeature.hpp>
  33 #include <com/sun/star/awt/XControlModel.hpp>
  34 #include <com/sun/star/graphic/XGraphic.hpp>
  35
  36 #include <comphelper/processfactory.hxx>
  37 #include <tools/debug.hxx>
  38 #include <tools/diagnose_ex.h>
  39 #include <vcl/svapp.hxx>
  40
  41 //--------------------------------------------------------------------------
  42 extern "C" void SAL_CALL createRegistryInfo_ONavigationBarControl()
  43 {
  44     static ::frm::OMultiInstanceAutoRegistration< ::frm::ONavigationBarControl > aAutoRegistration;
  45 }
  46
  47 //.........................................................................
  48 namespace frm
  49 {
  50 //.........................................................................
  51
  52     using namespace ::com::sun::star::uno;
  53     using namespace ::com::sun::star::beans;
  54     using namespace ::com::sun::star::awt;
  55     using namespace ::com::sun::star::lang;
  56     using namespace ::com::sun::star::frame;
  57     using namespace ::com::sun::star::graphic;
  58     namespace FormFeature = ::com::sun::star::form::runtime::FormFeature;
  59
  60 #define FORWARD_TO_PEER_1( unoInterface, method, param1 )   \
  61     Reference< unoInterface > xTypedPeer( getPeer(), UNO_QUERY );   \
  62     if ( xTypedPeer.is() )  \
  63     {   \
  64         xTypedPeer->method( param1 );  \
  65     }
  66
  67     //==================================================================
  68     // ONavigationBarControl
  69     //==================================================================
  70     DBG_NAME( ONavigationBarControl )
  71     //------------------------------------------------------------------
  72     ONavigationBarControl::ONavigationBarControl( const Reference< XComponentContext >& _rxORB)
  73         :UnoControl(), m_xContext(_rxORB)
  74     {
  75         DBG_CTOR( ONavigationBarControl, NULL );
  76     }
  77
  78     //------------------------------------------------------------------
  79     ONavigationBarControl::~ONavigationBarControl()
  80     {
  81         DBG_DTOR( ONavigationBarControl, NULL );
  82     }
  83
  84     //------------------------------------------------------------------
  85     IMPLEMENT_FORWARD_XTYPEPROVIDER2( ONavigationBarControl, UnoControl, ONavigationBarControl_Base )
  86
  87     //------------------------------------------------------------------
  88     Any SAL_CALL ONavigationBarControl::queryAggregation( const Type& _rType ) throw ( RuntimeException )
  89     {
  90         Any aReturn = UnoControl::queryAggregation( _rType );
  91
  92         if ( !aReturn.hasValue() )
  93             aReturn = ONavigationBarControl_Base::queryInterface( _rType );
  94
  95         return aReturn;
  96     }
  97
  98     //------------------------------------------------------------------
  99     namespace
 100     {
 101         //..............................................................
 102         static WinBits lcl_getWinBits_nothrow( const Reference< XControlModel >& _rxModel )
 103         {
 104             WinBits nBits = 0;
 105             try
 106             {
 107                 Reference< XPropertySet > xProps( _rxModel, UNO_QUERY );
 108                 if ( xProps.is() )
 109                 {
 110                     sal_Int16 nBorder = 0;
 111                     xProps->getPropertyValue( PROPERTY_BORDER ) >>= nBorder;
 112                     if ( nBorder )
 113                         nBits |= WB_BORDER;
 114
 115                     sal_Bool bTabStop = sal_False;
 116                     if ( xProps->getPropertyValue( PROPERTY_TABSTOP ) >>= bTabStop )
 117                         nBits |= ( bTabStop ? WB_TABSTOP : WB_NOTABSTOP );
 118                 }
 119             }
 120             catch( const Exception& )
 121             {
 122                 DBG_UNHANDLED_EXCEPTION();
 123             }
 124             return nBits;
 125         }
 126     }
 127
 128     //------------------------------------------------------------------
 129     void SAL_CALL ONavigationBarControl::createPeer( const Reference< XToolkit >& /*_rToolkit*/, const Reference< XWindowPeer >& _rParentPeer ) throw( RuntimeException )
 130     {
 131         SolarMutexGuard aGuard;
 132
 133         if (!getPeer().is())
 134         {
 135             mbCreatingPeer = sal_True;
 136
 137             // determine the VLC window for the parent
 138             Window* pParentWin = NULL;
 139             if ( _rParentPeer.is() )
 140             {
 141                 VCLXWindow* pParentXWin = VCLXWindow::GetImplementation( _rParentPeer );
 142                 if ( pParentXWin )
 143                     pParentWin = pParentXWin->GetWindow();
 144                 DBG_ASSERT( pParentWin, "ONavigationBarControl::createPeer: could not obtain the VCL-level parent window!" );
 145             }
 146
 147             // create the peer
 148             ONavigationBarPeer* pPeer = ONavigationBarPeer::Create( Reference<XMultiServiceFactory>(m_xContext->getServiceManager(), UNO_QUERY_THROW), pParentWin, getModel() );
 149             DBG_ASSERT( pPeer, "ONavigationBarControl::createPeer: invalid peer returned!" );
 150             if ( pPeer )
 151                 // by definition, the returned component is aquired once
 152                 pPeer->release();
 153
 154             // announce the peer to the base class
 155             setPeer( pPeer );
 156
 157             // initialize ourself (and thus the peer) with the model properties
 158             updateFromModel();
 159
 160             Reference< XView >  xPeerView( getPeer(), UNO_QUERY );
 161             if ( xPeerView.is() )
 162             {
 163                 xPeerView->setZoom( maComponentInfos.nZoomX, maComponentInfos.nZoomY );
 164                 xPeerView->setGraphics( mxGraphics );
 165             }
 166
 167             // a lot of initial settings from our component infos
 168             setPosSize( maComponentInfos.nX, maComponentInfos.nY, maComponentInfos.nWidth, maComponentInfos.nHeight, PosSize::POSSIZE );
 169
 170             pPeer->setVisible   ( maComponentInfos.bVisible && !mbDesignMode );
 171             pPeer->setEnable    ( maComponentInfos.bEnable                   );
 172             pPeer->setDesignMode( mbDesignMode                               );
 173
 174             peerCreated();
 175
 176             mbCreatingPeer = sal_False;
 177
 178             OControl::initFormControlPeer( getPeer() );
 179         }
 180     }
 181
 182     //------------------------------------------------------------------
 183     OUString SAL_CALL ONavigationBarControl::getImplementationName()  throw( RuntimeException )
 184     {
 185         return getImplementationName_Static();
 186     }
 187
 188     //------------------------------------------------------------------
 189     Sequence< OUString > SAL_CALL ONavigationBarControl::getSupportedServiceNames()  throw( RuntimeException )
 190     {
 191         return getSupportedServiceNames_Static();
 192     }
 193
 194     //------------------------------------------------------------------
 195     OUString SAL_CALL ONavigationBarControl::getImplementationName_Static()
 196     {
 197         return OUString( "com.sun.star.comp.form.ONavigationBarControl" );
 198     }
 199
 200     //------------------------------------------------------------------
 201     Sequence< OUString > SAL_CALL ONavigationBarControl::getSupportedServiceNames_Static()
 202     {
 203         Sequence< OUString > aServices( 2 );
 204         aServices[ 0 ] = OUString( "com.sun.star.awt.UnoControl" );
 205         aServices[ 1 ] = OUString( "com.sun.star.form.control.NavigationToolBar" );
 206         return aServices;
 207     }
 208
 209     //------------------------------------------------------------------
 210     Reference< XInterface > SAL_CALL ONavigationBarControl::Create( const Reference< XMultiServiceFactory >& _rxFactory )
 211     {
 212         return *( new ONavigationBarControl( comphelper::getComponentContext(_rxFactory) ) );
 213     }
 214
 215     //------------------------------------------------------------------
 216     void SAL_CALL ONavigationBarControl::registerDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor ) throw (RuntimeException)
 217     {
 218         FORWARD_TO_PEER_1( XDispatchProviderInterception, registerDispatchProviderInterceptor, _rxInterceptor );
 219     }
 220
 221     //------------------------------------------------------------------
 222     void SAL_CALL ONavigationBarControl::releaseDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor ) throw (RuntimeException)
 223     {
 224         FORWARD_TO_PEER_1( XDispatchProviderInterception, releaseDispatchProviderInterceptor, _rxInterceptor );
 225     }
 226
 227     //------------------------------------------------------------------
 228     void SAL_CALL ONavigationBarControl::setDesignMode( sal_Bool _bOn ) throw( RuntimeException )
 229     {
 230         UnoControl::setDesignMode( _bOn );
 231         FORWARD_TO_PEER_1( XVclWindowPeer, setDesignMode, _bOn );
 232     }
 233
 234     //==================================================================
 235     // ONavigationBarPeer
 236     //==================================================================
 237     DBG_NAME( ONavigationBarPeer )
 238     //------------------------------------------------------------------
 239     ONavigationBarPeer* ONavigationBarPeer::Create( const Reference< XMultiServiceFactory >& _rxORB,
 240         Window* _pParentWindow, const Reference< XControlModel >& _rxModel )
 241     {
 242         DBG_TESTSOLARMUTEX();
 243
 244         // the peer itself
 245         ONavigationBarPeer* pPeer = new ONavigationBarPeer( _rxORB );
 246         pPeer->acquire();   // by definition, the returned object is aquired once
 247
 248         // the VCL control for the peer
 249         Reference< XModel > xContextDocument( getXModel( _rxModel ) );
 250         NavigationToolBar* pNavBar = new NavigationToolBar(
 251             _pParentWindow,
 252             lcl_getWinBits_nothrow( _rxModel ),
 253             createDocumentCommandImageProvider( _rxORB, xContextDocument ),
 254             createDocumentCommandDescriptionProvider( comphelper::getComponentContext(_rxORB), xContextDocument )
 255         );
 256
 257         // some knittings
 258         pNavBar->setDispatcher( pPeer );
 259         pNavBar->SetComponentInterface( pPeer );
 260
 261         // we want a faster repeating rate for the slots in this
 262         // toolbox
 263         AllSettings aSettings = pNavBar->GetSettings();
 264         MouseSettings aMouseSettings = aSettings.GetMouseSettings();
 265         aMouseSettings.SetButtonRepeat( 10 );
 266         aSettings.SetMouseSettings( aMouseSettings );
 267         pNavBar->SetSettings( aSettings, sal_True );
 268
 269         // outta here
 270         return pPeer;
 271     }
 272
 273     //------------------------------------------------------------------
 274     ONavigationBarPeer::ONavigationBarPeer( const Reference< XMultiServiceFactory >& _rxORB )
 275         :OFormNavigationHelper( _rxORB )
 276     {
 277         DBG_CTOR( ONavigationBarPeer, NULL );
 278     }
 279
 280     //------------------------------------------------------------------
 281     ONavigationBarPeer::~ONavigationBarPeer()
 282     {
 283         DBG_DTOR( ONavigationBarPeer, NULL );
 284     }
 285
 286     //------------------------------------------------------------------
 287     IMPLEMENT_FORWARD_XINTERFACE2( ONavigationBarPeer, VCLXWindow, OFormNavigationHelper )
 288
 289     //------------------------------------------------------------------
 290     IMPLEMENT_FORWARD_XTYPEPROVIDER2( ONavigationBarPeer, VCLXWindow, OFormNavigationHelper )
 291
 292     //------------------------------------------------------------------
 293     void SAL_CALL ONavigationBarPeer::dispose(  ) throw( RuntimeException )
 294     {
 295         VCLXWindow::dispose();
 296         OFormNavigationHelper::dispose();
 297     }
 298
 299     //------------------------------------------------------------------
 300     void SAL_CALL ONavigationBarPeer::setProperty( const OUString& _rPropertyName, const Any& _rValue ) throw( RuntimeException )
 301     {
 302         SolarMutexGuard aGuard;
 303
 304         NavigationToolBar* pNavBar = static_cast< NavigationToolBar* >( GetWindow() );
 305         if ( !pNavBar )
 306         {
 307             VCLXWindow::setProperty( _rPropertyName, _rValue );
 308             return;
 309         }
 310
 311         bool bVoid = !_rValue.hasValue();
 312
 313         sal_Bool  bBoolValue = sal_False;
 314         sal_Int32 nColor = COL_TRANSPARENT;
 315
 316         // TODO: more generic mechanisms for this (the grid control implementation,
 317         // when used herein, will do the same stuff for lot of these)
 318
 319         if ( _rPropertyName.equals( PROPERTY_BACKGROUNDCOLOR ) )
 320         {
 321             Wallpaper aTest = pNavBar->GetBackground();
 322             if ( bVoid )
 323             {
 324                 pNavBar->SetBackground( pNavBar->GetSettings().GetStyleSettings().GetFaceColor() );
 325                 pNavBar->SetControlBackground();
 326             }
 327             else
 328             {
 329                 OSL_VERIFY( _rValue >>= nColor );
 330                 Color aColor( nColor );
 331                 pNavBar->SetBackground( aColor );
 332                 pNavBar->SetControlBackground( aColor );
 333             }
 334         }
 335         else if ( _rPropertyName.equals( PROPERTY_TEXTLINECOLOR ) )
 336         {
 337             if ( bVoid )
 338             {
 339                 pNavBar->SetTextLineColor();
 340             }
 341             else
 342             {
 343                 OSL_VERIFY( _rValue >>= nColor );
 344                 pNavBar->SetTextLineColor( nColor );
 345             }
 346         }
 347         else if ( _rPropertyName.equals( PROPERTY_ICONSIZE ) )
 348         {
 349             sal_Int16 nInt16Value = 0;
 350             OSL_VERIFY( _rValue >>= nInt16Value );
 351             pNavBar->SetImageSize( nInt16Value ? NavigationToolBar::eLarge : NavigationToolBar::eSmall );
 352         }
 353         else if ( _rPropertyName.equals( PROPERTY_SHOW_POSITION ) )
 354         {
 355             OSL_VERIFY( _rValue >>= bBoolValue );
 356             pNavBar->ShowFunctionGroup( NavigationToolBar::ePosition, bBoolValue );
 357         }
 358         else if ( _rPropertyName.equals( PROPERTY_SHOW_NAVIGATION ) )
 359         {
 360             OSL_VERIFY( _rValue >>= bBoolValue );
 361             pNavBar->ShowFunctionGroup( NavigationToolBar::eNavigation, bBoolValue );
 362         }
 363         else if ( _rPropertyName.equals( PROPERTY_SHOW_RECORDACTIONS ) )
 364         {
 365             OSL_VERIFY( _rValue >>= bBoolValue );
 366             pNavBar->ShowFunctionGroup( NavigationToolBar::eRecordActions, bBoolValue );
 367         }
 368         else if ( _rPropertyName.equals( PROPERTY_SHOW_FILTERSORT ) )
 369         {
 370             OSL_VERIFY( _rValue >>= bBoolValue );
 371             pNavBar->ShowFunctionGroup( NavigationToolBar::eFilterSort, bBoolValue );
 372         }
 373         else
 374         {
 375             VCLXWindow::setProperty( _rPropertyName, _rValue );
 376         }
 377     }
 378
 379     //------------------------------------------------------------------
 380     Any SAL_CALL ONavigationBarPeer::getProperty( const OUString& _rPropertyName ) throw( RuntimeException )
 381     {
 382         SolarMutexGuard aGuard;
 383
 384         Any aReturn;
 385         NavigationToolBar* pNavBar = static_cast< NavigationToolBar* >( GetWindow() );
 386
 387         if ( _rPropertyName.equals( PROPERTY_BACKGROUNDCOLOR ) )
 388         {
 389             aReturn <<= (sal_Int32)pNavBar->GetControlBackground().GetColor();
 390         }
 391         else if ( _rPropertyName.equals( PROPERTY_TEXTLINECOLOR ) )
 392         {
 393             aReturn <<= (sal_Int32)pNavBar->GetTextLineColor().GetColor();
 394         }
 395         else if ( _rPropertyName.equals( PROPERTY_ICONSIZE ) )
 396         {
 397             sal_Int16 nIconType = ( NavigationToolBar::eLarge == pNavBar->GetImageSize() )
 398                                 ? 1 : 0;
 399             aReturn <<= nIconType;
 400         }
 401         else if ( _rPropertyName.equals( PROPERTY_SHOW_POSITION ) )
 402         {
 403             aReturn <<= (sal_Bool)( pNavBar->IsFunctionGroupVisible( NavigationToolBar::ePosition ) );
 404         }
 405         else if ( _rPropertyName.equals( PROPERTY_SHOW_NAVIGATION ) )
 406         {
 407             aReturn <<= (sal_Bool)( pNavBar->IsFunctionGroupVisible( NavigationToolBar::eNavigation ) );
 408         }
 409         else if ( _rPropertyName.equals( PROPERTY_SHOW_RECORDACTIONS ) )
 410         {
 411             aReturn <<= (sal_Bool)( pNavBar->IsFunctionGroupVisible( NavigationToolBar::eRecordActions ) );
 412         }
 413         else if ( _rPropertyName.equals( PROPERTY_SHOW_FILTERSORT ) )
 414         {
 415             aReturn <<= (sal_Bool)( pNavBar->IsFunctionGroupVisible( NavigationToolBar::eFilterSort ) );
 416         }
 417         else
 418             aReturn = VCLXWindow::getProperty( _rPropertyName );
 419
 420         return aReturn;
 421     }
 422
 423     //------------------------------------------------------------------
 424     void ONavigationBarPeer::interceptorsChanged( )
 425     {
 426         if ( isDesignMode() )
 427             // not interested in if we're in design mode
 428             return;
 429
 430         OFormNavigationHelper::interceptorsChanged();
 431     }
 432
 433     //------------------------------------------------------------------
 434     void ONavigationBarPeer::featureStateChanged( sal_Int16 _nFeatureId, sal_Bool _bEnabled )
 435     {
 436         // enable this button on the toolbox
 437         NavigationToolBar* pNavBar = static_cast< NavigationToolBar* >( GetWindow() );
 438         if ( pNavBar )
 439         {
 440             pNavBar->enableFeature( _nFeatureId, _bEnabled );
 441
 442             // is it a feature with additional state information?
 443             if ( _nFeatureId == FormFeature::ToggleApplyFilter )
 444             {   // additional boolean state
 445                 pNavBar->checkFeature( _nFeatureId, getBooleanState( _nFeatureId ) );
 446             }
 447             else if ( _nFeatureId == FormFeature::TotalRecords )
 448             {
 449                 pNavBar->setFeatureText( _nFeatureId, getStringState( _nFeatureId ) );
 450             }
 451             else if ( _nFeatureId == FormFeature::MoveAbsolute )
 452             {
 453                 pNavBar->setFeatureText( _nFeatureId, OUString::valueOf(getIntegerState(_nFeatureId)) );
 454             }
 455         }
 456
 457         // base class
 458         OFormNavigationHelper::featureStateChanged( _nFeatureId, _bEnabled );
 459     }
 460
 461     //------------------------------------------------------------------
 462     void ONavigationBarPeer::allFeatureStatesChanged( )
 463     {
 464         // force the control to update it's states
 465         NavigationToolBar* pNavBar = static_cast< NavigationToolBar* >( GetWindow() );
 466         if ( pNavBar )
 467             pNavBar->setDispatcher( this );
 468
 469         // base class
 470         OFormNavigationHelper::allFeatureStatesChanged( );
 471     }
 472
 473     //------------------------------------------------------------------
 474     bool ONavigationBarPeer::isEnabled( sal_Int16 _nFeatureId ) const
 475     {
 476         if ( const_cast< ONavigationBarPeer* >( this )->isDesignMode() )
 477            return false;
 478
 479         return OFormNavigationHelper::isEnabled( _nFeatureId );
 480     }
 481
 482     //------------------------------------------------------------------
 483     void SAL_CALL ONavigationBarPeer::setDesignMode( sal_Bool _bOn ) throw( RuntimeException )
 484     {
 485         VCLXWindow::setDesignMode( _bOn  );
 486
 487         if ( _bOn )
 488             disconnectDispatchers();
 489         else
 490             connectDispatchers();
 491             // this will connect if not already connected and just update else
 492     }
 493
 494     //------------------------------------------------------------------
 495     void SAL_CALL ONavigationBarPeer::disposing( const EventObject& _rSource ) throw (RuntimeException)
 496     {
 497         VCLXWindow::disposing( _rSource );
 498         OFormNavigationHelper::disposing( _rSource );
 499     }
 500
 501     //------------------------------------------------------------------
 502     void ONavigationBarPeer::getSupportedFeatures( ::std::vector< sal_Int16 >& _rFeatureIds )
 503     {
 504         _rFeatureIds.push_back( FormFeature::MoveAbsolute );
 505         _rFeatureIds.push_back( FormFeature::TotalRecords );
 506         _rFeatureIds.push_back( FormFeature::MoveToFirst );
 507         _rFeatureIds.push_back( FormFeature::MoveToPrevious );
 508         _rFeatureIds.push_back( FormFeature::MoveToNext );
 509         _rFeatureIds.push_back( FormFeature::MoveToLast );
 510         _rFeatureIds.push_back( FormFeature::SaveRecordChanges );
 511         _rFeatureIds.push_back( FormFeature::UndoRecordChanges );
 512         _rFeatureIds.push_back( FormFeature::MoveToInsertRow );
 513         _rFeatureIds.push_back( FormFeature::DeleteRecord );
 514         _rFeatureIds.push_back( FormFeature::ReloadForm );
 515         _rFeatureIds.push_back( FormFeature::RefreshCurrentControl );
 516         _rFeatureIds.push_back( FormFeature::SortAscending );
 517         _rFeatureIds.push_back( FormFeature::SortDescending );
 518         _rFeatureIds.push_back( FormFeature::InteractiveSort );
 519         _rFeatureIds.push_back( FormFeature::AutoFilter );
 520         _rFeatureIds.push_back( FormFeature::InteractiveFilter );
 521         _rFeatureIds.push_back( FormFeature::ToggleApplyFilter );
 522         _rFeatureIds.push_back( FormFeature::RemoveFilterAndSort );
 523     }
 524
 525 //.........................................................................
 526 }   // namespace frm
 527 //.........................................................................
 528
 529 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */