Files
libreoffice/extensions/source/propctrlr/pushbuttonnavigation.cxx
Olivier Hallot 0fd40fe17b Fix for fdo43460 Part XVI getLength() to isEmpty()
Part XVI
Module
extensions
2011-12-23 09:36:43 +01:00

308 lines
12 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#include "pushbuttonnavigation.hxx"
#include <com/sun/star/form/FormButtonType.hpp>
#include <com/sun/star/beans/XPropertyState.hpp>
#include "formstrings.hxx"
#include <comphelper/extract.hxx>
#include <comphelper/property.hxx>
#include <osl/diagnose.h>
#include <tools/diagnose_ex.h>
//............................................................................
namespace pcr
{
//............................................................................
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::form;
//------------------------------------------------------------------------
namespace
{
static const sal_Int32 s_nFirstVirtualButtonType = 1 + (sal_Int32)FormButtonType_URL;
static const sal_Char* pNavigationURLs[] =
{
".uno:FormController/moveToFirst",
".uno:FormController/moveToPrev",
".uno:FormController/moveToNext",
".uno:FormController/moveToLast",
".uno:FormController/saveRecord",
".uno:FormController/undoRecord",
".uno:FormController/moveToNew",
".uno:FormController/deleteRecord",
".uno:FormController/refreshForm",
NULL
};
static sal_Int32 lcl_getNavigationURLIndex( const ::rtl::OUString& _rNavURL )
{
const sal_Char** pLookup = pNavigationURLs;
while ( *pLookup )
{
if ( _rNavURL.equalsAscii( *pLookup ) )
return pLookup - pNavigationURLs;
++pLookup;
}
return -1;
}
static const sal_Char* lcl_getNavigationURL( sal_Int32 _nButtonTypeIndex )
{
const sal_Char** pLookup = pNavigationURLs;
while ( _nButtonTypeIndex-- && *pLookup++ )
;
OSL_ENSURE( *pLookup, "lcl_getNavigationURL: invalid index!" );
return *pLookup;
}
}
//========================================================================
//= PushButtonNavigation
//========================================================================
//------------------------------------------------------------------------
PushButtonNavigation::PushButtonNavigation( const Reference< XPropertySet >& _rxControlModel )
:m_xControlModel( _rxControlModel )
,m_bIsPushButton( sal_False )
{
OSL_ENSURE( m_xControlModel.is(), "PushButtonNavigation::PushButtonNavigation: invalid control model!" );
try
{
m_bIsPushButton = ::comphelper::hasProperty( PROPERTY_BUTTONTYPE, m_xControlModel );
}
catch( const Exception& )
{
OSL_FAIL( "PushButtonNavigation::PushButtonNavigation: caught an exception!" );
}
}
//------------------------------------------------------------------------
sal_Int32 PushButtonNavigation::implGetCurrentButtonType() const SAL_THROW((Exception))
{
sal_Int32 nButtonType = FormButtonType_PUSH;
if ( !m_xControlModel.is() )
return nButtonType;
OSL_VERIFY( ::cppu::enum2int( nButtonType, m_xControlModel->getPropertyValue( PROPERTY_BUTTONTYPE ) ) );
if ( nButtonType == FormButtonType_URL )
{
// there's a chance that this is a "virtual" button type
// (which are realized by special URLs)
::rtl::OUString sTargetURL;
m_xControlModel->getPropertyValue( PROPERTY_TARGET_URL ) >>= sTargetURL;
sal_Int32 nNavigationURLIndex = lcl_getNavigationURLIndex( sTargetURL );
if ( nNavigationURLIndex >= 0)
// it actually *is* a virtual button type
nButtonType = s_nFirstVirtualButtonType + nNavigationURLIndex;
}
return nButtonType;
}
//------------------------------------------------------------------------
Any PushButtonNavigation::getCurrentButtonType() const SAL_THROW(())
{
OSL_ENSURE( m_bIsPushButton, "PushButtonNavigation::getCurrentButtonType: not expected to be called for forms!" );
Any aReturn;
try
{
aReturn <<= implGetCurrentButtonType();
}
catch( const Exception& )
{
OSL_FAIL( "PushButtonNavigation::getCurrentButtonType: caught an exception!" );
}
return aReturn;
}
//------------------------------------------------------------------------
void PushButtonNavigation::setCurrentButtonType( const Any& _rValue ) const SAL_THROW(())
{
OSL_ENSURE( m_bIsPushButton, "PushButtonNavigation::setCurrentButtonType: not expected to be called for forms!" );
if ( !m_xControlModel.is() )
return;
try
{
sal_Int32 nButtonType = FormButtonType_PUSH;
OSL_VERIFY( ::cppu::enum2int( nButtonType, _rValue ) );
::rtl::OUString sTargetURL;
bool bIsVirtualButtonType = nButtonType >= s_nFirstVirtualButtonType;
if ( bIsVirtualButtonType )
{
const sal_Char* pURL = lcl_getNavigationURL( nButtonType - s_nFirstVirtualButtonType );
sTargetURL = ::rtl::OUString::createFromAscii( pURL );
nButtonType = FormButtonType_URL;
}
m_xControlModel->setPropertyValue( PROPERTY_BUTTONTYPE, makeAny( static_cast< FormButtonType >( nButtonType ) ) );
m_xControlModel->setPropertyValue( PROPERTY_TARGET_URL, makeAny( sTargetURL ) );
}
catch( const Exception& )
{
OSL_FAIL( "PushButtonNavigation::setCurrentButtonType: caught an exception!" );
}
}
//------------------------------------------------------------------------
PropertyState PushButtonNavigation::getCurrentButtonTypeState( ) const SAL_THROW(())
{
OSL_ENSURE( m_bIsPushButton, "PushButtonNavigation::getCurrentButtonTypeState: not expected to be called for forms!" );
PropertyState eState = PropertyState_DIRECT_VALUE;
try
{
Reference< XPropertyState > xStateAccess( m_xControlModel, UNO_QUERY );
if ( xStateAccess.is() )
{
// let's see what the model says about the ButtonType property
eState = xStateAccess->getPropertyState( PROPERTY_BUTTONTYPE );
if ( eState == PropertyState_DIRECT_VALUE )
{
sal_Int32 nRealButtonType = FormButtonType_PUSH;
OSL_VERIFY( ::cppu::enum2int( nRealButtonType, m_xControlModel->getPropertyValue( PROPERTY_BUTTONTYPE ) ) );
// perhaps it's one of the virtual button types?
if ( FormButtonType_URL == nRealButtonType )
{
// yes, it is -> rely on the state of the URL property
eState = xStateAccess->getPropertyState( PROPERTY_TARGET_URL );
}
}
}
}
catch( const Exception& )
{
OSL_FAIL( "PushButtonNavigation::getCurrentButtonTypeState: caught an exception!" );
}
return eState;
}
//------------------------------------------------------------------------
Any PushButtonNavigation::getCurrentTargetURL() const SAL_THROW(())
{
Any aReturn;
if ( !m_xControlModel.is() )
return aReturn;
try
{
aReturn = m_xControlModel->getPropertyValue( PROPERTY_TARGET_URL );
if ( m_bIsPushButton )
{
sal_Int32 nCurrentButtonType = implGetCurrentButtonType();
bool bIsVirtualButtonType = nCurrentButtonType >= s_nFirstVirtualButtonType;
if ( bIsVirtualButtonType )
{
// pretend (to the user) that there's no URL set - since
// virtual button types imply a special (technical) URL which
// the user should not see
aReturn <<= ::rtl::OUString();
}
}
}
catch( const Exception& )
{
OSL_FAIL( "PushButtonNavigation::getCurrentTargetURL: caught an exception!" );
}
return aReturn;
}
//------------------------------------------------------------------------
void PushButtonNavigation::setCurrentTargetURL( const Any& _rValue ) const SAL_THROW(())
{
if ( !m_xControlModel.is() )
return;
try
{
m_xControlModel->setPropertyValue( PROPERTY_TARGET_URL, _rValue );
}
catch( const Exception& )
{
OSL_FAIL( "PushButtonNavigation::setCurrentTargetURL: caught an exception!" );
}
}
//------------------------------------------------------------------------
PropertyState PushButtonNavigation::getCurrentTargetURLState( ) const SAL_THROW(())
{
PropertyState eState = PropertyState_DIRECT_VALUE;
try
{
Reference< XPropertyState > xStateAccess( m_xControlModel, UNO_QUERY );
if ( xStateAccess.is() )
{
eState = xStateAccess->getPropertyState( PROPERTY_TARGET_URL );
}
}
catch( const Exception& )
{
OSL_FAIL( "PushButtonNavigation::setCurrentTargetURL: caught an exception!" );
}
return eState;
}
//------------------------------------------------------------------------
bool PushButtonNavigation::currentButtonTypeIsOpenURL() const
{
sal_Int32 nButtonType( FormButtonType_PUSH );
try
{
nButtonType = implGetCurrentButtonType();
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
return nButtonType == FormButtonType_URL;
}
//------------------------------------------------------------------------
bool PushButtonNavigation::hasNonEmptyCurrentTargetURL() const
{
::rtl::OUString sTargetURL;
OSL_VERIFY( getCurrentTargetURL() >>= sTargetURL );
return !sTargetURL.isEmpty();
}
//............................................................................
} // namespace pcr
//............................................................................
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */