/* -*- 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 <uielement/statusbarmanager.hxx>
#include <uielement/genericstatusbarcontroller.hxx>
#include <framework/sfxhelperfunctions.hxx>
#include <framework/addonsoptions.hxx>
#include <uielement/statusbarmerger.hxx>
#include <uielement/statusbaritem.hxx>
#include <com/sun/star/frame/XLayoutManager.hpp>
#include <com/sun/star/frame/theStatusbarControllerFactory.hpp>
#include <com/sun/star/ui/ItemStyle.hpp>
#include <com/sun/star/ui/ItemType.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/awt/Command.hpp>
#include <com/sun/star/ui/XStatusbarItem.hpp>
#include <comphelper/processfactory.hxx>
#include <comphelper/propertyvalue.hxx>
#include <comphelper/sequence.hxx>
#include <toolkit/helper/vclunohelper.hxx>
#include <svtools/statusbarcontroller.hxx>
#include <tools/debug.hxx>
#include <utility>
#include <vcl/commandevent.hxx>
#include <vcl/event.hxx>
#include <vcl/status.hxx>
#include <vcl/svapp.hxx>
#include <vcl/settings.hxx>
#include <vcl/commandinfoprovider.hxx>
#include <cassert>
using namespace ::com::sun::star;
namespace framework
{
namespace
{
template< class MAP >
struct lcl_UpdateController
{
void operator()( typename MAP::value_type &rElement ) const
{
try
{
if ( rElement.second.is() )
rElement.second->update();
}
catch ( uno::Exception& )
{
}
}
};
template< class MAP >
struct lcl_RemoveController
{
void operator()( typename MAP::value_type &rElement ) const
{
try
{
if ( rElement.second.is() )
rElement.second->dispose();
}
catch ( uno::Exception& )
{
}
}
};
StatusBarItemBits impl_convertItemStyleToItemBits( sal_Int16 nStyle )
{
StatusBarItemBits nItemBits( StatusBarItemBits::NONE );
if (( nStyle & css::ui::ItemStyle::ALIGN_RIGHT ) == css::ui::ItemStyle::ALIGN_RIGHT )
nItemBits |= StatusBarItemBits::Right;
else if ( nStyle & css::ui::ItemStyle::ALIGN_LEFT )
nItemBits |= StatusBarItemBits::Left;
else
nItemBits |= StatusBarItemBits::Center;
if (( nStyle & css::ui::ItemStyle::DRAW_FLAT ) == css::ui::ItemStyle::DRAW_FLAT )
nItemBits |= StatusBarItemBits::Flat;
else if ( nStyle & css::ui::ItemStyle::DRAW_OUT3D )
nItemBits |= StatusBarItemBits::Out;
else
nItemBits |= StatusBarItemBits::In;
if (( nStyle & css::ui::ItemStyle::AUTO_SIZE ) == css::ui::ItemStyle::AUTO_SIZE )
nItemBits |= StatusBarItemBits::AutoSize;
if ( nStyle & css::ui::ItemStyle::OWNER_DRAW )
nItemBits |= StatusBarItemBits::UserDraw;
if ( nStyle & css::ui::ItemStyle::MANDATORY )
nItemBits |= StatusBarItemBits::Mandatory;
return nItemBits;
}
}
StatusBarManager::StatusBarManager(
uno::Reference< uno::XComponentContext > xContext,
uno::Reference< frame::XFrame > rFrame,
StatusBar* pStatusBar ) :
m_bDisposed( false ),
m_bFrameActionRegistered( false ),
m_bUpdateControllers( false ),
m_pStatusBar( pStatusBar ),
m_xFrame(std::move( rFrame )),
m_xContext(std::move( xContext ))
{
m_xStatusbarControllerFactory = frame::theStatusbarControllerFactory::get(
::comphelper::getProcessComponentContext());
m_pStatusBar->AdjustItemWidthsForHiDPI();
m_pStatusBar->SetClickHdl( LINK( this, StatusBarManager, Click ) );
m_pStatusBar->SetDoubleClickHdl( LINK( this, StatusBarManager, DoubleClick ) );
}
StatusBarManager::~StatusBarManager()
{
}
StatusBar* StatusBarManager::GetStatusBar() const
{
SolarMutexGuard g;
return m_pStatusBar;
}
void StatusBarManager::frameAction( const frame::FrameActionEvent& Action )
{
SolarMutexGuard g;
if ( Action.Action == frame::FrameAction_CONTEXT_CHANGED )
UpdateControllers();
}
void SAL_CALL StatusBarManager::disposing( const lang::EventObject& Source )
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
RemoveControllers();
if ( Source.Source == uno::Reference< uno::XInterface >( m_xFrame, uno::UNO_QUERY ))
m_xFrame.clear();
m_xContext.clear();
}
// XComponent
void SAL_CALL StatusBarManager::dispose()
{
uno::Reference< lang::XComponent > xThis(this );
{
lang::EventObject aEvent( xThis );
std::unique_lock aGuard(m_mutex);
m_aListenerContainer.disposeAndClear( aGuard, aEvent );
}
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
RemoveControllers();
// destroy the item data
for ( sal_uInt16 n = 0; n < m_pStatusBar->GetItemCount(); n++ )
{
AddonStatusbarItemData *pUserData = static_cast< AddonStatusbarItemData *>(
m_pStatusBar->GetItemData( m_pStatusBar->GetItemId( n ) ) );
delete pUserData;
}
m_pStatusBar.disposeAndClear();
if ( m_bFrameActionRegistered && m_xFrame.is() )
{
try
{
m_xFrame->removeFrameActionListener( uno::Reference< frame::XFrameActionListener >(this) );
}
catch ( const uno::Exception& )
{
}
}
m_xFrame.clear();
m_xContext.clear();
m_bDisposed = true;
}
}
void SAL_CALL StatusBarManager::addEventListener( const uno::Reference< lang::XEventListener >& xListener )
{
SolarMutexGuard g;
/* SAFE AREA ----------------------------------------------------------------------------------------------- */
if ( m_bDisposed )
throw lang::DisposedException();
std::unique_lock aGuard(m_mutex);
m_aListenerContainer.addInterface( aGuard, xListener );
}
void SAL_CALL StatusBarManager::removeEventListener( const uno::Reference< lang::XEventListener >& xListener )
{
std::unique_lock aGuard(m_mutex);
m_aListenerContainer.removeInterface( aGuard, xListener );
}
// XUIConfigurationListener
void SAL_CALL StatusBarManager::elementInserted( const css::ui::ConfigurationEvent& )
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
}
void SAL_CALL StatusBarManager::elementRemoved( const css::ui::ConfigurationEvent& )
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
}
void SAL_CALL StatusBarManager::elementReplaced( const css::ui::ConfigurationEvent& )
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
}
void StatusBarManager::UpdateControllers()
{
if ( !m_bUpdateControllers )
{
m_bUpdateControllers = true;
std::for_each( m_aControllerMap.begin(),
m_aControllerMap.end(),
lcl_UpdateController< StatusBarControllerMap >() );
}
m_bUpdateControllers = false;
}
void StatusBarManager::RemoveControllers()
{
DBG_TESTSOLARMUTEX();
assert(!m_bDisposed);
std::for_each( m_aControllerMap.begin(),
m_aControllerMap.end(),
lcl_RemoveController< StatusBarControllerMap >() );
m_aControllerMap.clear();
}
void StatusBarManager::CreateControllers()
{
uno::Reference< awt::XWindow > xStatusbarWindow = VCLUnoHelper::GetInterface( m_pStatusBar );
for ( sal_uInt16 i = 0; i < m_pStatusBar->GetItemCount(); i++ )
{
sal_uInt16 nId = m_pStatusBar->GetItemId( i );
if ( nId == 0 )
continue;
OUString aCommandURL( m_pStatusBar->GetItemCommand( nId ));
bool bInit( true );
uno::Reference< frame::XStatusbarController > xController;
AddonStatusbarItemData *pItemData = static_cast< AddonStatusbarItemData *>( m_pStatusBar->GetItemData( nId ) );
uno::Reference< ui::XStatusbarItem > xStatusbarItem = new StatusbarItem( m_pStatusBar, nId, aCommandURL );
std::vector< uno::Any > aPropVector
{
uno::Any(comphelper::makePropertyValue(u"CommandURL"_ustr, aCommandURL)),
uno::Any(comphelper::makePropertyValue(u"ModuleIdentifier"_ustr, u""_ustr)),
uno::Any(comphelper::makePropertyValue(u"Frame"_ustr, m_xFrame)),
// TODO remove this
uno::Any(comphelper::makePropertyValue(u"ServiceManager"_ustr, uno::Reference<lang::XMultiServiceFactory>(m_xContext->getServiceManager(), uno::UNO_QUERY_THROW))),
uno::Any(comphelper::makePropertyValue(u"ParentWindow"_ustr, xStatusbarWindow)),
uno::Any(comphelper::makePropertyValue(u"Identifier"_ustr, nId)),
uno::Any(comphelper::makePropertyValue(u"StatusbarItem"_ustr, xStatusbarItem))
};
uno::Sequence< uno::Any > aArgs( comphelper::containerToSequence( aPropVector ) );
// 1) UNO Statusbar controllers, registered in Controllers.xcu
if ( m_xStatusbarControllerFactory.is() &&
m_xStatusbarControllerFactory->hasController( aCommandURL, u""_ustr ))
{
xController.set(m_xStatusbarControllerFactory->createInstanceWithArgumentsAndContext(
aCommandURL, aArgs, m_xContext ),
uno::UNO_QUERY );
bInit = false; // Initialization is done through the factory service
}
if ( !xController.is() )
{
// 2) Old SFX2 Statusbar controllers
xController = CreateStatusBarController( m_xFrame, m_pStatusBar, nId, aCommandURL );
if ( !xController )
{
// 3) Is Add-on? Generic statusbar controller
if ( pItemData )
{
xController = new GenericStatusbarController( m_xContext,
m_xFrame,
xStatusbarItem,
pItemData );
}
else
{
// 4) Default Statusbar controller
xController = new svt::StatusbarController( m_xContext, m_xFrame, aCommandURL, nId );
}
}
}
m_aControllerMap[nId] = xController;
if ( bInit )
{
xController->initialize( aArgs );
}
}
// add frame action listeners
if ( !m_bFrameActionRegistered && m_xFrame.is() )
{
m_bFrameActionRegistered = true;
m_xFrame->addFrameActionListener( uno::Reference< frame::XFrameActionListener >(this) );
}
}
void StatusBarManager::FillStatusBar( const uno::Reference< container::XIndexAccess >& rItemContainer )
{
SolarMutexGuard g;
if ( m_bDisposed || !m_pStatusBar )
return;
sal_uInt16 nId( 1 );
RemoveControllers();
// reset and fill command map
m_pStatusBar->Clear();
m_aControllerMap.clear();// TODO already done in RemoveControllers
for ( sal_Int32 n = 0; n < rItemContainer->getCount(); n++ )
{
uno::Sequence< beans::PropertyValue > aProps;
OUString aCommandURL;
sal_Int16 nOffset( 0 );
sal_Int16 nStyle( 0 );
sal_Int16 nWidth( 0 );
sal_uInt16 nType( css::ui::ItemType::DEFAULT );
try
{
if ( rItemContainer->getByIndex( n ) >>= aProps )
{
for (beans::PropertyValue const& prop : aProps)
{
if ( prop.Name == "CommandURL" )
{
prop.Value >>= aCommandURL;
}
else if ( prop.Name == "Style" )
{
prop.Value >>= nStyle;
}
else if ( prop.Name == "Type" )
{
prop.Value >>= nType;
}
else if ( prop.Name == "Width" )
{
prop.Value >>= nWidth;
}
else if ( prop.Name == "Offset" )
{
prop.Value >>= nOffset;
}
}
if (( nType == css::ui::ItemType::DEFAULT ) && !aCommandURL.isEmpty() )
{
auto aProperties = vcl::CommandInfoProvider::GetCommandProperties(aCommandURL, u""_ustr);
OUString aString(vcl::CommandInfoProvider::GetLabelForCommand(aProperties));
StatusBarItemBits nItemBits( impl_convertItemStyleToItemBits( nStyle ));
m_pStatusBar->InsertItem( nId, nWidth, nItemBits, nOffset );
m_pStatusBar->SetItemCommand( nId, aCommandURL );
m_pStatusBar->SetAccessibleName( nId, aString );
++nId;
}
}
}
catch ( const css::lang::IndexOutOfBoundsException& )
{
break;
}
}
// Statusbar Merging
constexpr sal_uInt16 STATUSBAR_ITEM_STARTID = 1000;
MergeStatusbarInstructionContainer aMergeInstructions = AddonsOptions().GetMergeStatusbarInstructions();
if ( !aMergeInstructions.empty() )
{
const sal_uInt32 nCount = aMergeInstructions.size();
sal_uInt16 nItemId( STATUSBAR_ITEM_STARTID );
for ( sal_uInt32 i = 0; i < nCount; i++ )
{
MergeStatusbarInstruction &rInstruction = aMergeInstructions[i];
if ( !StatusbarMerger::IsCorrectContext( rInstruction.aMergeContext ) )
continue;
AddonStatusbarItemContainer aItems;
StatusbarMerger::ConvertSeqSeqToVector( rInstruction.aMergeStatusbarItems, aItems );
sal_uInt16 nRefPos = StatusbarMerger::FindReferencePos( m_pStatusBar, rInstruction.aMergePoint );
if ( nRefPos != STATUSBAR_ITEM_NOTFOUND )
{
StatusbarMerger::ProcessMergeOperation( m_pStatusBar,
nRefPos,
nItemId,
rInstruction.aMergeCommand,
rInstruction.aMergeCommandParameter,
aItems );
}
else
{
StatusbarMerger::ProcessMergeFallback( m_pStatusBar,
nItemId,
rInstruction.aMergeCommand,
rInstruction.aMergeCommandParameter,
aItems );
}
}
}
// Create controllers
CreateControllers();
// Notify controllers that they are now correctly initialized and can start listening
UpdateControllers();
}
void StatusBarManager::DataChanged( const DataChangedEvent& rDCEvt )
{
SolarMutexClearableGuard aGuard;
if ((( rDCEvt.GetType() == DataChangedEventType::SETTINGS ) ||
( rDCEvt.GetType() == DataChangedEventType::FONTS ) ||
( rDCEvt.GetType() == DataChangedEventType::FONTSUBSTITUTION ) ||
( rDCEvt.GetType() == DataChangedEventType::DISPLAY )) &&
( rDCEvt.GetFlags() & AllSettingsFlags::STYLE ))
{
css::uno::Reference< css::frame::XLayoutManager > xLayoutManager;
css::uno::Reference< css::beans::XPropertySet > xPropSet( m_xFrame, css::uno::UNO_QUERY );
if ( xPropSet.is() )
xPropSet->getPropertyValue(u"LayoutManager"_ustr) >>= xLayoutManager;
if ( xLayoutManager.is() )
{
aGuard.clear();
xLayoutManager->doLayout();
}
}
}
void StatusBarManager::UserDraw( const UserDrawEvent& rUDEvt )
{
SolarMutexClearableGuard aGuard;
if ( m_bDisposed )
return;
sal_uInt16 nId( rUDEvt.GetItemId() );
StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
if (( nId <= 0 ) || ( it == m_aControllerMap.end() ))
return;
uno::Reference< frame::XStatusbarController > xController( it->second );
if (xController.is() && rUDEvt.GetRenderContext())
{
uno::Reference< awt::XGraphics > xGraphics = rUDEvt.GetRenderContext()->CreateUnoGraphics();
awt::Rectangle aRect( rUDEvt.GetRect().Left(),
rUDEvt.GetRect().Top(),
rUDEvt.GetRect().GetWidth(),
rUDEvt.GetRect().GetHeight() );
aGuard.clear();
xController->paint(xGraphics, aRect, 0);
}
}
void StatusBarManager::Command( const CommandEvent& rEvt )
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
if ( rEvt.GetCommand() != CommandEventId::ContextMenu )
return;
sal_uInt16 nId = m_pStatusBar->GetItemId( rEvt.GetMousePosPixel() );
StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
if (( nId > 0 ) && ( it != m_aControllerMap.end() ))
{
uno::Reference< frame::XStatusbarController > xController( it->second );
if ( xController.is() )
{
awt::Point aPos;
aPos.X = rEvt.GetMousePosPixel().X();
aPos.Y = rEvt.GetMousePosPixel().Y();
xController->command( aPos, awt::Command::CONTEXTMENU, true, uno::Any() );
}
}
}
void StatusBarManager::MouseMove( const MouseEvent& rMEvt )
{
MouseButton(rMEvt,&frame::XStatusbarController::mouseMove);
}
void StatusBarManager::MouseButton( const MouseEvent& rMEvt ,sal_Bool ( SAL_CALL frame::XStatusbarController::*_pMethod )(const css::awt::MouseEvent&))
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
sal_uInt16 nId = m_pStatusBar->GetItemId( rMEvt.GetPosPixel() );
StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
if (( nId <= 0 ) || ( it == m_aControllerMap.end() ))
return;
uno::Reference< frame::XStatusbarController > xController( it->second );
if ( xController.is() )
{
css::awt::MouseEvent aMouseEvent;
aMouseEvent.Buttons = rMEvt.GetButtons();
aMouseEvent.X = rMEvt.GetPosPixel().X();
aMouseEvent.Y = rMEvt.GetPosPixel().Y();
aMouseEvent.ClickCount = rMEvt.GetClicks();
(xController.get()->*_pMethod)( aMouseEvent);
}
}
void StatusBarManager::MouseButtonDown( const MouseEvent& rMEvt )
{
MouseButton(rMEvt,&frame::XStatusbarController::mouseButtonDown);
}
void StatusBarManager::MouseButtonUp( const MouseEvent& rMEvt )
{
MouseButton(rMEvt,&frame::XStatusbarController::mouseButtonUp);
}
IMPL_LINK_NOARG(StatusBarManager, Click, StatusBar*, void)
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
sal_uInt16 nId = m_pStatusBar->GetCurItemId();
StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
if (( nId > 0 ) && ( it != m_aControllerMap.end() ))
{
uno::Reference< frame::XStatusbarController > xController( it->second );
if ( xController.is() )
{
const Point aVCLPos = m_pStatusBar->GetPointerPosPixel();
const awt::Point aAWTPoint( aVCLPos.X(), aVCLPos.Y() );
xController->click( aAWTPoint );
}
}
}
IMPL_LINK_NOARG(StatusBarManager, DoubleClick, StatusBar*, void)
{
SolarMutexGuard g;
if ( m_bDisposed )
return;
sal_uInt16 nId = m_pStatusBar->GetCurItemId();
StatusBarControllerMap::const_iterator it = m_aControllerMap.find( nId );
if (( nId > 0 ) && ( it != m_aControllerMap.end() ))
{
uno::Reference< frame::XStatusbarController > xController( it->second );
if ( xController.is() )
{
const Point aVCLPos = m_pStatusBar->GetPointerPosPixel();
const awt::Point aAWTPoint( aVCLPos.X(), aVCLPos.Y() );
xController->doubleClick( aAWTPoint );
}
}
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
↑ V519 The 'm_bUpdateControllers' variable is assigned values twice successively. Perhaps this is a mistake. Check lines: 268, 273.