2000-09-18 15:33:13 +00:00
/*************************************************************************
*
2005-09-08 23:30:32 +00:00
* OpenOffice . org - a multi - platform office productivity suite
2000-09-18 15:33:13 +00:00
*
2005-09-08 23:30:32 +00:00
* $ RCSfile : frame . hxx , v $
2000-09-18 15:33:13 +00:00
*
2006-09-08 07:31:16 +00:00
* $ Revision : 1.38 $
2000-09-18 15:33:13 +00:00
*
2006-09-08 07:31:16 +00:00
* last change : $ Author : vg $ $ Date : 2006 - 09 - 08 08 : 31 : 16 $
2000-09-18 15:33:13 +00:00
*
2005-09-08 23:30:32 +00:00
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1 .
2000-09-18 15:33:13 +00:00
*
*
2005-09-08 23:30:32 +00:00
* GNU Lesser General Public License Version 2.1
* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
* Copyright 2005 by Sun Microsystems , Inc .
* 901 San Antonio Road , Palo Alto , CA 94303 , USA
2000-09-18 15:33:13 +00:00
*
2005-09-08 23:30:32 +00: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 .
2000-09-18 15:33:13 +00:00
*
2005-09-08 23:30:32 +00: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 .
2000-09-18 15:33:13 +00:00
*
2005-09-08 23:30:32 +00: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
2000-09-18 15:33:13 +00:00
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
# ifndef __FRAMEWORK_SERVICES_FRAME_HXX_
# define __FRAMEWORK_SERVICES_FRAME_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
# ifndef __FRAMEWORK_CLASSES_FRAMECONTAINER_HXX_
# include <classes/framecontainer.hxx>
# endif
2005-07-12 13:12:14 +00:00
# ifndef __FRAMEWORK_CLASSES_PROPERTYSETHELPER_HXX_
# include <classes/propertysethelper.hxx>
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>
2000-09-18 15:33:13 +00:00
# endif
2006-02-07 09:23:32 +00:00
# ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
# include <threadhelp/threadhelpbase.hxx>
# endif
# ifndef __FRAMEWORK_THREADHELP_TRANSACTIONBASE_HXX_
# include <threadhelp/transactionbase.hxx>
# endif
2000-09-18 15:33:13 +00:00
# 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
2001-03-29 12:17:17 +00:00
# ifndef __FRAMEWORK_GENERAL_H_
# include <general.h>
2000-09-18 15:33:13 +00:00
# endif
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
2004-11-16 13:49:35 +00:00
# ifndef _COM_SUN_STAR_FRAME_XDISPATCHINFORMATIONPROVIDER_HPP_
# include <com/sun/star/frame/XDispatchInformationProvider.hpp>
# endif
2002-07-29 07:23:08 +00:00
# ifndef _COM_SUN_STAR_FRAME_XCOMPONENTLOADER_HPP_
# include <com/sun/star/frame/XComponentLoader.hpp>
# endif
2000-09-18 15:33:13 +00:00
# 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
2002-04-22 12:51:21 +00:00
# ifndef _COM_SUN_STAR_FRAME_XDISPATCHRECORDERSUPPLIER_HPP_
# include <com/sun/star/frame/XDispatchRecorderSupplier.hpp>
# endif
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
2000-10-12 09:50:11 +00:00
# ifndef _COM_SUN_STAR_TASK_XSTATUSINDICATORFACTORY_HPP_
# include <com/sun/star/task/XStatusIndicatorFactory.hpp>
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
2006-09-08 07:31:16 +00:00
# ifndef _COM_SUN_STAR_AWT_XTOPWINDOW_HPP_
# include <com/sun/star/awt/XTopWindow.hpp>
2000-09-18 15:33:13 +00:00
# endif
2006-09-08 07:31:16 +00:00
# ifndef _COM_SUN_STAR_AWT_XWINDOWLISTENER_HPP_
# include <com/sun/star/awt/XWindowListener.hpp>
2000-09-18 15:33:13 +00:00
# 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
2001-07-04 12:34:18 +00:00
# ifndef _COM_SUN_STAR_DATATRANSFER_DND_XDROPTARGETELISTENER_HPP_
# include <com/sun/star/datatransfer/dnd/XDropTargetListener.hpp>
2001-06-15 08:39:31 +00:00
# endif
2001-08-16 08:45:37 +00:00
# ifndef _COM_SUN_STAR_DOCUMENT_XACTIONLOCKABLE_HPP_
# include <com/sun/star/document/XActionLockable.hpp>
# endif
2002-05-23 11:54:59 +00:00
# ifndef _COM_SUN_STAR_UTIL_XCLOSEABLE_HPP_
# include <com/sun/star/util/XCloseable.hpp>
# endif
2005-03-01 18:25:24 +00:00
# ifndef _COM_SUN_STAR_FRAME_XLAYOUTMANAGER_HPP_
# include <com/sun/star/frame/XLayoutManager.hpp>
2004-02-25 16:35:13 +00:00
# endif
2000-09-18 15:33:13 +00:00
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
2002-04-22 06:05:16 +00:00
# ifndef INCLUDED_SVTOOLS_CMDOPTIONS_HXX
# include <svtools/cmdoptions.hxx>
# endif
2000-09-18 15:33:13 +00:00
# ifndef _CPPUHELPER_INTERFACECONTAINER_HXX_
# include <cppuhelper/interfacecontainer.hxx>
# endif
# ifndef _CPPUHELPER_WEAK_HXX_
# include <cppuhelper/weak.hxx>
# endif
# ifndef _RTL_STRING_HXX_
# include <rtl/string.hxx>
# endif
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework {
//_________________________________________________________________________________________________________________
// exported const
//_________________________________________________________________________________________________________________
2002-05-23 11:54:59 +00:00
// This enum can be used to set differnt active states of frames
2001-05-02 11:58:40 +00:00
enum EActiveState
2001-03-29 12:17:17 +00:00
{
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!
2001-03-29 12:17:17 +00:00
} ;
2000-09-18 15:33:13 +00:00
//_________________________________________________________________________________________________________________
// exported definitions
//_________________________________________________________________________________________________________________
/*-************************************************************************************************************/ /**
@ short implements a normal frame of hierarchy
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
2000-09-18 15:33:13 +00:00
set / get of a frame window , component or controller .
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 )
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
2001-05-02 11:58:40 +00:00
OPropertySetHelper
2002-05-23 11:54:59 +00:00
implements the property set
@ base OWeakObject
provides the refcount and XInterface , XWeak
2000-09-18 15:33:13 +00:00
2001-05-02 11:58:40 +00:00
@ devstatus ready to use
@ threadsafe yes
2004-11-16 13:49:35 +00:00
@ modified 04.10 .2004 10 : 47 , as96863
2000-09-18 15:33:13 +00:00
*/ /*-*************************************************************************************************************/
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 ,
public css : : frame : : XDispatchProviderInterception ,
2004-11-16 13:49:35 +00:00
public css : : frame : : XDispatchInformationProvider ,
2001-05-02 11:58:40 +00:00
public css : : task : : XStatusIndicatorFactory ,
public css : : awt : : XWindowListener , // => XEventListener
public css : : awt : : XTopWindowListener ,
public css : : awt : : XFocusListener ,
2001-08-16 08:45:37 +00:00
public css : : document : : XActionLockable ,
2002-05-23 11:54:59 +00:00
public css : : util : : XCloseable , // => XCloseBroadcaster
2002-07-29 07:23:08 +00:00
public css : : frame : : XComponentLoader ,
2001-05-02 11:58:40 +00:00
// base classes
// Order is neccessary for right initialization of this class!
2006-02-07 09:23:32 +00:00
public ThreadHelpBase ,
public TransactionBase ,
public PropertySetHelper , // helper implements ThreadHelpbase, TransactionBase, XPropertySet, XPropertySetInfo
2005-07-12 13:12:14 +00:00
public : : cppu : : OWeakObject // helper implements XInterface, XWeak
2000-09-18 15:33:13 +00:00
{
//-------------------------------------------------------------------------------------------------------------
// public methods
//-------------------------------------------------------------------------------------------------------------
public :
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
Frame ( const css : : uno : : Reference < css : : lang : : XMultiServiceFactory > & xFactory ) ;
virtual ~ Frame ( ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
// XInterface, XTypeProvider, XServiceInfo
//---------------------------------------------------------------------------------------------------------
2006-06-19 09:59:28 +00:00
FWK_DECLARE_XINTERFACE
FWK_DECLARE_XTYPEPROVIDER
2000-09-18 15:33:13 +00:00
DECLARE_XSERVICEINFO
2002-07-29 07:23:08 +00:00
//---------------------------------------------------------------------------------------------------------
// 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 ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XFramesSupplier
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
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 ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XFrame
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
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 ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XComponent
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
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 ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XStatusIndicatorFactory
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
virtual css : : uno : : Reference < css : : task : : XStatusIndicator > SAL_CALL createStatusIndicator ( ) throw ( css : : uno : : RuntimeException ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XDispatchProvider
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
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 ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XDispatchProviderInterception
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
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 ) ;
2000-09-18 15:33:13 +00:00
2004-11-16 13:49:35 +00:00
//---------------------------------------------------------------------------------------------------------
// XDispatchInformationProvider
//---------------------------------------------------------------------------------------------------------
virtual css : : uno : : Sequence < sal_Int16 > SAL_CALL getSupportedCommandGroups ( ) throw ( css : : uno : : RuntimeException ) ;
virtual css : : uno : : Sequence < css : : frame : : DispatchInformation > SAL_CALL getConfigurableDispatchInformation ( sal_Int16 nCommandGroup ) throw ( css : : uno : : RuntimeException ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XWindowListener
2002-07-31 10:03:28 +00:00
// Attention: windowResized() and windowShown() are implement only! All other are empty!
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
virtual void SAL_CALL windowResized ( const css : : awt : : WindowEvent & aEvent ) throw ( css : : uno : : RuntimeException ) ;
2006-06-19 09:59:28 +00:00
virtual void SAL_CALL windowMoved ( const css : : awt : : WindowEvent & /*aEvent*/ ) throw ( css : : uno : : RuntimeException ) { } ;
2002-07-31 10:03:28 +00:00
virtual void SAL_CALL windowShown ( const css : : lang : : EventObject & aEvent ) throw ( css : : uno : : RuntimeException ) ;
2003-03-25 17:22:13 +00:00
virtual void SAL_CALL windowHidden ( const css : : lang : : EventObject & aEvent ) throw ( css : : uno : : RuntimeException ) ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XFocusListener
// Attention: focusLost() not implemented yet!
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
virtual void SAL_CALL focusGained ( const css : : awt : : FocusEvent & aEvent ) throw ( css : : uno : : RuntimeException ) ;
2006-06-19 09:59:28 +00:00
virtual void SAL_CALL focusLost ( const css : : awt : : FocusEvent & /*aEvent*/ ) throw ( css : : uno : : RuntimeException ) { } ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
// XTopWindowListener
2002-05-23 11:54:59 +00:00
// Attention: windowActivated(), windowDeactivated() and windowClosing() are implement only! All other are empty!
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
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 ) ;
2006-06-19 09:59:28 +00:00
virtual void SAL_CALL windowOpened ( const css : : lang : : EventObject & /*aEvent*/ ) throw ( css : : uno : : RuntimeException ) { } ;
2002-05-23 11:54:59 +00:00
virtual void SAL_CALL windowClosing ( const css : : lang : : EventObject & aEvent ) throw ( css : : uno : : RuntimeException ) ;
2006-06-19 09:59:28 +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 ) { } ;
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-06-19 09:37:05 +00:00
// XEventListener
2000-09-18 15:33:13 +00:00
//---------------------------------------------------------------------------------------------------------
2001-05-02 11:58:40 +00:00
virtual void SAL_CALL disposing ( const css : : lang : : EventObject & aEvent ) throw ( css : : uno : : RuntimeException ) ;
2000-09-18 15:33:13 +00:00
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 ) ;
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 ) ;
2001-05-02 11:58:40 +00:00
//---------------------------------------------------------------------------------------------------------
2005-07-12 13:12:14 +00:00
// PropertySetHelper => XPropertySet, XPropertySetInfo
2001-05-02 11:58:40 +00:00
//---------------------------------------------------------------------------------------------------------
2005-07-12 13:12:14 +00:00
private :
void impl_initializePropInfo ( ) ;
virtual void SAL_CALL impl_setPropertyValue ( const : : rtl : : OUString & sProperty ,
sal_Int32 nHandle ,
const css : : uno : : Any & aValue ) ;
virtual css : : uno : : Any SAL_CALL impl_getPropertyValue ( const : : rtl : : OUString & sProperty ,
sal_Int32 nHandle ) ;
2001-05-02 11:58:40 +00:00
2000-09-18 15:33:13 +00:00
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private :
/*-****************************************************************************************************/ /**
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 ! ) .
2000-09-18 15:33:13 +00:00
2001-05-02 11:58:40 +00:00
@ attention Threadsafe methods are signed by " implts_... " !
2000-09-18 15:33:13 +00:00
*/ /*-*****************************************************************************************************/
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 ;
2001-10-26 08:46:09 +00:00
void implts_setIconOnWindow ( ) ;
2001-06-19 09:37:05 +00:00
void implts_startWindowListening ( ) ;
void implts_stopWindowListening ( ) ;
2002-05-23 11:54:59 +00:00
void implts_saveWindowAttributes ( ) ;
void implts_checkSuicide ( ) ;
DECL_LINK ( implts_windowClosing , void * ) ;
2006-09-08 07:31:16 +00:00
css : : uno : : Reference < css : : awt : : XTopWindow > impl_searchTopWindow ( const css : : uno : : Reference < css : : awt : : XWindow > & xWindow ) ;
2002-05-23 11:54:59 +00:00
2001-05-02 11:58:40 +00:00
// non threadsafe
2003-03-25 17:22:13 +00:00
void impl_checkMenuCloser ( ) ;
void impl_setCloser ( const css : : uno : : Reference < css : : frame : : XFrame > & xFrame ,
sal_Bool bState ) ;
2001-06-11 11:52:42 +00:00
void impl_disposeContainerWindow ( css : : uno : : Reference < css : : awt : : XWindow > & xWindow ) ;
2001-05-02 11:58:40 +00:00
static const css : : uno : : Sequence < css : : beans : : Property > impl_getStaticPropertyDescriptor ( ) ;
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 ( . . . ) .
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 !
2000-09-18 15:33:13 +00:00
@ seealso ASSERTs in implementation !
@ param references to checking variables
2001-05-02 11:58:40 +00:00
@ return sal_True , on invalid parameter
@ return sal_False , otherwise
2000-09-18 15:33:13 +00:00
2001-05-02 11:58:40 +00:00
@ onerror We return sal_True
2000-09-18 15:33:13 +00:00
*/ /*-*****************************************************************************************************/
# ifdef ENABLE_ASSERTIONS
private :
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 ) ;
2000-09-18 15:33:13 +00:00
# endif // #ifdef ENABLE_ASSERTIONS
2001-05-02 11:58:40 +00:00
//*************************************************************************************************************
2000-09-18 15:33:13 +00:00
// variables
2001-05-02 11:58:40 +00:00
// -threadsafe by own read/write lock "m_aLock"
//*************************************************************************************************************
private :
2000-09-18 15:33:13 +00:00
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
2004-11-26 13:29:44 +00:00
css : : uno : : WeakReference < css : : task : : XStatusIndicator > m_xIndicatorInterception ; /// points to an external set progress, which should be used instead of the internal one.
2001-06-19 09:37:05 +00:00
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
2001-08-16 08:45:37 +00:00
sal_Int16 m_nExternalLockCount ;
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!
2002-04-22 06:05:16 +00:00
SvtCommandOptions m_aCommandOptions ; /// ref counted class to support disabling commands defined by configuration file
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
2003-03-25 17:22:13 +00:00
sal_Bool m_bIsHidden ; /// indicates, if this frame is used in hidden mode or not
static css : : uno : : WeakReference < css : : frame : : XFrame > m_xCloserFrame ; /// holds the only frame, which must show the special closer menu item (can be NULL!)
2005-03-01 18:25:24 +00:00
css : : uno : : Reference < : : com : : sun : : star : : frame : : XLayoutManager > m_xLayoutManager ; /// is used to layout the child windows of the frame.
2004-11-16 13:49:35 +00:00
css : : uno : : Reference < css : : frame : : XDispatchInformationProvider > m_xDispatchInfoHelper ;
2004-11-26 13:29:44 +00:00
2001-05-02 11:58:40 +00:00
protected :
2000-09-18 15:33:13 +00:00
2001-06-19 09:37:05 +00:00
FrameContainer m_aChildFrameContainer ; /// array of child frames
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 ;
}
2000-09-18 15:33:13 +00:00
} ; // class Frame
} // namespace framework
# endif // #ifndef __FRAMEWORK_SERVICES_FRAME_HXX_
