/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_framework.hxx"
#ifndef __FRAMEWORK_UIELEMENT_GENERICTOOLBARCONTROLLER_HXX
#include "uielement/generictoolbarcontroller.hxx"
#endif
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#ifndef __FRAMEWORK_TOOLBAR_HXX_
#include "uielement/toolbar.hxx"
#endif
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/util/XURLTransformer.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/frame/status/ItemStatus.hpp>
#include <com/sun/star/frame/status/ItemState.hpp>
#include <com/sun/star/frame/status/Visibility.hpp>
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#include <svtools/toolboxcontroller.hxx>
#include <vos/mutex.hxx>
#include <vcl/svapp.hxx>
#ifndef _VCL_MNEMONIC_HXX_
#include <vcl/mnemonic.hxx>
#endif
#include <tools/urlobj.hxx>
#include <classes/resource.hrc>
#include <classes/fwkresid.hxx>
#include <dispatch/uieventloghelper.hxx>
#include <framework/menuconfiguration.hxx>
#include <uielement/menubarmanager.hxx>
using namespace ::com::sun::star::awt;
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;
using namespace ::com::sun::star::util;
using namespace ::com::sun::star::container;
namespace framework
{
static sal_Bool isEnumCommand( const rtl::OUString& rCommand )
{
INetURLObject aURL( rCommand );
if (( aURL.GetProtocol() == INET_PROT_UNO ) &&
( aURL.GetURLPath().indexOf( '.' ) != -1))
return sal_True;
return sal_False;
}
static rtl::OUString getEnumCommand( const rtl::OUString& rCommand )
{
INetURLObject aURL( rCommand );
rtl::OUString aEnumCommand;
String aURLPath = aURL.GetURLPath();
xub_StrLen nIndex = aURLPath.Search( '.' );
if (( nIndex > 0 ) && ( nIndex < aURLPath.Len() ))
aEnumCommand = aURLPath.Copy( nIndex+1 );
return aEnumCommand;
}
static rtl::OUString getMasterCommand( const rtl::OUString& rCommand )
{
rtl::OUString aMasterCommand( rCommand );
INetURLObject aURL( rCommand );
if ( aURL.GetProtocol() == INET_PROT_UNO )
{
sal_Int32 nIndex = aURL.GetURLPath().indexOf( '.' );
if ( nIndex )
{
aURL.SetURLPath( aURL.GetURLPath().copy( 0, nIndex ) );
aMasterCommand = aURL.GetMainURL( INetURLObject::NO_DECODE );
}
}
return aMasterCommand;
}
struct ExecuteInfo
{
::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatch > xDispatch;
::com::sun::star::util::URL aTargetURL;
::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > aArgs;
};
GenericToolbarController::GenericToolbarController( const Reference< XMultiServiceFactory >& rServiceManager,
const Reference< XFrame >& rFrame,
ToolBox* pToolbar,
sal_uInt16 nID,
const ::rtl::OUString& aCommand ) :
svt::ToolboxController( rServiceManager, rFrame, aCommand )
, m_pToolbar( pToolbar )
, m_nID( nID )
, m_bEnumCommand( isEnumCommand( aCommand ))
, m_bMadeInvisible( sal_False )
, m_aEnumCommand( getEnumCommand( aCommand ))
{
if ( m_bEnumCommand )
addStatusListener( getMasterCommand( aCommand ) );
}
GenericToolbarController::~GenericToolbarController()
{
}
void SAL_CALL GenericToolbarController::dispose()
throw ( RuntimeException )
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
svt::ToolboxController::dispose();
m_pToolbar = 0;
m_nID = 0;
}
void SAL_CALL GenericToolbarController::execute( sal_Int16 KeyModifier )
throw ( RuntimeException )
{
Reference< XDispatch > xDispatch;
Reference< XURLTransformer > xURLTransformer;
::rtl::OUString aCommandURL;
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
throw DisposedException();
if ( m_bInitialized &&
m_xFrame.is() &&
m_xServiceManager.is() &&
m_aCommandURL.getLength() )
{
xURLTransformer = Reference< XURLTransformer >( m_xServiceManager->createInstance(
rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))),
UNO_QUERY );
aCommandURL = m_aCommandURL;
URLToDispatchMap::iterator pIter = m_aListenerMap.find( m_aCommandURL );
if ( pIter != m_aListenerMap.end() )
xDispatch = pIter->second;
}
}
if ( xDispatch.is() && xURLTransformer.is() )
{
com::sun::star::util::URL aTargetURL;
Sequence<PropertyValue> aArgs( 1 );
// Add key modifier to argument list
aArgs[0].Name = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "KeyModifier" ));
aArgs[0].Value <<= KeyModifier;
aTargetURL.Complete = aCommandURL;
xURLTransformer->parseStrict( aTargetURL );
// Execute dispatch asynchronously
ExecuteInfo* pExecuteInfo = new ExecuteInfo;
pExecuteInfo->xDispatch = xDispatch;
pExecuteInfo->aTargetURL = aTargetURL;
pExecuteInfo->aArgs = aArgs;
if(::comphelper::UiEventsLogger::isEnabled()) //#i88653#
UiEventLogHelper(::rtl::OUString::createFromAscii("GenericToolbarController")).log( m_xServiceManager, m_xFrame, aTargetURL, aArgs);
Application::PostUserEvent( STATIC_LINK(0, GenericToolbarController , ExecuteHdl_Impl), pExecuteInfo );
}
}
void GenericToolbarController::statusChanged( const FeatureStateEvent& Event )
throw ( RuntimeException )
{
vos::OGuard aSolarMutexGuard( Application::GetSolarMutex() );
if ( m_bDisposed )
return;
if ( m_pToolbar )
{
m_pToolbar->EnableItem( m_nID, Event.IsEnabled );
sal_uInt16 nItemBits = m_pToolbar->GetItemBits( m_nID );
nItemBits &= ~TIB_CHECKABLE;
TriState eTri = STATE_NOCHECK;
sal_Bool bValue = sal_Bool();
rtl::OUString aStrValue;
ItemStatus aItemState;
Visibility aItemVisibility;
if (( Event.State >>= bValue ) && !m_bEnumCommand )
{
// Boolean, treat it as checked/unchecked
if ( m_bMadeInvisible )
m_pToolbar->ShowItem( m_nID, sal_True );
m_pToolbar->CheckItem( m_nID, bValue );
if ( bValue )
eTri = STATE_CHECK;
nItemBits |= TIB_CHECKABLE;
}
else if ( Event.State >>= aStrValue )
{
if ( m_bEnumCommand )
{
if ( aStrValue == m_aEnumCommand )
bValue = sal_True;
else
bValue = sal_False;
m_pToolbar->CheckItem( m_nID, bValue );
if ( bValue )
eTri = STATE_CHECK;
nItemBits |= TIB_CHECKABLE;
}
else
{
// Replacement for place holders
if ( aStrValue.matchAsciiL( "($1)", 4 ))
{
String aResStr = String( FwkResId( STR_UPDATEDOC ));
rtl::OUString aTmp( aResStr );
aTmp += rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( " " ));
aTmp += aStrValue.copy( 4 );
aStrValue = aTmp;
}
else if ( aStrValue.matchAsciiL( "($2)", 4 ))
{
String aResStr = String( FwkResId( STR_CLOSEDOC_ANDRETURN ));
rtl::OUString aTmp( aResStr );
aTmp += aStrValue.copy( 4 );
aStrValue = aTmp;
}
else if ( aStrValue.matchAsciiL( "($3)", 4 ))
{
String aResStr = String( FwkResId( STR_SAVECOPYDOC ));
rtl::OUString aTmp( aResStr );
aTmp += aStrValue.copy( 4 );
aStrValue = aTmp;
}
::rtl::OUString aText( MnemonicGenerator::EraseAllMnemonicChars( aStrValue ) );
m_pToolbar->SetItemText( m_nID, aText );
m_pToolbar->SetQuickHelpText( m_nID, aText );
}
if ( m_bMadeInvisible )
m_pToolbar->ShowItem( m_nID, sal_True );
}
else if (( Event.State >>= aItemState ) && !m_bEnumCommand )
{
eTri = STATE_DONTKNOW;
nItemBits |= TIB_CHECKABLE;
if ( m_bMadeInvisible )
m_pToolbar->ShowItem( m_nID, sal_True );
}
else if ( Event.State >>= aItemVisibility )
{
m_pToolbar->ShowItem( m_nID, aItemVisibility.bVisible );
m_bMadeInvisible = !aItemVisibility.bVisible;
}
else if ( m_bMadeInvisible )
m_pToolbar->ShowItem( m_nID, sal_True );
m_pToolbar->SetItemState( m_nID, eTri );
m_pToolbar->SetItemBits( m_nID, nItemBits );
}
}
IMPL_STATIC_LINK_NOINSTANCE( GenericToolbarController, ExecuteHdl_Impl, ExecuteInfo*, pExecuteInfo )
{
const sal_uInt32 nRef = Application::ReleaseSolarMutex();
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 ( Exception& )
{
}
Application::AcquireSolarMutex( nRef );
delete pExecuteInfo;
return 0;
}
MenuToolbarController::MenuToolbarController( const Reference< XMultiServiceFactory >& rServiceManager, const Reference< XFrame >& rFrame, ToolBox* pToolBar, sal_uInt16 nID, const rtl::OUString& aCommand, const rtl::OUString& aModuleIdentifier, const Reference< XIndexAccess >& xMenuDesc ) : GenericToolbarController( rServiceManager, rFrame, pToolBar, nID, aCommand ), m_xMenuDesc( xMenuDesc ), pMenu( NULL ), m_aModuleIdentifier( aModuleIdentifier )
{
}
MenuToolbarController::~MenuToolbarController()
{
try
{
if ( m_xMenuManager.is() )
m_xMenuManager->dispose();
}
catch( Exception& ) {}
if ( pMenu )
{
delete pMenu;
pMenu = NULL;
}
}
class Toolbarmenu : public PopupMenu
{
public:
Toolbarmenu();
~Toolbarmenu();
};
Toolbarmenu::Toolbarmenu()
{
OSL_TRACE("**** contstructing Toolbarmenu 0x%x", this );
}
Toolbarmenu::~Toolbarmenu()
{
OSL_TRACE("**** destructing Toolbarmenu 0x%x", this );
}
void SAL_CALL MenuToolbarController::click() throw (RuntimeException)
{
createPopupWindow();
}
Reference< XWindow > SAL_CALL
MenuToolbarController::createPopupWindow() throw (::com::sun::star::uno::RuntimeException)
{
if ( !pMenu )
{
Reference< XDispatchProvider > xDispatch;
Reference< XURLTransformer > xURLTransformer( m_xServiceManager->createInstance( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.util.URLTransformer" ))), UNO_QUERY );
pMenu = new Toolbarmenu();
m_xMenuManager.set( new MenuBarManager( m_xServiceManager, m_xFrame, xURLTransformer, xDispatch, m_aModuleIdentifier, pMenu, sal_True, sal_True ) );
if ( m_xMenuManager.is() )
{
MenuBarManager* pMgr = dynamic_cast< MenuBarManager* >( m_xMenuManager.get() );
pMgr->SetItemContainer( m_xMenuDesc );
}
}
if ( !pMenu || !m_pToolbar )
return NULL;
OSL_ENSURE ( pMenu->GetItemCount(), "Empty PopupMenu!" );
::Rectangle aRect( m_pToolbar->GetItemRect( m_nID ) );
pMenu->Execute( m_pToolbar, aRect, POPUPMENU_EXECUTE_DOWN );
return NULL;
}
} // namespace