2001-01-25 23:25:24 -06:00
/*************************************************************************
*
2005-09-08 18:29:02 -05:00
* OpenOffice . org - a multi - platform office productivity suite
2001-01-25 23:25:24 -06:00
*
2005-09-08 18:29:02 -05:00
* $ RCSfile : desktop . hxx , v $
2001-01-25 23:25:24 -06:00
*
2008-04-04 08:10:08 -05:00
* $ Revision : 1.24 $
2001-01-25 23:25:24 -06:00
*
2008-04-04 08:10:08 -05:00
* last change : $ Author : kz $ $ Date : 2008 - 04 - 04 14 : 10 : 08 $
2001-01-25 23:25:24 -06:00
*
2005-09-08 18:29:02 -05:00
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1 .
2001-01-25 23:25:24 -06:00
*
*
2005-09-08 18:29:02 -05:00
* GNU Lesser General Public License Version 2.1
* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
* Copyright 2005 by Sun Microsystems , Inc .
* 901 San Antonio Road , Palo Alto , CA 94303 , USA
2001-01-25 23:25:24 -06:00
*
2005-09-08 18:29:02 -05:00
* This library is free software ; you can redistribute it and / or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1 , as published by the Free Software Foundation .
2001-01-25 23:25:24 -06:00
*
2005-09-08 18:29:02 -05:00
* This library 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 for more details .
2001-01-25 23:25:24 -06:00
*
2005-09-08 18:29:02 -05:00
* You should have received a copy of the GNU Lesser General Public
* License along with this library ; if not , write to the Free Software
* Foundation , Inc . , 59 Temple Place , Suite 330 , Boston ,
* MA 02111 - 1307 USA
2001-01-25 23:25:24 -06:00
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2001-01-26 01:39:47 -06:00
# ifndef __FRAMEWORK_SERVICES_DESKTOP_HXX_
# define __FRAMEWORK_SERVICES_DESKTOP_HXX_
2001-01-25 23:25:24 -06:00
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
# ifndef __FRAMEWORK_CLASSES_FRAMECONTAINER_HXX_
# include <classes/framecontainer.hxx>
# endif
2001-06-11 04:29:50 -05:00
# ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
# include <threadhelp/threadhelpbase.hxx>
2001-01-25 23:25:24 -06:00
# endif
# ifndef __FRAMEWORK_HELPER_OFRAMES_HXX_
# include <helper/oframes.hxx>
# endif
# ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
# include <macros/generic.hxx>
# endif
# ifndef __FRAMEWORK_MACROS_DEBUG_HXX_
# include <macros/debug.hxx>
# endif
# ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_
# include <macros/xinterface.hxx>
# endif
# ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_
# include <macros/xtypeprovider.hxx>
# endif
# ifndef __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
# include <macros/xserviceinfo.hxx>
# endif
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
2008-04-04 08:10:08 -05:00
# ifndef _COM_SUN_STAR_FRAME_XUNTITLEDNUMBERS_HPP_
# include <com/sun/star/frame/XUntitledNumbers.hpp>
# endif
2001-01-25 23:25:24 -06:00
# ifndef _COM_SUN_STAR_FRAME_XCONTROLLER_HPP_
# include <com/sun/star/frame/XController.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XDESKTOP_HPP_
# include <com/sun/star/frame/XDesktop.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_WINDOWARRANGE_HPP_
# include <com/sun/star/frame/WindowArrange.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_TERMINATIONVETOEXCEPTION_HPP_
# include <com/sun/star/frame/TerminationVetoException.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XTERMINATELISTENER_HPP_
# include <com/sun/star/frame/XTerminateListener.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XWINDOWARRANGER_HPP_
# include <com/sun/star/frame/XWindowArranger.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XTASK_HPP_
# include <com/sun/star/frame/XTask.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XSTORABLE_HPP_
# include <com/sun/star/frame/XStorable.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XMODEL_HPP_
# include <com/sun/star/frame/XModel.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XFRAMESSUPPLIER_HPP_
# include <com/sun/star/frame/XFramesSupplier.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XFRAMES_HPP_
# include <com/sun/star/frame/XFrames.hpp>
# endif
# ifndef _COM_SUN_STAR_LANG_XSERVICENAME_HPP_
# include <com/sun/star/lang/XServiceName.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XDISPATCHPROVIDER_HPP_
# include <com/sun/star/frame/XDispatchProvider.hpp>
# endif
2004-03-02 06:30:35 -06:00
# ifndef _COM_SUN_STAR_FRAME_XDISPATCHPROVIDERINTERCEPTION_HPP_
# include <com/sun/star/frame/XDispatchProviderInterception.hpp>
# endif
2001-01-25 23:25:24 -06:00
# ifndef _COM_SUN_STAR_FRAME_XCOMPONENTLOADER_HPP_
# include <com/sun/star/frame/XComponentLoader.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_FRAMEACTION_HPP_
# include <com/sun/star/frame/FrameAction.hpp>
# endif
# ifndef _COM_SUN_STAR_TASK_XSTATUSINDICATORFACTORY_HPP_
# include <com/sun/star/task/XStatusIndicatorFactory.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_XTASKSSUPPLIER_HPP_
# include <com/sun/star/frame/XTasksSupplier.hpp>
# endif
# ifndef _COM_SUN_STAR_CONTAINER_XENUMERATIONACCESS_HPP_
# include <com/sun/star/container/XEnumerationAccess.hpp>
# endif
# ifndef _COM_SUN_STAR_LANG_LOCALE_HPP_
# include <com/sun/star/lang/Locale.hpp>
# endif
2001-11-21 07:58:14 -06:00
# ifndef _COM_SUN_STAR_FRAME_XDISPATCHRESULTLISTENER_HPP_
# include <com/sun/star/frame/XDispatchResultListener.hpp>
2001-01-25 23:25:24 -06:00
# endif
# ifndef _COM_SUN_STAR_LANG_XEVENTLISTENER_HPP_
# include <com/sun/star/lang/XEventListener.hpp>
# endif
# ifndef _COM_SUN_STAR_FRAME_FEATURESTATEEVENT_HPP_
# include <com/sun/star/frame/FeatureStateEvent.hpp>
# endif
2001-11-13 07:07:52 -06:00
# ifndef _COM_SUN_STAR_TASK_XINTERACTIONHANDLER_HPP_
# include <com/sun/star/task/XInteractionHandler.hpp>
# endif
2003-03-25 11:22:13 -06:00
# ifndef _COM_SUN_STAR_FRAME_XDISPATCHRECORDERSUPPLIER_HPP_
# include <com/sun/star/frame/XDispatchRecorderSupplier.hpp>
# endif
2001-01-25 23:25:24 -06:00
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
2002-04-22 01:05:16 -05:00
# ifndef INCLUDED_SVTOOLS_CMDOPTIONS_HXX
# include <svtools/cmdoptions.hxx>
# endif
2001-01-25 23:25:24 -06:00
# ifndef _CPPUHELPER_PROPSHLP_HXX
# include <cppuhelper/propshlp.hxx>
# endif
# ifndef _CPPUHELPER_INTERFACECONTAINER_HXX_
# include <cppuhelper/interfacecontainer.hxx>
# endif
# ifndef _CPPUHELPER_WEAK_HXX_
# include <cppuhelper/weak.hxx>
# endif
2008-04-04 08:10:08 -05:00
# include <comphelper/numberedcollection.hxx>
2001-01-25 23:25:24 -06:00
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework {
//_________________________________________________________________________________________________________________
// exported const
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// exported definitions
//_________________________________________________________________________________________________________________
2001-07-04 07:29:56 -05:00
enum ELoadState
2001-01-25 23:25:24 -06:00
{
2001-07-04 07:29:56 -05:00
E_NOTSET ,
E_SUCCESSFUL ,
2001-11-13 07:07:52 -06:00
E_FAILED ,
E_INTERACTION
2001-01-25 23:25:24 -06:00
} ;
/*-************************************************************************************************************/ /**
@ short implement the topframe of frame tree
@ descr This is the root of the frame tree . The desktop has no window , is not visible but he is the logical
" masternode " to build the hierarchy .
@ implements XInterface
XTypeProvider
XServiceInfo
XDesktop
XComponentLoader
XTasksSupplier
XDispatchProvider
XFramesSupplier
XFrame
XComponent
XPropertySet
XFastPropertySet
XMultiPropertySet
2001-11-21 07:58:14 -06:00
XDispatchResultListener
2001-01-25 23:25:24 -06:00
XEventListener
2001-11-13 07:07:52 -06:00
XInteractionHandler
2001-07-04 07:29:56 -05:00
2001-06-11 04:29:50 -05:00
@ base ThreadHelpBase
2001-07-04 07:29:56 -05:00
TransactionBase
2001-01-25 23:25:24 -06:00
OBroadcastHelper
OPropertySetHelper
2001-07-04 07:29:56 -05:00
@ devstatus ready to use
@ threadsafe yes
2001-01-25 23:25:24 -06:00
*/ /*-*************************************************************************************************************/
2001-07-04 07:29:56 -05:00
class Desktop : // interfaces
public css : : lang : : XTypeProvider ,
public css : : lang : : XServiceInfo ,
public css : : frame : : XDesktop ,
public css : : frame : : XComponentLoader ,
public css : : frame : : XTasksSupplier ,
public css : : frame : : XDispatchProvider ,
2004-03-02 06:30:35 -06:00
public css : : frame : : XDispatchProviderInterception ,
2001-07-04 07:29:56 -05:00
public css : : frame : : XFramesSupplier , // => XFrame => XComponent
2001-11-21 07:58:14 -06:00
public css : : frame : : XDispatchResultListener , // => XEventListener
2001-11-13 07:07:52 -06:00
public css : : task : : XInteractionHandler ,
2008-04-04 08:10:08 -05:00
public css : : frame : : XUntitledNumbers ,
2001-07-04 07:29:56 -05:00
// base classes
// Order is neccessary for right initialization!
private ThreadHelpBase ,
private TransactionBase ,
public : : cppu : : OBroadcastHelper ,
public : : cppu : : OPropertySetHelper ,
public : : cppu : : OWeakObject
2001-01-25 23:25:24 -06:00
{
2007-07-18 07:25:25 -05:00
// internal used types, const etcpp.
private :
//---------------------------------------------------------------------
/** used temporary to know which listener was already called or not. */
typedef : : std : : vector < css : : uno : : Reference < css : : frame : : XTerminateListener > > TTerminateListenerList ;
// public methods
2001-01-25 23:25:24 -06:00
public :
// constructor / destructor
2001-07-04 07:29:56 -05:00
Desktop ( const css : : uno : : Reference < css : : lang : : XMultiServiceFactory > & xFactory ) ;
virtual ~ Desktop ( ) ;
2001-01-25 23:25:24 -06:00
2001-07-04 07:29:56 -05:00
// XInterface, XTypeProvider, XServiceInfo
2006-06-19 04:58:30 -05:00
FWK_DECLARE_XINTERFACE
FWK_DECLARE_XTYPEPROVIDER
2001-01-25 23:25:24 -06:00
DECLARE_XSERVICEINFO
2007-07-18 07:25:25 -05:00
//---------------------------------------------------------------------
/**
@ interface XDesktop
@ short try to shutdown these desktop environment .
@ descr Will try to close all frames . If at least one frame could
not be closed successfully termination will be stopped .
Registered termination listener will be taken into account
also . As special feature some of our registered listener
are well known by it ' s UNO implementation name . They are handled
different to all other listener .
Btw : Desktop . terminate ( ) was designed in the past to be used
within an UI based envrionment . So it ' s allowed e . g . to
call XController . suspend ( ) here . If UI isnt an option . . . please
use XCloseable . close ( ) at these desktop implementation .
. . . if it will be supported in the future . - ) )
@ seealso XTerminateListener
@ seealso XTerminateListener2
@ return true if all open frames could be closed and no listener throwed
a veto exception ; false otherwise .
@ onerror False will be returned .
@ threadsafe yes
*/
virtual : : sal_Bool SAL_CALL terminate ( )
throw ( css : : uno : : RuntimeException ) ;
//---------------------------------------------------------------------
/**
@ interface XDesktop
@ short add a listener for termination events
@ descr Additional to adding normal listener these method was implemented special .
Every listener will be asked for it ' s uno implementation name .
Some of them are well known . . . and the corresponding listener wont be added
to the container of " normal listener " . Those listener will be set as special
member .
see e . g . member m_xSfxTerminator
@ seealso terminate ( )
@ param xListener
the listener for registration .
@ threadsafe yes
*/
virtual void SAL_CALL addTerminateListener ( const css : : uno : : Reference < css : : frame : : XTerminateListener > & xListener )
throw ( css : : uno : : RuntimeException ) ;
//---------------------------------------------------------------------
/**
@ interface XDesktop
@ short remove a listener from this container .
@ descr Additional to removing normal listener these method was implemented special .
Every listener will be asked for it ' s uno implementation name .
Some of them are well known . . . and the corresponding listener was set as special member .
Now those special member will be reseted also .
see e . g . member m_xSfxTerminator
@ seealso terminate ( )
@ param xListener
the listener for deregistration .
@ threadsafe yes
*/
virtual void SAL_CALL removeTerminateListener ( const css : : uno : : Reference < css : : frame : : XTerminateListener > & xListener )
throw ( css : : uno : : RuntimeException ) ;
2001-07-04 07:29:56 -05:00
virtual css : : uno : : Reference < css : : container : : XEnumerationAccess > SAL_CALL getComponents ( ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Reference < css : : lang : : XComponent > SAL_CALL getCurrentComponent ( ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Reference < css : : frame : : XFrame > SAL_CALL getCurrentFrame ( ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
// XComponentLoader
2001-07-04 07:29:56 -05:00
virtual css : : uno : : Reference < css : : lang : : XComponent > SAL_CALL loadComponentFromURL ( const : : rtl : : OUString & sURL ,
const : : rtl : : OUString & sTargetFrameName ,
sal_Int32 nSearchFlags ,
const css : : uno : : Sequence < css : : beans : : PropertyValue > & lArguments ) throw ( css : : io : : IOException ,
css : : lang : : IllegalArgumentException ,
css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
// XTasksSupplier
2001-07-04 07:29:56 -05:00
virtual css : : uno : : Reference < css : : container : : XEnumerationAccess > SAL_CALL getTasks ( ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Reference < css : : frame : : XTask > SAL_CALL getActiveTask ( ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
// XDispatchProvider
2001-07-04 07:29:56 -05:00
virtual css : : uno : : Reference < css : : frame : : XDispatch > SAL_CALL queryDispatch ( const css : : util : : URL & aURL ,
const : : rtl : : OUString & sTargetFrameName ,
sal_Int32 nSearchFlags ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Sequence < css : : uno : : Reference < css : : frame : : XDispatch > > SAL_CALL queryDispatches ( const css : : uno : : Sequence < css : : frame : : DispatchDescriptor > & lQueries ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
2004-03-02 06:30:35 -06:00
// XDispatchProviderInterception
virtual void SAL_CALL registerDispatchProviderInterceptor ( const css : : uno : : Reference < css : : frame : : XDispatchProviderInterceptor > & xInterceptor ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL releaseDispatchProviderInterceptor ( const css : : uno : : Reference < css : : frame : : XDispatchProviderInterceptor > & xInterceptor ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
// XFramesSupplier
2001-07-04 07:29:56 -05:00
virtual css : : uno : : Reference < css : : frame : : XFrames > SAL_CALL getFrames ( ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Reference < css : : frame : : XFrame > SAL_CALL getActiveFrame ( ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL setActiveFrame ( const css : : uno : : Reference < css : : frame : : XFrame > & xFrame ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
// XFrame
2001-07-04 07:29:56 -05:00
// Attention: findFrame() is implemented only! Other methods make no sense for our desktop!
virtual css : : uno : : Reference < css : : frame : : XFrame > SAL_CALL findFrame ( const : : rtl : : OUString & sTargetFrameName ,
sal_Int32 nSearchFlags ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL initialize ( const css : : uno : : Reference < css : : awt : : XWindow > & xWindow ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Reference < css : : awt : : XWindow > SAL_CALL getContainerWindow ( ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL setCreator ( const css : : uno : : Reference < css : : frame : : XFramesSupplier > & xCreator ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Reference < css : : frame : : XFramesSupplier > SAL_CALL getCreator ( ) throw ( css : : uno : : RuntimeException ) ;
virtual : : rtl : : OUString SAL_CALL getName ( ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL setName ( const : : rtl : : OUString & sName ) throw ( css : : uno : : RuntimeException ) ;
virtual sal_Bool SAL_CALL isTop ( ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL activate ( ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL deactivate ( ) throw ( css : : uno : : RuntimeException ) ;
virtual sal_Bool SAL_CALL isActive ( ) throw ( css : : uno : : RuntimeException ) ;
virtual sal_Bool SAL_CALL setComponent ( const css : : uno : : Reference < css : : awt : : XWindow > & xComponentWindow ,
const css : : uno : : Reference < css : : frame : : XController > & xController ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Reference < css : : awt : : XWindow > SAL_CALL getComponentWindow ( ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Reference < css : : frame : : XController > SAL_CALL getController ( ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL contextChanged ( ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL addFrameActionListener ( const css : : uno : : Reference < css : : frame : : XFrameActionListener > & xListener ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL removeFrameActionListener ( const css : : uno : : Reference < css : : frame : : XFrameActionListener > & xListener ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
// XComponent
2006-06-19 04:58:30 -05:00
using cppu : : OPropertySetHelper : : disposing ;
2001-07-04 07:29:56 -05:00
virtual void SAL_CALL dispose ( ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL addEventListener ( const css : : uno : : Reference < css : : lang : : XEventListener > & xListener ) throw ( css : : uno : : RuntimeException ) ;
virtual void SAL_CALL removeEventListener ( const css : : uno : : Reference < css : : lang : : XEventListener > & xListener ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
2001-11-21 07:58:14 -06:00
// XDispatchResultListener
virtual void SAL_CALL dispatchFinished ( const css : : frame : : DispatchResultEvent & aEvent ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
// XEventListener
2001-07-04 07:29:56 -05:00
virtual void SAL_CALL disposing ( const css : : lang : : EventObject & aSource ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
2001-11-13 07:07:52 -06:00
// XInteractionHandler
virtual void SAL_CALL handle ( const css : : uno : : Reference < css : : task : : XInteractionRequest > & xRequest ) throw ( css : : uno : : RuntimeException ) ;
2008-04-04 08:10:08 -05:00
// css.frame.XUntitledNumbers
virtual : : sal_Int32 SAL_CALL leaseNumber ( const css : : uno : : Reference < css : : uno : : XInterface > & xComponent )
throw ( css : : lang : : IllegalArgumentException ,
css : : uno : : RuntimeException ) ;
// css.frame.XUntitledNumbers
virtual void SAL_CALL releaseNumber ( : : sal_Int32 nNumber )
throw ( css : : lang : : IllegalArgumentException ,
css : : uno : : RuntimeException ) ;
// css.frame.XUntitledNumbers
virtual void SAL_CALL releaseNumberForComponent ( const css : : uno : : Reference < css : : uno : : XInterface > & xComponent )
throw ( css : : lang : : IllegalArgumentException ,
css : : uno : : RuntimeException ) ;
// css.frame.XUntitledNumbers
virtual : : rtl : : OUString SAL_CALL getUntitledPrefix ( )
throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
//-------------------------------------------------------------------------------------------------------------
// protected methods
//-------------------------------------------------------------------------------------------------------------
protected :
// OPropertySetHelper
2001-07-04 07:29:56 -05:00
virtual sal_Bool SAL_CALL convertFastPropertyValue ( css : : uno : : Any & aConvertedValue ,
css : : uno : : Any & aOldValue ,
sal_Int32 nHandle ,
const css : : uno : : Any & aValue ) throw ( css : : lang : : IllegalArgumentException ) ;
virtual void SAL_CALL setFastPropertyValue_NoBroadcast ( sal_Int32 nHandle ,
const css : : uno : : Any & aValue ) throw ( css : : uno : : Exception ) ;
2006-06-19 04:58:30 -05:00
using cppu : : OPropertySetHelper : : getFastPropertyValue ;
2001-07-04 07:29:56 -05:00
virtual void SAL_CALL getFastPropertyValue ( css : : uno : : Any & aValue ,
sal_Int32 nHandle ) const ;
virtual : : cppu : : IPropertyArrayHelper & SAL_CALL getInfoHelper ( ) ;
2008-04-04 08:10:08 -05:00
virtual css : : uno : : Reference < css : : beans : : XPropertySetInfo > SAL_CALL getPropertySetInfo ( ) throw ( css : : uno : : RuntimeException ) ;
2001-01-25 23:25:24 -06:00
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private :
2001-07-04 07:29:56 -05:00
css : : uno : : Reference < css : : lang : : XComponent > impl_getFrameComponent ( const css : : uno : : Reference < css : : frame : : XFrame > & xFrame ) const ;
static const css : : uno : : Sequence < css : : beans : : Property > impl_getStaticPropertyDescriptor ( ) ;
2007-07-18 07:25:25 -05:00
//---------------------------------------------------------------------
/** calls queryTermination() on every registered termination listener.
*
* Note : Only normal termination listener ( registered in list m_aListenerContainer
* will be recognized here . Special listener like quick starter , pipe or others
* has to be handled explicitly !
*
* @ param [ out ] lCalledListener
* every called listener will be returned here .
* Those list will be used to informa all called listener
* about cancel this termination request .
*
* @ param [ out ] bVeto
* will be true if at least one listener throwed a veto exception ;
* false otherwise .
*
* @ see impl_sendCancelTerminationEvent ( )
*/
void impl_sendQueryTerminationEvent ( TTerminateListenerList & lCalledListener ,
: : sal_Bool & bVeto ) ;
//---------------------------------------------------------------------
/** calls cancelTermination() on every termination listener
* where queryTermination ( ) was called before .
*
* Note : Only normal termination listener ( registered in list m_aListenerContainer
* will be recognized here . Special listener like quick starter , pipe or others
* has to be handled explicitly !
*
* @ param [ in ] lCalledListener
* every listener in this list was called within its method
* queryTermination ( ) before .
*
* @ see impl_sendQueryTerminationEvent ( )
*/
void impl_sendCancelTerminationEvent ( const TTerminateListenerList & lCalledListener ) ;
//---------------------------------------------------------------------
/** calls notifyTermination() on every registered termination listener.
*
* Note : Only normal termination listener ( registered in list m_aListenerContainer
* will be recognized here . Special listener like quick starter , pipe or others
* has to be handled explicitly !
*/
void impl_sendNotifyTerminationEvent ( ) ;
//---------------------------------------------------------------------
/** try to close all open frames.
*
* Iterates over all child frames and try to close them .
* Given parameter bAllowUI enable / disable showing any UI
* ( which mostly occure on calling XController - > suspend ( ) ) .
*
* These method doesnt stop if one frame could not be closed .
* It will ignore such frames and try all other ones .
* But it returns false in such case - true otherwise .
*
* @ param bAllowUI
* enable / disable showing of UI .
*
* @ return true if all frames could be closed ; false otherwise .
*/
: : sal_Bool impl_closeFrames ( : : sal_Bool bAllowUI ) ;
2001-01-25 23:25:24 -06:00
//-------------------------------------------------------------------------------------------------------------
// debug methods
2001-07-04 07:29:56 -05:00
// (should be private everytime!)
2001-01-25 23:25:24 -06:00
//-------------------------------------------------------------------------------------------------------------
2001-07-04 07:29:56 -05:00
# ifdef ENABLE_ASSERTIONS
private :
2001-01-25 23:25:24 -06:00
2001-07-04 07:29:56 -05:00
static sal_Bool implcp_ctor ( const css : : uno : : Reference < css : : lang : : XMultiServiceFactory > & xFactory ) ;
static sal_Bool implcp_addTerminateListener ( const css : : uno : : Reference < css : : frame : : XTerminateListener > & xListener ) ;
static sal_Bool implcp_removeTerminateListener ( const css : : uno : : Reference < css : : frame : : XTerminateListener > & xListener ) ;
static sal_Bool implcp_findFrame ( const : : rtl : : OUString & sTargetFrameName ,
sal_Int32 nSearchFlags ) ;
static sal_Bool implcp_addEventListener ( const css : : uno : : Reference < css : : lang : : XEventListener > & xListener ) ;
static sal_Bool implcp_removeEventListener ( const css : : uno : : Reference < css : : lang : : XEventListener > & xListener ) ;
static sal_Bool implcp_statusChanged ( const css : : frame : : FeatureStateEvent & aEvent ) ;
2001-01-25 23:25:24 -06:00
2001-07-04 07:29:56 -05:00
sal_Bool m_bIsTerminated ; /// check flag to protect us against dispose before terminate!
/// see dispose() for further informations!
2001-01-25 23:25:24 -06:00
2001-07-04 07:29:56 -05:00
# endif // #ifdef ENABLE_ASSERTIONS
2001-01-25 23:25:24 -06:00
//-------------------------------------------------------------------------------------------------------------
// variables
2001-07-04 07:29:56 -05:00
// (should be private everytime!)
2001-01-25 23:25:24 -06:00
//-------------------------------------------------------------------------------------------------------------
private :
2001-03-29 06:17:17 -06:00
css : : uno : : Reference < css : : lang : : XMultiServiceFactory > m_xFactory ; /// reference to factory, which has create this instance
FrameContainer m_aChildTaskContainer ; /// array of child tasks (childs of desktop are tasks; and tasks are also frames - But pure frames are not accepted!)
: : cppu : : OMultiTypeInterfaceContainerHelper m_aListenerContainer ; /// container for ALL Listener
css : : uno : : Reference < css : : frame : : XFrames > m_xFramesHelper ; /// helper for XFrames, XIndexAccess, XElementAccess and implementation of a childcontainer!
2001-07-02 07:38:48 -05:00
css : : uno : : Reference < css : : frame : : XDispatchProvider > m_xDispatchHelper ; /// helper to dispatch something for new tasks, created by "_blank"!
2001-07-04 07:29:56 -05:00
ELoadState m_eLoadState ; /// hold information about state of asynchron loading of component for loadComponentFromURL()!
css : : uno : : Reference < css : : frame : : XFrame > m_xLastFrame ; /// last target of "loadComponentFromURL()"!
2001-11-13 07:07:52 -06:00
css : : uno : : Any m_aInteractionRequest ;
2001-12-13 02:04:55 -06:00
sal_Bool m_bSuspendQuickstartVeto ; /// don't ask quickstart for a veto
2002-04-22 01:05:16 -05:00
SvtCommandOptions m_aCommandOptions ; /// ref counted class to support disabling commands defined by configuration file
2002-05-23 06:54:59 -05:00
: : rtl : : OUString m_sName ;
2003-03-25 11:22:13 -06:00
: : rtl : : OUString m_sTitle ;
css : : uno : : Reference < css : : frame : : XDispatchRecorderSupplier > m_xDispatchRecorderSupplier ;
2001-03-29 06:17:17 -06:00
2007-07-18 07:25:25 -05:00
//---------------------------------------------------------------------
/** special terminate listener to close pipe and block external requests
* during / after termination process is / was running
*/
css : : uno : : Reference < css : : frame : : XTerminateListener > m_xPipeTerminator ;
//---------------------------------------------------------------------
/** special terminate listener shown inside system tray (quick starter)
* Will hinder the office on shutdown . . . but wish to allow closing
* of open documents . And because thats different to a normal terminate listener
* it has to be handled special . - )
*/
css : : uno : : Reference < css : : frame : : XTerminateListener > m_xQuickLauncher ;
//---------------------------------------------------------------------
/** special terminate listener which loads images asynchronous for current open documents.
* Because internaly it uses blocking system APIs . . . it cant be guaranteed that
* running jobs can be cancelled successfully if the corressponding document will be closed . . .
* it will not hinder those documents on closing . Instead it let all jobs running . . .
* but at least on terminate we have to wait for all those blocked requests .
* So these implementation must be a special terminate listener too . - (
*/
css : : uno : : Reference < css : : frame : : XTerminateListener > m_xSWThreadManager ;
//---------------------------------------------------------------------
/** special terminate listener shuting down the SfxApplication.
* Because these desktop instance closes documents and informs listener
* only . . . it does not realy shutdown the whole application .
*
* Btw : That wouldnt be possible by design . . . because Desktop . terminate ( )
* has to return a boolean value about success . . . it cant realy shutdown the
* process . - )
*
* So we uses a trick : A special listener ( exactly these one here ) listen for notifyTermination ( )
* and shutdown the process asynchronous . But desktop has to make this special
* notification as realy last one . . . Otherwhise it can happen that asynchronous
* shutdown will be faster then all other code around Desktop . terminate ( ) . - ) )
*/
css : : uno : : Reference < css : : frame : : XTerminateListener > m_xSfxTerminator ;
2008-04-04 08:10:08 -05:00
css : : uno : : Reference < css : : frame : : XUntitledNumbers > m_xTitleNumberGenerator ;
2001-03-29 06:17:17 -06:00
} ; // class Desktop
} // namespace framework
2001-01-25 23:25:24 -06:00
2001-01-26 01:39:47 -06:00
# endif // #ifndef __FRAMEWORK_SERVICES_DESKTOP_HXX_
