summaryrefslogtreecommitdiff
path: root/framework/inc/services/desktop.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'framework/inc/services/desktop.hxx')
-rw-r--r--framework/inc/services/desktop.hxx516
1 files changed, 0 insertions, 516 deletions
diff --git a/framework/inc/services/desktop.hxx b/framework/inc/services/desktop.hxx
deleted file mode 100644
index c1cc855323..0000000000
--- a/framework/inc/services/desktop.hxx
+++ /dev/null
@@ -1,516 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*************************************************************************
- *
- * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
- *
- * Copyright 2000, 2010 Oracle and/or its affiliates.
- *
- * OpenOffice.org - a multi-platform office productivity suite
- *
- * This file is part of OpenOffice.org.
- *
- * OpenOffice.org is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 3
- * only, as published by the Free Software Foundation.
- *
- * OpenOffice.org 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 version 3 for more details
- * (a copy is included in the LICENSE file that accompanied this code).
- *
- * You should have received a copy of the GNU Lesser General Public License
- * version 3 along with OpenOffice.org. If not, see
- * <http://www.openoffice.org/license.html>
- * for a copy of the LGPLv3 License.
- *
- ************************************************************************/
-
-#ifndef __FRAMEWORK_SERVICES_DESKTOP_HXX_
-#define __FRAMEWORK_SERVICES_DESKTOP_HXX_
-
-//_________________________________________________________________________________________________________________
-// my own includes
-//_________________________________________________________________________________________________________________
-
-#include <classes/framecontainer.hxx>
-#include <threadhelp/threadhelpbase.hxx>
-#include <helper/oframes.hxx>
-#include <macros/generic.hxx>
-#include <macros/debug.hxx>
-#include <macros/xinterface.hxx>
-#include <macros/xtypeprovider.hxx>
-#include <macros/xserviceinfo.hxx>
-
-//_________________________________________________________________________________________________________________
-// interface includes
-//_________________________________________________________________________________________________________________
-
-#include <com/sun/star/frame/XUntitledNumbers.hpp>
-
-#include <com/sun/star/frame/XController.hpp>
-#include <com/sun/star/frame/XDesktop.hpp>
-#include <com/sun/star/frame/WindowArrange.hpp>
-#include <com/sun/star/frame/TerminationVetoException.hpp>
-#include <com/sun/star/frame/XTerminateListener.hpp>
-#include <com/sun/star/frame/XWindowArranger.hpp>
-#include <com/sun/star/frame/XTask.hpp>
-#include <com/sun/star/frame/XStorable.hpp>
-#include <com/sun/star/frame/XModel.hpp>
-#include <com/sun/star/frame/XFramesSupplier.hpp>
-#include <com/sun/star/frame/XFrames.hpp>
-#include <com/sun/star/lang/XServiceName.hpp>
-#include <com/sun/star/frame/XDispatchProvider.hpp>
-#include <com/sun/star/frame/XDispatchProviderInterception.hpp>
-#include <com/sun/star/frame/XComponentLoader.hpp>
-#include <com/sun/star/frame/FrameAction.hpp>
-#include <com/sun/star/task/XStatusIndicatorFactory.hpp>
-#include <com/sun/star/frame/XTasksSupplier.hpp>
-#include <com/sun/star/container/XEnumerationAccess.hpp>
-#include <com/sun/star/lang/Locale.hpp>
-#include <com/sun/star/frame/XDispatchResultListener.hpp>
-#include <com/sun/star/lang/XEventListener.hpp>
-#include <com/sun/star/frame/FeatureStateEvent.hpp>
-#include <com/sun/star/task/XInteractionHandler.hpp>
-#include <com/sun/star/frame/XDispatchRecorderSupplier.hpp>
-
-//_________________________________________________________________________________________________________________
-// other includes
-//_________________________________________________________________________________________________________________
-#include <unotools/cmdoptions.hxx>
-#include <cppuhelper/propshlp.hxx>
-#include <cppuhelper/interfacecontainer.hxx>
-#include <cppuhelper/weak.hxx>
-
-#include <comphelper/numberedcollection.hxx>
-
-//_________________________________________________________________________________________________________________
-// namespace
-//_________________________________________________________________________________________________________________
-
-namespace framework{
-
-//_________________________________________________________________________________________________________________
-// exported const
-//_________________________________________________________________________________________________________________
-
-//_________________________________________________________________________________________________________________
-// exported definitions
-//_________________________________________________________________________________________________________________
-
-enum ELoadState
-{
- E_NOTSET ,
- E_SUCCESSFUL ,
- E_FAILED ,
- E_INTERACTION
-};
-
-/*-************************************************************************************************************//**
- @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
- XDispatchResultListener
- XEventListener
- XInteractionHandler
-
- @base ThreadHelpBase
- TransactionBase
- OBroadcastHelper
- OPropertySetHelper
-
- @devstatus ready to use
- @threadsafe yes
-*//*-*************************************************************************************************************/
-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 ,
- public css::frame::XDispatchProviderInterception,
- public css::frame::XFramesSupplier , // => XFrame => XComponent
- public css::frame::XDispatchResultListener , // => XEventListener
- public css::task::XInteractionHandler ,
- public css::frame::XUntitledNumbers ,
- // base classes
- // Order is neccessary for right initialization!
- private ThreadHelpBase ,
- private TransactionBase ,
- public ::cppu::OBroadcastHelper ,
- public ::cppu::OPropertySetHelper ,
- public ::cppu::OWeakObject
-{
- // 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
- public:
-
- // constructor / destructor
- Desktop( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
- virtual ~Desktop( );
-
- // XInterface, XTypeProvider, XServiceInfo
- FWK_DECLARE_XINTERFACE
- FWK_DECLARE_XTYPEPROVIDER
- DECLARE_XSERVICEINFO
-
- //---------------------------------------------------------------------
- /**
- @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 );
-
- 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 );
-
- // XComponentLoader
- 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 );
-
- // XTasksSupplier
- 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 );
-
- // XDispatchProvider
- 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 );
-
- // 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);
-
- // XFramesSupplier
- 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 );
-
- // XFrame
- // 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 );
-
- // XComponent
- using cppu::OPropertySetHelper::disposing;
- 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 );
-
- // XDispatchResultListener
- virtual void SAL_CALL dispatchFinished ( const css::frame::DispatchResultEvent& aEvent ) throw( css::uno::RuntimeException );
-
- // XEventListener
- virtual void SAL_CALL disposing ( const css::lang::EventObject& aSource ) throw( css::uno::RuntimeException );
-
- // XInteractionHandler
- virtual void SAL_CALL handle ( const css::uno::Reference< css::task::XInteractionRequest >& xRequest ) throw( css::uno::RuntimeException );
-
- // 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);
-
- //-------------------------------------------------------------------------------------------------------------
- // protected methods
- //-------------------------------------------------------------------------------------------------------------
- protected:
-
- // OPropertySetHelper
- 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 );
- using cppu::OPropertySetHelper::getFastPropertyValue;
- virtual void SAL_CALL getFastPropertyValue ( css::uno::Any& aValue ,
- sal_Int32 nHandle ) const;
- virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper ( );
- virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo ( ) throw (css::uno::RuntimeException);
-
- //-------------------------------------------------------------------------------------------------------------
- // private methods
- //-------------------------------------------------------------------------------------------------------------
- private:
-
- 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( );
-
- //---------------------------------------------------------------------
- /** 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);
-
- //-------------------------------------------------------------------------------------------------------------
- // debug methods
- // (should be private everytime!)
- //-------------------------------------------------------------------------------------------------------------
- #ifdef ENABLE_ASSERTIONS
- private:
-
- static sal_Bool implcp_ctor ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
- 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 );
-
- sal_Bool m_bIsTerminated ; /// check flag to protect us against dispose before terminate!
- /// see dispose() for further informations!
-
- #endif // #ifdef ENABLE_ASSERTIONS
-
- //-------------------------------------------------------------------------------------------------------------
- // variables
- // (should be private everytime!)
- //-------------------------------------------------------------------------------------------------------------
- private:
-
- 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!
- css::uno::Reference< css::frame::XDispatchProvider > m_xDispatchHelper ; /// helper to dispatch something for new tasks, created by "_blank"!
- 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()"!
- css::uno::Any m_aInteractionRequest ;
- sal_Bool m_bSuspendQuickstartVeto ; /// don't ask quickstart for a veto
- SvtCommandOptions m_aCommandOptions ; /// ref counted class to support disabling commands defined by configuration file
- ::rtl::OUString m_sName ;
- ::rtl::OUString m_sTitle ;
- css::uno::Reference< css::frame::XDispatchRecorderSupplier > m_xDispatchRecorderSupplier ;
-
- //---------------------------------------------------------------------
- /** 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;
-
- css::uno::Reference< css::frame::XUntitledNumbers > m_xTitleNumberGenerator;
-
-}; // class Desktop
-
-} // namespace framework
-
-#endif // #ifndef __FRAMEWORK_SERVICES_DESKTOP_HXX_
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
generated by cgit v1.2.3 (git 2.39.1) at 2025-02-26 07:31:57 +0000