Michael Weghorn
f26084217a
In the past, weld.hxx used to contain the class definitions for weld::Widget and all subclasses. By now, weld::Widget and almost all subclasses have been moved to separate headers, to make it easier to keep the overview and to avoid having to recompile ~all UI code when one class changes. By now, only weld::Button is left in weld.hxx. Rename the header to Button.hxx. Drop weld.hxx includes and instead add Button.hxx includes (or weld::Button forward declarations) where weld::Button is used. (Don't simply replace all weld.hxx includes with Button.hxx ones, since many of them were for the use of other widgets that have since been moved to their own headers.) Add further includes where needed now that the (direct or transitive) includes of weld.hxx were removed. Change-Id: I8ea6201446a418d5e38b46337059dcd517ee29d7 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/205937 Reviewed-by: Michael Weghorn <m.weghorn@posteo.de> Tested-by: Jenkins
473 lines
17 KiB
C++
473 lines
17 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 <framework/generictoolbarcontroller.hxx>
|
||
|
||
#include <com/sun/star/util/XURLTransformer.hpp>
|
||
#include <com/sun/star/frame/XDispatch.hpp>
|
||
#include <com/sun/star/frame/XFrame.hpp>
|
||
#include <com/sun/star/lang/DisposedException.hpp>
|
||
#include <com/sun/star/frame/status/ItemStatus.hpp>
|
||
#include <com/sun/star/frame/status/Visibility.hpp>
|
||
#include <com/sun/star/frame/ControlCommand.hpp>
|
||
|
||
#include <comphelper/propertyvalue.hxx>
|
||
#include <comphelper/unique_unlock.hxx>
|
||
#include <vcl/image.hxx>
|
||
#include <svl/imageitm.hxx>
|
||
#include <vcl/commandinfoprovider.hxx>
|
||
#include <vcl/svapp.hxx>
|
||
#include <vcl/vclevent.hxx>
|
||
#include <vcl/weld/Toolbar.hxx>
|
||
#include <tools/urlobj.hxx>
|
||
#include <toolkit/helper/vclunohelper.hxx>
|
||
#include <strings.hrc>
|
||
#include <classes/fwkresid.hxx>
|
||
|
||
using namespace ::com::sun::star::uno;
|
||
using namespace ::com::sun::star::beans;
|
||
using namespace ::com::sun::star::lang;
|
||
using namespace ::com::sun::star::frame;
|
||
using namespace ::com::sun::star::frame::status;
|
||
|
||
namespace framework
|
||
{
|
||
|
||
static bool isEnumCommand( std::u16string_view rCommand )
|
||
{
|
||
INetURLObject aURL( rCommand );
|
||
|
||
return ( aURL.GetProtocol() == INetProtocol::Uno ) &&
|
||
( aURL.GetURLPath().indexOf( '.' ) != -1);
|
||
}
|
||
|
||
static OUString getEnumCommand( std::u16string_view rCommand )
|
||
{
|
||
INetURLObject aURL( rCommand );
|
||
|
||
OUString aEnumCommand;
|
||
OUString aURLPath = aURL.GetURLPath();
|
||
sal_Int32 nIndex = aURLPath.indexOf( '.' );
|
||
if (( nIndex > 0 ) && ( nIndex < aURLPath.getLength() ))
|
||
aEnumCommand = aURLPath.copy( nIndex+1 );
|
||
|
||
return aEnumCommand;
|
||
}
|
||
|
||
static OUString getMasterCommand( const OUString& rCommand )
|
||
{
|
||
OUString aMasterCommand( rCommand );
|
||
INetURLObject aURL( rCommand );
|
||
if ( aURL.GetProtocol() == INetProtocol::Uno )
|
||
{
|
||
sal_Int32 nIndex = aURL.GetURLPath().indexOf( '.' );
|
||
if ( nIndex )
|
||
{
|
||
aURL.SetURLPath( aURL.GetURLPath().subView( 0, nIndex ) );
|
||
aMasterCommand = aURL.GetMainURL( INetURLObject::DecodeMechanism::NONE );
|
||
}
|
||
}
|
||
return aMasterCommand;
|
||
}
|
||
|
||
GenericToolbarController::GenericToolbarController( const Reference< XComponentContext >& rxContext,
|
||
const Reference< XFrame >& rFrame,
|
||
ToolBox* pToolbar,
|
||
ToolBoxItemId nID,
|
||
const OUString& aCommand ) :
|
||
svt::ToolboxController( rxContext, rFrame, aCommand )
|
||
, m_xToolbar( pToolbar )
|
||
, m_nID( nID )
|
||
, m_bEnumCommand( isEnumCommand( aCommand ))
|
||
, m_bMirrored( false )
|
||
, m_bMadeInvisible( false )
|
||
, m_aEnumCommand( getEnumCommand( aCommand ))
|
||
{
|
||
if ( m_bEnumCommand )
|
||
addStatusListener( getMasterCommand( aCommand ) );
|
||
|
||
addStatusListener( aCommand );
|
||
|
||
// Initialization is done through ctor
|
||
m_bInitialized = true;
|
||
}
|
||
|
||
GenericToolbarController::GenericToolbarController( const Reference< XComponentContext >& rxContext,
|
||
const Reference< XFrame >& rFrame,
|
||
weld::Toolbar& rToolbar,
|
||
const OUString& aCommand ) :
|
||
GenericToolbarController( rxContext, rFrame, nullptr, ToolBoxItemId(0), aCommand )
|
||
{
|
||
m_pToolbar = &rToolbar;
|
||
}
|
||
|
||
GenericToolbarController::~GenericToolbarController()
|
||
{
|
||
}
|
||
|
||
void GenericToolbarController::disposing(std::unique_lock<std::mutex>& rGuard)
|
||
{
|
||
svt::ToolboxController::disposing(rGuard);
|
||
comphelper::unique_unlock aUnlock(rGuard);
|
||
SolarMutexGuard aSolarMutexGuard;
|
||
|
||
m_pToolbar = nullptr;
|
||
m_xToolbar.reset();
|
||
m_nID = ToolBoxItemId(0);
|
||
}
|
||
|
||
void SAL_CALL GenericToolbarController::execute( sal_Int16 KeyModifier )
|
||
{
|
||
Reference< XDispatch > xDispatch;
|
||
OUString aCommandURL;
|
||
|
||
{
|
||
SolarMutexGuard aSolarMutexGuard;
|
||
|
||
if ( m_bDisposed )
|
||
throw DisposedException();
|
||
|
||
if ( !m_bInitialized || !m_xFrame.is() || m_aCommandURL.isEmpty() )
|
||
return;
|
||
|
||
URLToDispatchMap::iterator pIter = m_aListenerMap.find( m_aCommandURL );
|
||
|
||
if ( pIter == m_aListenerMap.end() )
|
||
return;
|
||
|
||
aCommandURL = m_aCommandURL;
|
||
xDispatch = pIter->second;
|
||
|
||
// tdf#138234 If this toolbar is a floating window then
|
||
// clicking on a button probably took the window focus. Let’s
|
||
// give it back to the toolbar’s frame.
|
||
if ( m_xFrame.is() && m_xFrame->getContainerWindow().is() )
|
||
m_xFrame->getContainerWindow()->setFocus();
|
||
}
|
||
|
||
css::util::URL aTargetURL;
|
||
|
||
// handle also command aliases
|
||
auto aProperties = vcl::CommandInfoProvider::GetCommandProperties(m_aCommandURL,
|
||
vcl::CommandInfoProvider::GetModuleIdentifier(m_xFrame));
|
||
OUString sRealCommand = vcl::CommandInfoProvider::GetRealCommandForCommand(aProperties);
|
||
|
||
aTargetURL.Complete = sRealCommand.isEmpty() ? aCommandURL : sRealCommand;
|
||
if ( m_xUrlTransformer.is() )
|
||
m_xUrlTransformer->parseStrict( aTargetURL );
|
||
|
||
// Execute dispatch asynchronously
|
||
ExecuteInfo* pExecuteInfo = new ExecuteInfo;
|
||
pExecuteInfo->xDispatch = std::move(xDispatch);
|
||
pExecuteInfo->aTargetURL = std::move(aTargetURL);
|
||
// Add key modifier to argument list
|
||
pExecuteInfo->aArgs = { comphelper::makePropertyValue(u"KeyModifier"_ustr, KeyModifier) };
|
||
|
||
Application::PostUserEvent( LINK(nullptr, GenericToolbarController , ExecuteHdl_Impl), pExecuteInfo );
|
||
}
|
||
|
||
void GenericToolbarController::statusChanged( const FeatureStateEvent& Event )
|
||
{
|
||
SolarMutexGuard aSolarMutexGuard;
|
||
|
||
if ( m_bDisposed )
|
||
return;
|
||
|
||
if ( m_pToolbar )
|
||
{
|
||
m_pToolbar->set_item_sensitive(m_aCommandURL, Event.IsEnabled);
|
||
|
||
bool bValue;
|
||
OUString aStrValue;
|
||
SfxImageItem aImageItem;
|
||
|
||
if ( Event.State >>= bValue )
|
||
{
|
||
// Boolean, treat it as checked/unchecked
|
||
m_pToolbar->set_item_active(m_aCommandURL, bValue);
|
||
}
|
||
else if ( Event.State >>= aStrValue )
|
||
{
|
||
m_pToolbar->set_item_label(m_aCommandURL, aStrValue);
|
||
}
|
||
else if ( aImageItem.PutValue( Event.State, 0 ) && aImageItem.IsMirrored() != m_bMirrored )
|
||
{
|
||
m_pToolbar->set_item_image_mirrored(m_aCommandURL, aImageItem.IsMirrored());
|
||
auto xGraphic(vcl::CommandInfoProvider::GetXGraphicForCommand(m_aCommandURL, m_xFrame, m_pToolbar->get_icon_size()));
|
||
m_pToolbar->set_item_image(m_aCommandURL, xGraphic);
|
||
m_bMirrored = !m_bMirrored;
|
||
}
|
||
else
|
||
m_pToolbar->set_item_active(m_aCommandURL, false);
|
||
|
||
return;
|
||
}
|
||
|
||
if ( !m_xToolbar )
|
||
return;
|
||
|
||
m_xToolbar->EnableItem( m_nID, Event.IsEnabled );
|
||
|
||
ToolBoxItemBits nItemBits = m_xToolbar->GetItemBits( m_nID );
|
||
nItemBits &= ~ToolBoxItemBits::CHECKABLE;
|
||
TriState eTri = TRISTATE_FALSE;
|
||
|
||
bool bValue;
|
||
OUString aStrValue;
|
||
ItemStatus aItemState;
|
||
Visibility aItemVisibility;
|
||
ControlCommand aControlCommand;
|
||
SfxImageItem aImageItem;
|
||
|
||
if (( Event.State >>= bValue ) && !m_bEnumCommand )
|
||
{
|
||
// Boolean, treat it as checked/unchecked
|
||
if ( m_bMadeInvisible )
|
||
m_xToolbar->ShowItem( m_nID );
|
||
m_xToolbar->CheckItem( m_nID, bValue );
|
||
if ( bValue )
|
||
eTri = TRISTATE_TRUE;
|
||
nItemBits |= ToolBoxItemBits::CHECKABLE;
|
||
}
|
||
else if ( Event.State >>= aStrValue )
|
||
{
|
||
if ( m_bEnumCommand )
|
||
{
|
||
bValue = aStrValue == m_aEnumCommand;
|
||
|
||
m_xToolbar->CheckItem( m_nID, bValue );
|
||
if ( bValue )
|
||
eTri = TRISTATE_TRUE;
|
||
nItemBits |= ToolBoxItemBits::CHECKABLE;
|
||
}
|
||
else
|
||
{
|
||
// Replacement for place holders
|
||
if ( aStrValue.startsWith("($1)") )
|
||
{
|
||
aStrValue = FwkResId(STR_UPDATEDOC) + " " + aStrValue.subView( 4 );
|
||
}
|
||
else if ( aStrValue.startsWith("($2)") )
|
||
{
|
||
aStrValue = FwkResId(STR_CLOSEDOC_ANDRETURN) + aStrValue.subView( 4 );
|
||
}
|
||
else if ( aStrValue.startsWith("($3)") )
|
||
{
|
||
aStrValue = FwkResId(STR_SAVECOPYDOC) + aStrValue.subView( 4 );
|
||
}
|
||
m_xToolbar->SetItemText( m_nID, aStrValue );
|
||
// tdf#124267 strip mnemonic from tooltip
|
||
m_xToolbar->SetQuickHelpText(m_nID, aStrValue.replaceFirst("~", ""));
|
||
}
|
||
|
||
if ( m_bMadeInvisible )
|
||
m_xToolbar->ShowItem( m_nID );
|
||
}
|
||
else if (( Event.State >>= aItemState ) && !m_bEnumCommand )
|
||
{
|
||
eTri = TRISTATE_INDET;
|
||
nItemBits |= ToolBoxItemBits::CHECKABLE;
|
||
if ( m_bMadeInvisible )
|
||
m_xToolbar->ShowItem( m_nID );
|
||
}
|
||
else if ( Event.State >>= aItemVisibility )
|
||
{
|
||
m_xToolbar->ShowItem( m_nID, aItemVisibility.bVisible );
|
||
m_bMadeInvisible = !aItemVisibility.bVisible;
|
||
}
|
||
else if ( Event.State >>= aControlCommand )
|
||
{
|
||
if (aControlCommand.Command == "SetQuickHelpText")
|
||
{
|
||
for (NamedValue const& rArg : aControlCommand.Arguments)
|
||
{
|
||
if (rArg.Name == "HelpText")
|
||
{
|
||
OUString aHelpText;
|
||
rArg.Value >>= aHelpText;
|
||
m_xToolbar->SetQuickHelpText(m_nID, aHelpText);
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
if ( m_bMadeInvisible )
|
||
m_xToolbar->ShowItem( m_nID );
|
||
}
|
||
else if ( aImageItem.PutValue( Event.State, 0 ) && aImageItem.IsMirrored() != m_bMirrored )
|
||
{
|
||
m_xToolbar->SetItemImageMirrorMode( m_nID, aImageItem.IsMirrored() );
|
||
Image aImage( vcl::CommandInfoProvider::GetImageForCommand( m_aCommandURL, m_xFrame, m_xToolbar->GetImageSize() ));
|
||
m_xToolbar->SetItemImage( m_nID, aImage );
|
||
m_bMirrored = !m_bMirrored;
|
||
if ( m_bMadeInvisible )
|
||
m_xToolbar->ShowItem( m_nID );
|
||
}
|
||
else if ( m_bMadeInvisible )
|
||
m_xToolbar->ShowItem( m_nID );
|
||
|
||
m_xToolbar->SetItemState( m_nID, eTri );
|
||
m_xToolbar->SetItemBits( m_nID, nItemBits );
|
||
}
|
||
|
||
IMPL_STATIC_LINK( GenericToolbarController, ExecuteHdl_Impl, void*, p, void )
|
||
{
|
||
ExecuteInfo* pExecuteInfo = static_cast<ExecuteInfo*>(p);
|
||
SolarMutexReleaser aReleaser;
|
||
try
|
||
{
|
||
// Asynchronous execution as this can lead to our own destruction!
|
||
// Framework can recycle our current frame and the layout manager disposes all user interface
|
||
// elements if a component gets detached from its frame!
|
||
pExecuteInfo->xDispatch->dispatch( pExecuteInfo->aTargetURL, pExecuteInfo->aArgs );
|
||
}
|
||
catch ( const Exception& )
|
||
{
|
||
}
|
||
|
||
delete pExecuteInfo;
|
||
}
|
||
|
||
ImageOrientationController::ImageOrientationController(const Reference<XComponentContext>& rContext,
|
||
const Reference<XFrame>& rFrame,
|
||
const Reference<css::awt::XWindow>& rParentWindow,
|
||
const OUString& rModuleName)
|
||
: ToolboxController(rContext, rFrame, u".uno:ImageOrientation"_ustr)
|
||
, m_nRotationAngle(0_deg10)
|
||
, m_bMirrored(false)
|
||
{
|
||
m_sModuleName = rModuleName;
|
||
m_xParentWindow = rParentWindow;
|
||
initialize({});
|
||
if (!m_pToolbar)
|
||
VCLUnoHelper::GetWindow(getParent())->AddEventListener(LINK(this, ImageOrientationController, WindowEventListener));
|
||
}
|
||
|
||
void ImageOrientationController::disposing(std::unique_lock<std::mutex>& rGuard)
|
||
{
|
||
ToolboxController::disposing(rGuard);
|
||
VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow(getParent());
|
||
if (pWindow)
|
||
pWindow->RemoveEventListener(LINK(this, ImageOrientationController, WindowEventListener));
|
||
}
|
||
|
||
IMPL_LINK(ImageOrientationController, WindowEventListener, VclWindowEvent&, rWindowEvent, void)
|
||
{
|
||
if (m_bDisposed || rWindowEvent.GetId() != VclEventId::ToolboxItemAdded)
|
||
return;
|
||
|
||
ToolBox* pToolBox = static_cast<ToolBox*>(rWindowEvent.GetWindow());
|
||
ToolBoxItemId nItemId = pToolBox->GetItemId(reinterpret_cast<sal_IntPtr>(rWindowEvent.GetData()));
|
||
OUString aCommand = pToolBox->GetItemCommand(nItemId);
|
||
|
||
if (vcl::CommandInfoProvider::IsMirrored(aCommand, getModuleName()))
|
||
pToolBox->SetItemImageMirrorMode(nItemId, m_bMirrored);
|
||
if (vcl::CommandInfoProvider::IsRotated(aCommand, getModuleName()))
|
||
pToolBox->SetItemImageAngle(nItemId, m_nRotationAngle);
|
||
}
|
||
|
||
void ImageOrientationController::statusChanged(const css::frame::FeatureStateEvent& rEvent)
|
||
{
|
||
if (m_bDisposed)
|
||
throw DisposedException();
|
||
|
||
SfxImageItem aItem;
|
||
aItem.PutValue(rEvent.State, 0);
|
||
|
||
if (m_bMirrored == aItem.IsMirrored() && m_nRotationAngle == aItem.GetRotation())
|
||
return;
|
||
|
||
m_bMirrored = aItem.IsMirrored();
|
||
m_nRotationAngle = aItem.GetRotation();
|
||
|
||
if (m_pToolbar)
|
||
{
|
||
for (int i = 0, nCount = m_pToolbar->get_n_items(); i < nCount; ++i)
|
||
{
|
||
OUString aCommand = m_pToolbar->get_item_ident(i);
|
||
if (vcl::CommandInfoProvider::IsMirrored(aCommand, getModuleName()))
|
||
{
|
||
if (m_bMirrored)
|
||
{
|
||
// Search for a specialized mirrored graphic
|
||
auto xRltbGraphic = vcl::CommandInfoProvider::GetXGraphicForCommand(
|
||
aCommand, m_xFrame, m_pToolbar->get_icon_size(),
|
||
vcl::ImageWritingDirection::RightLeftTopBottom);
|
||
if (xRltbGraphic)
|
||
{
|
||
m_pToolbar->set_item_image_mirrored(aCommand, false);
|
||
m_pToolbar->set_item_image(aCommand, xRltbGraphic);
|
||
continue;
|
||
}
|
||
}
|
||
|
||
m_pToolbar->set_item_image_mirrored(aCommand, m_bMirrored);
|
||
auto xGraphic(vcl::CommandInfoProvider::GetXGraphicForCommand(
|
||
aCommand, m_xFrame, m_pToolbar->get_icon_size()));
|
||
m_pToolbar->set_item_image(aCommand, xGraphic);
|
||
}
|
||
}
|
||
}
|
||
else
|
||
{
|
||
ToolBox* pToolBox = static_cast<ToolBox*>(VCLUnoHelper::GetWindow(getParent()));
|
||
for (ToolBox::ImplToolItems::size_type i = 0; i < pToolBox->GetItemCount(); ++i)
|
||
{
|
||
ToolBoxItemId nItemId = pToolBox->GetItemId(i);
|
||
OUString aCommand = pToolBox->GetItemCommand(nItemId);
|
||
|
||
bool bCmdMirrored = vcl::CommandInfoProvider::IsMirrored(aCommand, getModuleName());
|
||
if (bCmdMirrored && m_bMirrored)
|
||
{
|
||
// Search for a specialized mirrored graphic
|
||
auto xRltbGraphic = vcl::CommandInfoProvider::GetXGraphicForCommand(
|
||
aCommand, m_xFrame, pToolBox->GetImageSize(),
|
||
vcl::ImageWritingDirection::RightLeftTopBottom);
|
||
if (xRltbGraphic)
|
||
{
|
||
pToolBox->SetItemImageMirrorMode(nItemId, false);
|
||
pToolBox->SetItemImageAngle(nItemId, m_nRotationAngle);
|
||
pToolBox->SetItemImage(nItemId, Image{ xRltbGraphic });
|
||
continue;
|
||
}
|
||
}
|
||
|
||
bool bModified = false;
|
||
if (bCmdMirrored)
|
||
{
|
||
pToolBox->SetItemImageMirrorMode(nItemId, m_bMirrored);
|
||
bModified = true;
|
||
}
|
||
if (vcl::CommandInfoProvider::IsRotated(aCommand, getModuleName()))
|
||
{
|
||
pToolBox->SetItemImageAngle(nItemId, m_nRotationAngle);
|
||
bModified = true;
|
||
}
|
||
if (bModified)
|
||
{
|
||
Image aImage(vcl::CommandInfoProvider::GetImageForCommand(aCommand, m_xFrame, pToolBox->GetImageSize()));
|
||
pToolBox->SetItemImage(nItemId, aImage);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
} // namespace
|
||
|
||
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|