extensions/source/propctrlr/pushbuttonnavigation.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: pushbuttonnavigation.cxx,v $
  10  * $Revision: 1.7 $
  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 "pushbuttonnavigation.hxx"
  34 #include <com/sun/star/form/FormButtonType.hpp>
  35 #include <com/sun/star/beans/XPropertyState.hpp>
  36 #include "formstrings.hxx"
  37 #include <cppuhelper/extract.hxx>
  38 #include <comphelper/property.hxx>
  39 #include <osl/diagnose.h>
  40 #include <tools/diagnose_ex.h>
  41
  42 //............................................................................
  43 namespace pcr
  44 {
  45 //............................................................................
  46
  47     using namespace ::com::sun::star::uno;
  48     using namespace ::com::sun::star::beans;
  49     using namespace ::com::sun::star::form;
  50
  51     //------------------------------------------------------------------------
  52     namespace
  53     {
  54         static const sal_Int32 s_nFirstVirtualButtonType = 1 + (sal_Int32)FormButtonType_URL;
  55
  56         static const sal_Char* pNavigationURLs[] =
  57         {
  58             ".uno:FormController/moveToFirst",
  59             ".uno:FormController/moveToPrev",
  60             ".uno:FormController/moveToNext",
  61             ".uno:FormController/moveToLast",
  62             ".uno:FormController/saveRecord",
  63             ".uno:FormController/undoRecord",
  64             ".uno:FormController/moveToNew",
  65             ".uno:FormController/deleteRecord",
  66             ".uno:FormController/refreshForm",
  67             NULL
  68         };
  69
  70         static sal_Int32 lcl_getNavigationURLIndex( const ::rtl::OUString& _rNavURL )
  71         {
  72             const sal_Char** pLookup = pNavigationURLs;
  73             while ( *pLookup )
  74             {
  75                 if ( _rNavURL.equalsAscii( *pLookup ) )
  76                     return pLookup - pNavigationURLs;
  77                 ++pLookup;
  78             }
  79             return -1;
  80         }
  81
  82         static const sal_Char* lcl_getNavigationURL( sal_Int32 _nButtonTypeIndex )
  83         {
  84             const sal_Char** pLookup = pNavigationURLs;
  85             while ( _nButtonTypeIndex-- && *pLookup++ )
  86                 ;
  87             OSL_ENSURE( *pLookup, "lcl_getNavigationURL: invalid index!" );
  88             return *pLookup;
  89         }
  90     }
  91
  92     //========================================================================
  93     //= PushButtonNavigation
  94     //========================================================================
  95     //------------------------------------------------------------------------
  96     PushButtonNavigation::PushButtonNavigation( const Reference< XPropertySet >& _rxControlModel )
  97         :m_xControlModel( _rxControlModel )
  98         ,m_bIsPushButton( sal_False )
  99     {
 100         OSL_ENSURE( m_xControlModel.is(), "PushButtonNavigation::PushButtonNavigation: invalid control model!" );
 101
 102         try
 103         {
 104             m_bIsPushButton = ::comphelper::hasProperty( PROPERTY_BUTTONTYPE, m_xControlModel );
 105         }
 106         catch( const Exception& )
 107         {
 108             OSL_ENSURE( sal_False, "PushButtonNavigation::PushButtonNavigation: caught an exception!" );
 109         }
 110     }
 111
 112     //------------------------------------------------------------------------
 113     sal_Int32 PushButtonNavigation::implGetCurrentButtonType() const SAL_THROW((Exception))
 114     {
 115         sal_Int32 nButtonType = FormButtonType_PUSH;
 116         if ( !m_xControlModel.is() )
 117             return nButtonType;
 118         OSL_VERIFY( ::cppu::enum2int( nButtonType, m_xControlModel->getPropertyValue( PROPERTY_BUTTONTYPE ) ) );
 119
 120         if ( nButtonType == FormButtonType_URL )
 121         {
 122             // there's a chance that this is a "virtual" button type
 123             // (which are realized by special URLs)
 124             ::rtl::OUString sTargetURL;
 125             m_xControlModel->getPropertyValue( PROPERTY_TARGET_URL ) >>= sTargetURL;
 126
 127             sal_Int32 nNavigationURLIndex = lcl_getNavigationURLIndex( sTargetURL );
 128             if ( nNavigationURLIndex >= 0)
 129                 // it actually *is* a virtual button type
 130                 nButtonType = s_nFirstVirtualButtonType + nNavigationURLIndex;
 131         }
 132         return nButtonType;
 133     }
 134
 135     //------------------------------------------------------------------------
 136     Any PushButtonNavigation::getCurrentButtonType() const SAL_THROW(())
 137     {
 138         OSL_ENSURE( m_bIsPushButton, "PushButtonNavigation::getCurrentButtonType: not expected to be called for forms!" );
 139         Any aReturn;
 140
 141         try
 142         {
 143             aReturn <<= implGetCurrentButtonType();
 144         }
 145         catch( const Exception& )
 146         {
 147             OSL_ENSURE( sal_False, "PushButtonNavigation::getCurrentButtonType: caught an exception!" );
 148         }
 149         return aReturn;
 150     }
 151
 152     //------------------------------------------------------------------------
 153     void PushButtonNavigation::setCurrentButtonType( const Any& _rValue ) const SAL_THROW(())
 154     {
 155         OSL_ENSURE( m_bIsPushButton, "PushButtonNavigation::setCurrentButtonType: not expected to be called for forms!" );
 156         if ( !m_xControlModel.is() )
 157             return;
 158
 159         try
 160         {
 161             sal_Int32 nButtonType = FormButtonType_PUSH;
 162             OSL_VERIFY( ::cppu::enum2int( nButtonType, _rValue ) );
 163             ::rtl::OUString sTargetURL;
 164
 165             bool bIsVirtualButtonType = nButtonType >= s_nFirstVirtualButtonType;
 166             if ( bIsVirtualButtonType )
 167             {
 168                 const sal_Char* pURL = lcl_getNavigationURL( nButtonType - s_nFirstVirtualButtonType );
 169                 sTargetURL = ::rtl::OUString::createFromAscii( pURL );
 170
 171                 nButtonType = FormButtonType_URL;
 172             }
 173
 174             m_xControlModel->setPropertyValue( PROPERTY_BUTTONTYPE, makeAny( static_cast< FormButtonType >( nButtonType ) ) );
 175             m_xControlModel->setPropertyValue( PROPERTY_TARGET_URL, makeAny( sTargetURL ) );
 176         }
 177         catch( const Exception& )
 178         {
 179             OSL_ENSURE( sal_False, "PushButtonNavigation::setCurrentButtonType: caught an exception!" );
 180         }
 181     }
 182
 183     //------------------------------------------------------------------------
 184     PropertyState PushButtonNavigation::getCurrentButtonTypeState( ) const SAL_THROW(())
 185     {
 186         OSL_ENSURE( m_bIsPushButton, "PushButtonNavigation::getCurrentButtonTypeState: not expected to be called for forms!" );
 187         PropertyState eState = PropertyState_DIRECT_VALUE;
 188
 189         try
 190         {
 191             Reference< XPropertyState > xStateAccess( m_xControlModel, UNO_QUERY );
 192             if ( xStateAccess.is() )
 193             {
 194                 // let's see what the model says about the ButtonType property
 195                 eState = xStateAccess->getPropertyState( PROPERTY_BUTTONTYPE );
 196                 if ( eState == PropertyState_DIRECT_VALUE )
 197                 {
 198                     sal_Int32 nRealButtonType = FormButtonType_PUSH;
 199                     OSL_VERIFY( ::cppu::enum2int( nRealButtonType, m_xControlModel->getPropertyValue( PROPERTY_BUTTONTYPE ) ) );
 200                     // perhaps it's one of the virtual button types?
 201                     if ( FormButtonType_URL == nRealButtonType )
 202                     {
 203                         // yes, it is -> rely on the state of the URL property
 204                         eState = xStateAccess->getPropertyState( PROPERTY_TARGET_URL );
 205                     }
 206                 }
 207             }
 208         }
 209         catch( const Exception& )
 210         {
 211             OSL_ENSURE( sal_False, "PushButtonNavigation::getCurrentButtonTypeState: caught an exception!" );
 212         }
 213
 214         return eState;
 215     }
 216
 217     //------------------------------------------------------------------------
 218     Any PushButtonNavigation::getCurrentTargetURL() const SAL_THROW(())
 219     {
 220         Any aReturn;
 221         if ( !m_xControlModel.is() )
 222             return aReturn;
 223
 224         try
 225         {
 226             aReturn = m_xControlModel->getPropertyValue( PROPERTY_TARGET_URL );
 227             if ( m_bIsPushButton )
 228             {
 229                 sal_Int32 nCurrentButtonType = implGetCurrentButtonType();
 230                 bool bIsVirtualButtonType = nCurrentButtonType >= s_nFirstVirtualButtonType;
 231                 if ( bIsVirtualButtonType )
 232                 {
 233                     // pretend (to the user) that there's no URL set - since
 234                     // virtual button types imply a special (technical) URL which
 235                     // the user should not see
 236                     aReturn <<= ::rtl::OUString();
 237                 }
 238             }
 239         }
 240         catch( const Exception& )
 241         {
 242             OSL_ENSURE( sal_False, "PushButtonNavigation::getCurrentTargetURL: caught an exception!" );
 243         }
 244         return aReturn;
 245     }
 246
 247     //------------------------------------------------------------------------
 248     void PushButtonNavigation::setCurrentTargetURL( const Any& _rValue ) const SAL_THROW(())
 249     {
 250         if ( !m_xControlModel.is() )
 251             return;
 252
 253         try
 254         {
 255             m_xControlModel->setPropertyValue( PROPERTY_TARGET_URL, _rValue );
 256         }
 257         catch( const Exception& )
 258         {
 259             OSL_ENSURE( sal_False, "PushButtonNavigation::setCurrentTargetURL: caught an exception!" );
 260         }
 261     }
 262
 263     //------------------------------------------------------------------------
 264     PropertyState PushButtonNavigation::getCurrentTargetURLState( ) const SAL_THROW(())
 265     {
 266         PropertyState eState = PropertyState_DIRECT_VALUE;
 267
 268         try
 269         {
 270             Reference< XPropertyState > xStateAccess( m_xControlModel, UNO_QUERY );
 271             if ( xStateAccess.is() )
 272             {
 273                 eState = xStateAccess->getPropertyState( PROPERTY_TARGET_URL );
 274             }
 275         }
 276         catch( const Exception& )
 277         {
 278             OSL_ENSURE( sal_False, "PushButtonNavigation::setCurrentTargetURL: caught an exception!" );
 279         }
 280
 281         return eState;
 282     }
 283
 284     //------------------------------------------------------------------------
 285     bool PushButtonNavigation::currentButtonTypeIsOpenURL() const
 286     {
 287         sal_Int32 nButtonType( FormButtonType_PUSH );
 288         try
 289         {
 290             nButtonType = implGetCurrentButtonType();
 291         }
 292         catch( const Exception& )
 293         {
 294             DBG_UNHANDLED_EXCEPTION();
 295         }
 296         return nButtonType == FormButtonType_URL;
 297     }
 298
 299     //------------------------------------------------------------------------
 300     bool PushButtonNavigation::hasNonEmptyCurrentTargetURL() const
 301     {
 302         ::rtl::OUString sTargetURL;
 303         OSL_VERIFY( getCurrentTargetURL() >>= sTargetURL );
 304         return sTargetURL.getLength() != 0;
 305     }
 306
 307 //............................................................................
 308 }   // namespace pcr
 309 //............................................................................