Files
libreoffice/toolkit/source/controls/stdtabcontroller.cxx
Michael Stahl 15b4ab8d19 cppuhelper: clean up public headers with include-what-you-use
Change-Id: I41ba46831f24b2960a1fe982b74a2b623e682e0b
2014-11-18 18:51:49 +01:00

398 lines
14 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/awt/XVclContainerPeer.hpp>
#include <toolkit/controls/stdtabcontroller.hxx>
#include <toolkit/controls/stdtabcontrollermodel.hxx>
#include <toolkit/awt/vclxwindow.hxx>
#include <toolkit/helper/macros.hxx>
#include <cppuhelper/typeprovider.hxx>
#include <cppuhelper/queryinterface.hxx>
#include <rtl/uuid.h>
#include <tools/debug.hxx>
#include <vcl/svapp.hxx>
#include <vcl/window.hxx>
#include <comphelper/sequence.hxx>
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::awt;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::beans;
// class StdTabController
StdTabController::StdTabController()
{
}
StdTabController::~StdTabController()
{
}
bool StdTabController::ImplCreateComponentSequence(
Sequence< Reference< XControl > >& rControls,
const Sequence< Reference< XControlModel > >& rModels,
Sequence< Reference< XWindow > >& rComponents,
Sequence< Any>* pTabStops,
bool bPeerComponent ) const
{
bool bOK = true;
// Get only the requested controls
sal_Int32 nModels = rModels.getLength();
if (nModels != rControls.getLength())
{
Sequence< Reference< XControl > > aSeq( nModels );
const Reference< XControlModel >* pModels = rModels.getConstArray();
Reference< XControl > xCurrentControl;
sal_Int32 nRealControls = 0;
for (sal_Int32 n = 0; n < nModels; ++n, ++pModels)
{
xCurrentControl = FindControl(rControls, *pModels);
if (xCurrentControl.is())
aSeq.getArray()[nRealControls++] = xCurrentControl;
}
aSeq.realloc(nRealControls);
rControls = aSeq;
}
#ifdef DBG_UTIL
DBG_ASSERT( rControls.getLength() <= rModels.getLength(), "StdTabController:ImplCreateComponentSequence: inconsistence!" );
// there may be less controls than models, but never more controls than models
#endif
const Reference< XControl > * pControls = rControls.getConstArray();
sal_uInt32 nCtrls = rControls.getLength();
rComponents.realloc( nCtrls );
Reference< XWindow > * pComps = rComponents.getArray();
Any* pTabs = NULL;
if ( pTabStops )
{
*pTabStops = Sequence< Any>( nCtrls );
pTabs = pTabStops->getArray();
}
for ( sal_uInt32 n = 0; bOK && ( n < nCtrls ); n++ )
{
// Get the matching control for this model
Reference< XControl > xCtrl(pControls[n]);
if ( xCtrl.is() )
{
if (bPeerComponent)
pComps[n] = Reference< XWindow > (xCtrl->getPeer(), UNO_QUERY);
else
pComps[n] = Reference< XWindow > (xCtrl, UNO_QUERY);
// TabStop-Property
if ( pTabs )
{
// opt: Constant String for TabStop name
static const char aTabStopName[] = "Tabstop";
Reference< XPropertySet > xPSet( xCtrl->getModel(), UNO_QUERY );
Reference< XPropertySetInfo > xInfo = xPSet->getPropertySetInfo();
if( xInfo->hasPropertyByName( aTabStopName ) )
*pTabs++ = xPSet->getPropertyValue( aTabStopName );
else
++pTabs;
}
}
else
{
OSL_TRACE( "ImplCreateComponentSequence: Control not found" );
bOK = false;
}
}
return bOK;
}
void StdTabController::ImplActivateControl( bool bFirst ) const
{
// HACK due to bug #53688#, map controls onto an interface if remote controls may occur
Reference< XTabController > xTabController(const_cast< ::cppu::OWeakObject* >(static_cast< const ::cppu::OWeakObject* >(this)), UNO_QUERY);
Sequence< Reference< XControl > > aCtrls = xTabController->getControls();
const Reference< XControl > * pControls = aCtrls.getConstArray();
sal_uInt32 nCount = aCtrls.getLength();
for ( sal_uInt32 n = bFirst ? 0 : nCount; bFirst ? n < nCount : n != 0; )
{
sal_uInt32 nCtrl = bFirst ? n++ : --n;
DBG_ASSERT( pControls[nCtrl].is(), "Control nicht im Container!" );
if ( pControls[nCtrl].is() )
{
Reference< XWindowPeer > xCP = pControls[nCtrl]->getPeer();
if ( xCP.is() )
{
VCLXWindow* pC = VCLXWindow::GetImplementation( xCP );
if ( pC && pC->GetWindow() && ( pC->GetWindow()->GetStyle() & WB_TABSTOP ) )
{
pC->GetWindow()->GrabFocus();
break;
}
}
}
}
}
// XInterface
Any StdTabController::queryAggregation( const Type & rType ) throw(RuntimeException, std::exception)
{
Any aRet = ::cppu::queryInterface( rType,
(static_cast< XTabController* >(this)),
(static_cast< XServiceInfo* >(this)),
(static_cast< XTypeProvider* >(this)) );
return (aRet.hasValue() ? aRet : OWeakAggObject::queryAggregation( rType ));
}
// XTypeProvider
IMPL_XTYPEPROVIDER_START( StdTabController )
cppu::UnoType<XTabController>::get(),
cppu::UnoType<XServiceInfo>::get()
IMPL_XTYPEPROVIDER_END
void StdTabController::setModel( const Reference< XTabControllerModel >& Model ) throw(RuntimeException, std::exception)
{
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
mxModel = Model;
}
Reference< XTabControllerModel > StdTabController::getModel( ) throw(RuntimeException, std::exception)
{
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
return mxModel;
}
void StdTabController::setContainer( const Reference< XControlContainer >& Container ) throw(RuntimeException, std::exception)
{
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
mxControlContainer = Container;
}
Reference< XControlContainer > StdTabController::getContainer( ) throw(RuntimeException, std::exception)
{
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
return mxControlContainer;
}
Sequence< Reference< XControl > > StdTabController::getControls( ) throw(RuntimeException, std::exception)
{
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
Sequence< Reference< XControl > > aSeq;
if ( mxControlContainer.is() )
{
Sequence< Reference< XControlModel > > aModels = mxModel->getControlModels();
const Reference< XControlModel > * pModels = aModels.getConstArray();
Sequence< Reference< XControl > > xCtrls = mxControlContainer->getControls();
sal_uInt32 nCtrls = aModels.getLength();
aSeq = Sequence< Reference< XControl > >( nCtrls );
for ( sal_uInt32 n = 0; n < nCtrls; n++ )
{
Reference< XControlModel > xCtrlModel = pModels[n];
// Search matching Control for this Model
Reference< XControl > xCtrl = FindControl( xCtrls, xCtrlModel );
aSeq.getArray()[n] = xCtrl;
}
}
return aSeq;
}
void StdTabController::autoTabOrder( ) throw(RuntimeException, std::exception)
{
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
DBG_ASSERT( mxControlContainer.is(), "autoTabOrder: No ControlContainer!" );
if ( !mxControlContainer.is() )
return;
Sequence< Reference< XControlModel > > aSeq = mxModel->getControlModels();
Sequence< Reference< XWindow > > aCompSeq;
// This may return a TabController, which returns desired list of controls faster
Reference< XTabController > xTabController(static_cast< ::cppu::OWeakObject* >(this), UNO_QUERY);
Sequence< Reference< XControl > > aControls = xTabController->getControls();
// #58317# Some Models may be missing from the Container. Plus there is a
// autoTabOrder call later on.
if( !ImplCreateComponentSequence( aControls, aSeq, aCompSeq, NULL, false ) )
return;
sal_uInt32 nCtrls = aCompSeq.getLength();
Reference< XWindow > * pComponents = aCompSeq.getArray();
// insert sort algorithm
ComponentEntryList aCtrls;
size_t n;
for ( n = 0; n < nCtrls; n++ )
{
XWindow* pC = (XWindow*)pComponents[n].get();
ComponentEntry* pE = new ComponentEntry;
pE->pComponent = pC;
awt::Rectangle aPosSize = pC->getPosSize();
pE->aPos.X() = aPosSize.X;
pE->aPos.Y() = aPosSize.Y;
sal_uInt16 nPos;
for ( nPos = 0; nPos < aCtrls.size(); nPos++ )
{
ComponentEntry* pEntry = aCtrls[ nPos ];
if ( ( pEntry->aPos.Y() > pE->aPos.Y() ) ||
( ( pEntry->aPos.Y() == pE->aPos.Y() ) && ( pEntry->aPos.X() > pE->aPos.X() ) ) )
break;
}
if ( nPos < aCtrls.size() ) {
ComponentEntryList::iterator it = aCtrls.begin();
::std::advance( it, nPos );
aCtrls.insert( it, pE );
} else {
aCtrls.push_back( pE );
}
}
Sequence< Reference< XControlModel > > aNewSeq( nCtrls );
for ( n = 0; n < nCtrls; n++ )
{
ComponentEntry* pE = aCtrls[ n ];
Reference< XControl > xUC( pE->pComponent, UNO_QUERY );
aNewSeq.getArray()[n] = xUC->getModel();
delete pE;
}
aCtrls.clear();
mxModel->setControlModels( aNewSeq );
}
void StdTabController::activateTabOrder( ) throw(RuntimeException, std::exception)
{
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
// Activate tab order for the control container
Reference< XControl > xC( mxControlContainer, UNO_QUERY );
Reference< XVclContainerPeer > xVclContainerPeer;
if ( xC.is() )
xVclContainerPeer.set(xC->getPeer(), css::uno::UNO_QUERY);
if ( !xC.is() || !xVclContainerPeer.is() )
return;
// This may return a TabController, which returns desired list of controls faster
Reference< XTabController > xTabController(static_cast< ::cppu::OWeakObject* >(this), UNO_QUERY);
// Get a flattened list of controls sequences
Sequence< Reference< XControlModel > > aModels = mxModel->getControlModels();
Sequence< Reference< XWindow > > aCompSeq;
Sequence< Any> aTabSeq;
// DG: For the sake of optimization, retrieve Controls from getControls(),
// this may sound counterproductive, but leads to performance improvements
// in practical scenarios (Forms)
Sequence< Reference< XControl > > aControls = xTabController->getControls();
// #58317# Some Models may be missing from the Container. Plus there is a
// autoTabOrder call later on.
if( !ImplCreateComponentSequence( aControls, aModels, aCompSeq, &aTabSeq, true ) )
return;
xVclContainerPeer->setTabOrder( aCompSeq, aTabSeq, mxModel->getGroupControl() );
OUString aName;
Sequence< Reference< XControlModel > > aThisGroupModels;
Sequence< Reference< XWindow > > aControlComponents;
sal_uInt32 nGroups = mxModel->getGroupCount();
for ( sal_uInt32 nG = 0; nG < nGroups; nG++ )
{
mxModel->getGroup( nG, aThisGroupModels, aName );
aControls = xTabController->getControls();
// ImplCreateComponentSequence has a really strange semantics regarding it's first parameter:
// upon method entry, it expects a super set of the controls which it returns
// this means we need to completely fill this sequence with all available controls before
// calling into ImplCreateComponentSequence
aControlComponents.realloc( 0 );
ImplCreateComponentSequence( aControls, aThisGroupModels, aControlComponents, NULL, true );
xVclContainerPeer->setGroup( aControlComponents );
}
}
void StdTabController::activateFirst( ) throw(RuntimeException, std::exception)
{
SolarMutexGuard aSolarGuard;
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() ); //TODO: necessary?
ImplActivateControl( true );
}
void StdTabController::activateLast( ) throw(RuntimeException, std::exception)
{
SolarMutexGuard aSolarGuard;
::osl::Guard< ::osl::Mutex > aGuard( GetMutex() ); //TODO: necessary?
ImplActivateControl( false );
}
Reference< XControl > StdTabController::FindControl( Sequence< Reference< XControl > >& rCtrls,
const Reference< XControlModel > & rxCtrlModel )
{
DBG_ASSERT( rxCtrlModel.is(), "ImplFindControl - welches ?!" );
const Reference< XControl > * pCtrls = rCtrls.getConstArray();
sal_Int32 nCtrls = rCtrls.getLength();
for ( sal_Int32 n = 0; n < nCtrls; n++ )
{
Reference< XControlModel > xModel(pCtrls[n].is() ? pCtrls[n]->getModel() : Reference< XControlModel > ());
if ( (XControlModel*)xModel.get() == (XControlModel*)rxCtrlModel.get() )
{
Reference< XControl > xCtrl( pCtrls[n] );
::comphelper::removeElementAt( rCtrls, n );
return xCtrl;
}
}
return Reference< XControl > ();
}
extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface * SAL_CALL
stardiv_Toolkit_StdTabController_get_implementation(
css::uno::XComponentContext *,
css::uno::Sequence<css::uno::Any> const &)
{
return cppu::acquire(new StdTabController());
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */