mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d4fbec28de03039dc24ea27fe33b8b9a3eb50229
libreoffice/framework/inc/services/frame.hxx

623 lines
46 KiB
C++
Raw Normal View History

initial import
2000-09-18 15:33:13 +00:00
/*************************************************************************
*
* $RCSfile: frame.hxx,v $
*
#99797# handle close/suspend/dispose better
2002-05-31 12:43:15 +00:00
* $Revision: 1.23 $
initial import
2000-09-18 15:33:13 +00:00
*
#99797# handle close/suspend/dispose better
2002-05-31 12:43:15 +00:00
* last change: $Author: as $ $Date: 2002-05-31 13:42:57 $
initial import
2000-09-18 15:33:13 +00:00
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* 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.
*
* 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.
*
* 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __FRAMEWORK_SERVICES_FRAME_HXX_
#define __FRAMEWORK_SERVICES_FRAME_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#ifndef __FRAMEWORK_CLASSES_FRAMECONTAINER_HXX_
#include <classes/framecontainer.hxx>
#endif
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
#ifndef __FRAMEWORK_THREADHELP_TRANSACTIONBASE_HXX_
#include <threadhelp/transactionbase.hxx>
#endif
#85529# use new lock mechanism
2001-06-11 09:29:50 +00:00
#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
#include <threadhelp/threadhelpbase.hxx>
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
#endif
#ifndef __FRAMEWORK_THREADHELP_RESETABLEGUARD_HXX_
#include <threadhelp/resetableguard.hxx>
#endif
#ifndef __FRAMEWORK_THREADHELP_WRITEGUARD_HXX_
#include <threadhelp/writeguard.hxx>
#endif
#ifndef __FRAMEWORK_THREADHELP_READGUARD_HXX_
#include <threadhelp/readguard.hxx>
initial import
2000-09-18 15:33:13 +00:00
#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
no TF_FILTER, split defines.hxx, namespaces, new thread helper, some threadsafe code
2001-03-29 12:17:17 +00:00
#ifndef __FRAMEWORK_GENERAL_H_
#include <general.h>
initial import
2000-09-18 15:33:13 +00:00
#endif
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#ifndef _COM_SUN_STAR_FRAME_XCONTROLLER_HPP_
#include <com/sun/star/frame/XController.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XDISPATCH_HPP_
#include <com/sun/star/frame/XDispatch.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XDISPATCHPROVIDER_HPP_
#include <com/sun/star/frame/XDispatchProvider.hpp>
#endif
#98427# new property for recording supplier
2002-04-22 12:51:21 +00:00
#ifndef _COM_SUN_STAR_FRAME_XDISPATCHRECORDERSUPPLIER_HPP_
#include <com/sun/star/frame/XDispatchRecorderSupplier.hpp>
#endif
#93753# new namespace drafts for DispatchInfo
2001-11-02 06:56:17 +00:00
#ifndef _DRAFTS_COM_SUN_STAR_FRAME_XDISPATCHINFORMATIONPROVIDER_HPP_
#include <drafts/com/sun/star/frame/XDispatchInformationProvider.hpp>
implement XDispatchInformationProvider
2001-05-04 14:35:09 +00:00
#endif
initial import
2000-09-18 15:33:13 +00:00
#ifndef _COM_SUN_STAR_FRAME_XDISPATCHPROVIDERINTERCEPTION_HPP_
#include <com/sun/star/frame/XDispatchProviderInterception.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XDISPATCHPROVIDERINTERCEPTOR_HPP_
#include <com/sun/star/frame/XDispatchProviderInterceptor.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_XEVENTLISTENER_HPP_
#include <com/sun/star/lang/XEventListener.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XFRAME_HPP_
#include <com/sun/star/frame/XFrame.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XFRAMEACTIONLISTENER_HPP_
#include <com/sun/star/frame/XFrameActionListener.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XFRAMES_HPP_
#include <com/sun/star/frame/XFrames.hpp>
#endif
#ifndef _COM_SUN_STAR_FRAME_XFRAMESSUPPLIER_HPP_
#include <com/sun/star/frame/XFramesSupplier.hpp>
#endif
#ifndef _COM_SUN_STAR_TASK_XSTATUSINDICATOR_HPP_
#include <com/sun/star/task/XStatusIndicator.hpp>
#endif
#78521# support right interface XStatusIndicatorFactory
2000-10-12 09:50:11 +00:00
#ifndef _COM_SUN_STAR_TASK_XSTATUSINDICATORFACTORY_HPP_
#include <com/sun/star/task/XStatusIndicatorFactory.hpp>
initial import
2000-09-18 15:33:13 +00:00
#endif
#ifndef _COM_SUN_STAR_AWT_XTOPWINDOWLISTENER_HPP_
#include <com/sun/star/awt/XTopWindowListener.hpp>
#endif
#ifndef _COM_SUN_STAR_AWT_XWINDOW_HPP_
#include <com/sun/star/awt/XWindow.hpp>
#endif
#ifndef _COM_SUN_STAR_AWT_XWINDOWLISTENER_HPP_
#include <com/sun/star/awt/XWindowListener.hpp>
#endif
#ifndef _COM_SUN_STAR_AWT_XSERVICEINFO_HPP_
#include <com/sun/star/lang/XServiceInfo.hpp>
#endif
#ifndef _COM_SUN_STAR_AWT_XFOCUSLISTENER_HPP_
#include <com/sun/star/awt/XFocusListener.hpp>
#endif
#ifndef _COM_SUN_STAR_AWT_FOCUSEVENT_HPP_
#include <com/sun/star/awt/FocusEvent.hpp>
#endif
#89129# use new service initialize
2001-07-04 12:34:18 +00:00
#ifndef _COM_SUN_STAR_DATATRANSFER_DND_XDROPTARGETELISTENER_HPP_
#include <com/sun/star/datatransfer/dnd/XDropTargetListener.hpp>
fix: #88014# new member droptargetlistener
2001-06-15 08:39:31 +00:00
#endif
#91017# support lock/unlock from outside
2001-08-16 08:45:37 +00:00
#ifndef _COM_SUN_STAR_DOCUMENT_XACTIONLOCKABLE_HPP_
#include <com/sun/star/document/XActionLockable.hpp>
#endif
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
#ifndef _COM_SUN_STAR_UTIL_XCLOSEABLE_HPP_
#include <com/sun/star/util/XCloseable.hpp>
#endif
initial import
2000-09-18 15:33:13 +00:00
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
#ifndef _VCL_EVNTPOST_HXX
#include <vcl/evntpost.hxx>
#endif
#98419# Added support for disabling commands from configuration
2002-04-22 06:05:16 +00:00
#ifndef INCLUDED_SVTOOLS_CMDOPTIONS_HXX
#include <svtools/cmdoptions.hxx>
#endif
initial import
2000-09-18 15:33:13 +00:00
#ifndef _CPPUHELPER_INTERFACECONTAINER_HXX_
#include <cppuhelper/interfacecontainer.hxx>
#endif
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
#ifndef _CPPUHELPER_PROPSHLP_HXX
#include <cppuhelper/propshlp.hxx>
#endif
initial import
2000-09-18 15:33:13 +00:00
#ifndef _CPPUHELPER_WEAK_HXX_
#include <cppuhelper/weak.hxx>
#endif
#ifndef _RTL_STRING_HXX_
#include <rtl/string.hxx>
#endif
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
//_________________________________________________________________________________________________________________
// exported const
//_________________________________________________________________________________________________________________
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
// This enum can be used to set differnt active states of frames
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
enum EActiveState
no TF_FILTER, split defines.hxx, namespaces, new thread helper, some threadsafe code
2001-03-29 12:17:17 +00:00
{
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
E_INACTIVE , // I'am not a member of active path in tree and i don't have the focus.
E_ACTIVE , // I'am in the middle of an active path in tree and i don't have the focus.
E_FOCUS // I have the focus now. I must a member of an active path!
no TF_FILTER, split defines.hxx, namespaces, new thread helper, some threadsafe code
2001-03-29 12:17:17 +00:00
};
initial import
2000-09-18 15:33:13 +00:00
//_________________________________________________________________________________________________________________
// exported definitions
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************//**
@short implements a normal frame of hierarchy
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
@descr An instance of these class can be a normal node in frame tree. A frame support influencing of his
subtree, find of subframes, activate- and deactivate-mechanism as well as
initial import
2000-09-18 15:33:13 +00:00
set/get of a frame window, component or controller.
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
@attention This implementation supports three states: a)uninitialized, b)working, c)disposed
If you call wrong methods in modes a) or c) ... you will get some exceptions.
How you should work with this service:
i) create it by using "xServiceManager->createInstance(...)"
ii) call XInitialization::initialize() with a valid window reference or use createInstanceWithArguments() at i)
iii) works with object
iv) dispose object by calling XComponent::dispose()
After iv) all further requests are rejected by exceptions! (DisposedException)
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
@base ThreadHelpBase
help to guarantee correct initialized lock member at startup
@base TransactionBase
help to implement unbreakable interface calls
@base OBroadcastHelper
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
OPropertySetHelper
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
implements the property set
@base OWeakObject
provides the refcount and XInterface, XWeak
initial import
2000-09-18 15:33:13 +00:00
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
@devstatus ready to use
@threadsafe yes
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
@modified 08.05.2002 09:38, as96863
initial import
2000-09-18 15:33:13 +00:00
*//*-*************************************************************************************************************/
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
class Frame : // interfaces
public css::lang::XTypeProvider ,
public css::lang::XServiceInfo ,
public css::frame::XFramesSupplier , // => XFrame => XComponent
public css::frame::XDispatchProvider ,
#93753# new namespace drafts for DispatchInfo
2001-11-02 06:56:17 +00:00
public dcss::frame::XDispatchInformationProvider ,
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
public css::frame::XDispatchProviderInterception ,
public css::task::XStatusIndicatorFactory ,
public css::awt::XWindowListener , // => XEventListener
public css::awt::XTopWindowListener ,
public css::awt::XFocusListener ,
#91017# support lock/unlock from outside
2001-08-16 08:45:37 +00:00
public css::document::XActionLockable ,
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
public css::util::XCloseable , // => XCloseBroadcaster
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// base classes
// Order is neccessary for right initialization of this class!
#86793# defuse Frame::dispose() and transaction mechanism
2001-06-19 09:37:05 +00:00
public ThreadHelpBase , // helper for own threadsafe code
public TransactionBase , // helper for rejecting calls for wrong object states
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
public ::cppu::OBroadcastHelper , // helper for propertyset => XPropertySet, XFastPropertySet, XMultiPropertySet
public ::cppu::OPropertySetHelper ,
public ::cppu::OWeakObject // helper for refcount mechanism
initial import
2000-09-18 15:33:13 +00:00
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public:
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
Frame( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
virtual ~Frame( );
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
// XInterface, XTypeProvider, XServiceInfo
//---------------------------------------------------------------------------------------------------------
DECLARE_XINTERFACE
DECLARE_XTYPEPROVIDER
DECLARE_XSERVICEINFO
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XFramesSupplier
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00: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 );
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XFrame
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
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 css::uno::Reference< css::frame::XFrame > SAL_CALL findFrame ( const ::rtl::OUString& sTargetFrameName ,
sal_Int32 nSearchFlags ) 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 void SAL_CALL contextChanged ( ) 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 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 );
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XComponent
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00: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 );
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XStatusIndicatorFactory
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
virtual css::uno::Reference< css::task::XStatusIndicator > SAL_CALL createStatusIndicator ( ) throw( css::uno::RuntimeException );
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XDispatchProvider
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00: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 >& lDescriptor ) throw( css::uno::RuntimeException );
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XDispatchProviderInterception
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
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 );
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XWindowListener
// Attention: windowResized() is implement only! All other are empty!
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
virtual void SAL_CALL windowResized ( const css::awt::WindowEvent& aEvent ) throw( css::uno::RuntimeException );
virtual void SAL_CALL windowMoved ( const css::awt::WindowEvent& aEvent ) throw( css::uno::RuntimeException ) {};
virtual void SAL_CALL windowShown ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException ) {};
virtual void SAL_CALL windowHidden ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException ) {};
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XFocusListener
// Attention: focusLost() not implemented yet!
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
virtual void SAL_CALL focusGained ( const css::awt::FocusEvent& aEvent ) throw( css::uno::RuntimeException );
virtual void SAL_CALL focusLost ( const css::awt::FocusEvent& aEvent ) throw( css::uno::RuntimeException ) {};
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// XTopWindowListener
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
// Attention: windowActivated(), windowDeactivated() and windowClosing() are implement only! All other are empty!
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
virtual void SAL_CALL windowActivated ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
virtual void SAL_CALL windowDeactivated ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
virtual void SAL_CALL windowOpened ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException ) {};
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
virtual void SAL_CALL windowClosing ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
virtual void SAL_CALL windowClosed ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException ) {};
virtual void SAL_CALL windowMinimized ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException ) {};
virtual void SAL_CALL windowNormalized ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException ) {};
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#86793# defuse Frame::dispose() and transaction mechanism
2001-06-19 09:37:05 +00:00
// XEventListener
initial import
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
virtual void SAL_CALL disposing ( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
initial import
2000-09-18 15:33:13 +00:00
#86793# defuse Frame::dispose() and transaction mechanism
2001-06-19 09:37:05 +00:00
//---------------------------------------------------------------------------------------------------------
// XDispatchInformationProvider
//---------------------------------------------------------------------------------------------------------
virtual ::rtl::OUString SAL_CALL queryDescription ( const ::rtl::OUString& sURL ) throw( css::uno::RuntimeException );
virtual void SAL_CALL queryDescriptions ( const css::uno::Sequence< ::rtl::OUString >& lURLs ,
css::uno::Sequence< ::rtl::OUString >& lDescriptions ) throw( css::uno::RuntimeException );
#93753# new namespace drafts for DispatchInfo
2001-11-02 06:56:17 +00:00
virtual css::uno::Sequence< dcss::frame::DispatchInformation > SAL_CALL getConfigurableDispatchInformation( ) throw( css::uno::RuntimeException );
implement XDispatchInformationProvider
2001-05-04 14:35:09 +00:00
#91017# support lock/unlock from outside
2001-08-16 08:45:37 +00:00
//---------------------------------------------------------------------------------------------------------
// XActionLockable
//---------------------------------------------------------------------------------------------------------
virtual sal_Bool SAL_CALL isActionLocked ( ) throw( css::uno::RuntimeException );
virtual void SAL_CALL addActionLock ( ) throw( css::uno::RuntimeException );
virtual void SAL_CALL removeActionLock( ) throw( css::uno::RuntimeException );
virtual void SAL_CALL setActionLocks ( sal_Int16 nLock ) throw( css::uno::RuntimeException );
virtual sal_Int16 SAL_CALL resetActionLocks( ) throw( css::uno::RuntimeException );
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
//---------------------------------------------------------------------------------------------------------
// XCloseable
//---------------------------------------------------------------------------------------------------------
virtual void SAL_CALL close( sal_Bool bDeliverOwnerShip ) throw( css::util::CloseVetoException,
css::uno::RuntimeException );
//---------------------------------------------------------------------------------------------------------
// XCloseable
//---------------------------------------------------------------------------------------------------------
virtual void SAL_CALL addCloseListener ( const css::uno::Reference< css::util::XCloseListener >& xListener ) throw (css::uno::RuntimeException);
virtual void SAL_CALL removeCloseListener( const css::uno::Reference< css::util::XCloseListener >& xListener ) throw (css::uno::RuntimeException);
initial import
2000-09-18 15:33:13 +00:00
//-------------------------------------------------------------------------------------------------------------
// protected methods
//-------------------------------------------------------------------------------------------------------------
protected:
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
//---------------------------------------------------------------------------------------------------------
// 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 );
virtual void SAL_CALL getFastPropertyValue ( css::uno::Any& aValue ,
sal_Int32 nHandle ) const;
virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper ( );
#92075# exception specification
2001-09-12 15:24:32 +00:00
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo ( ) throw (::com::sun::star::uno::RuntimeException);
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
initial import
2000-09-18 15:33:13 +00:00
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
/*-****************************************************************************************************//**
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
@short helper methods
@descr Follow methods are needed at different points of our code (more then ones!).
initial import
2000-09-18 15:33:13 +00:00
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
@attention Threadsafe methods are signed by "implts_..."!
initial import
2000-09-18 15:33:13 +00:00
*//*-*****************************************************************************************************/
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// threadsafe
void implts_sendFrameActionEvent ( const css::frame::FrameAction& aAction );
void implts_resizeComponentWindow ( );
void implts_setTitleOnWindow ( const ::rtl::OUString& sTitle );
const ::rtl::OUString implts_getTitleFromWindow ( ) const;
#92152# move set icon to frame
2001-10-26 08:46:09 +00:00
void implts_setIconOnWindow ( );
#86793# defuse Frame::dispose() and transaction mechanism
2001-06-19 09:37:05 +00:00
void implts_startWindowListening ( );
void implts_stopWindowListening ( );
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
void implts_saveWindowAttributes ( );
void implts_checkSuicide ( );
DECL_LINK( implts_windowClosing, void* );
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// non threadsafe
#87357# stop listening on container window in dispose()
2001-06-11 11:52:42 +00:00
void impl_disposeContainerWindow ( css::uno::Reference< css::awt::XWindow >& xWindow );
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
sal_Bool impl_tryToChangeProperty ( const ::rtl::OUString& sProperty ,
const css::uno::Any& aValue ,
css::uno::Any& aOldValue ,
css::uno::Any& aConvertedValue ) throw( css::lang::IllegalArgumentException );
#98427# new property for recording supplier
2002-04-22 12:51:21 +00:00
sal_Bool impl_tryToChangeProperty ( const css::uno::Reference< css::frame::XDispatchRecorderSupplier >& xProperty ,
const css::uno::Any& aValue ,
css::uno::Any& aOldValue ,
css::uno::Any& aConvertedValue ) throw( css::lang::IllegalArgumentException );
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
static const css::uno::Sequence< css::beans::Property > impl_getStaticPropertyDescriptor( );
static void impl_filterSpecialTargets ( ::rtl::OUString& sTarget );
initial import
2000-09-18 15:33:13 +00:00
//-------------------------------------------------------------------------------------------------------------
// debug methods
// (should be private everyway!)
//-------------------------------------------------------------------------------------------------------------
/*-****************************************************************************************************//**
@short debug-method to check incoming parameter of some other mehods of this class
@descr The following methods are used to check parameters for other methods
of this class. The return value is used directly for an ASSERT(...).
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
@attention This methods are static and can't use our member directly! It's better for threadsafe code...
because we call it with references or pointer to check variables ... and must make it safe
by himself!
initial import
2000-09-18 15:33:13 +00:00
@seealso ASSERTs in implementation!
@param references to checking variables
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
@return sal_True ,on invalid parameter
@return sal_False ,otherwise
initial import
2000-09-18 15:33:13 +00:00
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
@onerror We return sal_True
initial import
2000-09-18 15:33:13 +00:00
*//*-*****************************************************************************************************/
#ifdef ENABLE_ASSERTIONS
private:
#89129# use new service initialize
2001-07-04 12:34:18 +00:00
static sal_Bool implcp_ctor ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
static sal_Bool implcp_setActiveFrame ( const css::uno::Reference< css::frame::XFrame >& xFrame );
static sal_Bool implcp_initialize ( const css::uno::Reference< css::awt::XWindow >& xWindow );
static sal_Bool implcp_setCreator ( const css::uno::Reference< css::frame::XFramesSupplier >& xCreator );
static sal_Bool implcp_setName ( const ::rtl::OUString& sName );
static sal_Bool implcp_findFrame ( const ::rtl::OUString& sTargetFrameName ,
sal_Int32 nSearchFlags );
static sal_Bool implcp_setComponent ( const css::uno::Reference< css::awt::XWindow >& xComponentWindow ,
const css::uno::Reference< css::frame::XController >& xController );
static sal_Bool implcp_addFrameActionListener ( const css::uno::Reference< css::frame::XFrameActionListener >& xListener );
static sal_Bool implcp_removeFrameActionListener ( const css::uno::Reference< css::frame::XFrameActionListener >& xListener );
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_windowResized ( const css::awt::WindowEvent& aEvent );
static sal_Bool implcp_focusGained ( const css::awt::FocusEvent& aEvent );
static sal_Bool implcp_windowActivated ( const css::lang::EventObject& aEvent );
static sal_Bool implcp_windowDeactivated ( const css::lang::EventObject& aEvent );
static sal_Bool implcp_disposing ( const css::lang::EventObject& aEvent );
initial import
2000-09-18 15:33:13 +00:00
#endif // #ifdef ENABLE_ASSERTIONS
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
//*************************************************************************************************************
initial import
2000-09-18 15:33:13 +00:00
// variables
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
// -threadsafe by own read/write lock "m_aLock"
//*************************************************************************************************************
private:
initial import
2000-09-18 15:33:13 +00:00
#86793# defuse Frame::dispose() and transaction mechanism
2001-06-19 09:37:05 +00:00
css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory ; /// reference to factory, which has create this instance
css::uno::Reference< css::task::XStatusIndicatorFactory > m_xIndicatorFactoryHelper ; /// reference to factory helper to create status indicator objects
css::uno::Reference< css::frame::XDispatchProvider > m_xDispatchHelper ; /// helper for XDispatch/Provider and interception interfaces
css::uno::Reference< css::frame::XFrames > m_xFramesHelper ; /// helper for XFrames, XIndexAccess and XElementAccess interfaces
::cppu::OMultiTypeInterfaceContainerHelper m_aListenerContainer ; /// container for ALL Listener
css::uno::Reference< css::frame::XFramesSupplier > m_xParent ; /// parent of this frame
css::uno::Reference< css::awt::XWindow > m_xContainerWindow ; /// containerwindow of this frame for embedded components
css::uno::Reference< css::awt::XWindow > m_xComponentWindow ; /// window of the actual component
css::uno::Reference< css::frame::XController > m_xController ; /// controller of the actual frame
css::uno::Reference< css::datatransfer::dnd::XDropTargetListener > m_xDropTargetListener ; /// listen to drag & drop
EActiveState m_eActiveState ; /// state, if i'am a member of active path in tree or i have the focus or ...
::rtl::OUString m_sName ; /// name of this frame
sal_Bool m_bIsFrameTop ; /// frame has no parent or the parent is a taskor the desktop
sal_Bool m_bConnected ; /// due to FrameActionEvent
#91017# support lock/unlock from outside
2001-08-16 08:45:37 +00:00
sal_Int16 m_nExternalLockCount ;
#98427# new property for recording supplier
2002-04-22 12:51:21 +00:00
css::uno::Reference< css::frame::XDispatchRecorderSupplier > m_xDispatchRecorderSupplier ; /// is used for dispatch recording and will be set/get from outside. Frame provide it only!
#98419# Added support for disabling commands from configuration
2002-04-22 06:05:16 +00:00
SvtCommandOptions m_aCommandOptions ; /// ref counted class to support disabling commands defined by configuration file
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
sal_Bool m_bSelfClose ; /// in case of CloseVetoException on method close() wqs thrown by ourself - we must close ourself later if no internal processes are running
::vcl::EventPoster m_aPoster ;
initial import
2000-09-18 15:33:13 +00:00
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
protected:
initial import
2000-09-18 15:33:13 +00:00
#91939# supports XClosable; remove deprecated task; ...
2002-05-23 11:54:59 +00:00
sal_Bool m_bIsPlugIn ; /// In objects of these class this member is set to FALSE. But in derived class PlugInFrame it's overwritten with TRUE!
#86793# defuse Frame::dispose() and transaction mechanism
2001-06-19 09:37:05 +00:00
FrameContainer m_aChildFrameContainer ; /// array of child frames
#84454# move property set to frame
2001-05-02 11:58:40 +00:00
inline css::uno::Reference< css::lang::XMultiServiceFactory > impl_getFactory()
{
ReadGuard aReadLock( m_aLock );
return m_xFactory;
}
inline ::rtl::OUString impl_getName()
{
ReadGuard aReadLock( m_aLock );
return m_sName;
}
inline css::uno::Reference< css::awt::XWindow > impl_getContainerWindow()
{
ReadGuard aReadLock( m_aLock );
return m_xContainerWindow;
}
inline css::uno::Reference< css::frame::XDispatchProvider > impl_getDispatchHelper()
{
ReadGuard aReadLock( m_aLock );
return m_xDispatchHelper;
}
inline css::uno::Reference< css::frame::XFramesSupplier > impl_getParent()
{
ReadGuard aReadLock( m_aLock );
return m_xParent;
}
initial import
2000-09-18 15:33:13 +00:00
}; // class Frame
} // namespace framework
#endif // #ifndef __FRAMEWORK_SERVICES_FRAME_HXX_
Reference in New Issue Copy Permalink