xref: /AOO41X/main/framework/inc/helper/uielementwrapperbase.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef __FRAMEWORK_HELPER_UIELEMENTWRAPPERBASE_HXX_
29*cdf0e10cSrcweir #define __FRAMEWORK_HELPER_UIELEMENTWRAPPERBASE_HXX_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
32*cdf0e10cSrcweir //	my own includes
33*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <threadhelp/threadhelpbase.hxx>
36*cdf0e10cSrcweir #include <macros/generic.hxx>
37*cdf0e10cSrcweir #include <macros/xinterface.hxx>
38*cdf0e10cSrcweir #include <macros/xtypeprovider.hxx>
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
41*cdf0e10cSrcweir //	interface includes
42*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
43*cdf0e10cSrcweir #include <com/sun/star/ui/XUIElement.hpp>
44*cdf0e10cSrcweir #include <com/sun/star/lang/XInitialization.hpp>
45*cdf0e10cSrcweir #include <com/sun/star/lang/XComponent.hpp>
46*cdf0e10cSrcweir #include <com/sun/star/frame/XFrame.hpp>
47*cdf0e10cSrcweir #include <com/sun/star/util/XUpdatable.hpp>
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
50*cdf0e10cSrcweir //	other includes
51*cdf0e10cSrcweir //_________________________________________________________________________________________________________________
52*cdf0e10cSrcweir #include <rtl/ustring.hxx>
53*cdf0e10cSrcweir #include <cppuhelper/propshlp.hxx>
54*cdf0e10cSrcweir #include <cppuhelper/interfacecontainer.hxx>
55*cdf0e10cSrcweir #include <cppuhelper/weak.hxx>
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir namespace framework
58*cdf0e10cSrcweir {
59*cdf0e10cSrcweir 
60*cdf0e10cSrcweir class UIElementWrapperBase : public ::com::sun::star::lang::XTypeProvider       ,
61*cdf0e10cSrcweir                              public ::com::sun::star::ui::XUIElement    ,
62*cdf0e10cSrcweir                              public ::com::sun::star::lang::XInitialization     ,
63*cdf0e10cSrcweir                              public ::com::sun::star::lang::XComponent          ,
64*cdf0e10cSrcweir                              public ::com::sun::star::util::XUpdatable          ,
65*cdf0e10cSrcweir                              protected ThreadHelpBase                           ,
66*cdf0e10cSrcweir                              public ::cppu::OBroadcastHelper                    ,
67*cdf0e10cSrcweir                              public ::cppu::OPropertySetHelper                  ,
68*cdf0e10cSrcweir                              public ::cppu::OWeakObject
69*cdf0e10cSrcweir {
70*cdf0e10cSrcweir 	//-------------------------------------------------------------------------------------------------------------
71*cdf0e10cSrcweir 	//	public methods
72*cdf0e10cSrcweir 	//-------------------------------------------------------------------------------------------------------------
73*cdf0e10cSrcweir     public:
74*cdf0e10cSrcweir          UIElementWrapperBase( sal_Int16 nType );
75*cdf0e10cSrcweir         virtual  ~UIElementWrapperBase();
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir         //  XInterface
78*cdf0e10cSrcweir         virtual  ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& aType ) throw( ::com::sun::star::uno::RuntimeException );
79*cdf0e10cSrcweir         virtual  void SAL_CALL acquire() throw();
80*cdf0e10cSrcweir         virtual  void SAL_CALL release() throw();
81*cdf0e10cSrcweir 
82*cdf0e10cSrcweir         // XTypeProvider
83*cdf0e10cSrcweir         virtual  ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type >  SAL_CALL getTypes() throw( ::com::sun::star::uno::RuntimeException );
84*cdf0e10cSrcweir         virtual  ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw( ::com::sun::star::uno::RuntimeException );
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir         // XComponent
87*cdf0e10cSrcweir         virtual  void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException) = 0;
88*cdf0e10cSrcweir         virtual  void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
89*cdf0e10cSrcweir         virtual  void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException);
90*cdf0e10cSrcweir 
91*cdf0e10cSrcweir         // XInitialization
92*cdf0e10cSrcweir         virtual  void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
93*cdf0e10cSrcweir 
94*cdf0e10cSrcweir         // XUpdatable
95*cdf0e10cSrcweir         virtual  void SAL_CALL update() throw (::com::sun::star::uno::RuntimeException);
96*cdf0e10cSrcweir 
97*cdf0e10cSrcweir         // XUIElement
98*cdf0e10cSrcweir         virtual  ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame > SAL_CALL getFrame() throw (::com::sun::star::uno::RuntimeException);
99*cdf0e10cSrcweir         virtual  ::rtl::OUString SAL_CALL getResourceURL() throw (::com::sun::star::uno::RuntimeException);
100*cdf0e10cSrcweir         virtual  ::sal_Int16 SAL_CALL getType() throw (::com::sun::star::uno::RuntimeException);
101*cdf0e10cSrcweir         virtual  ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getRealInterface() throw (::com::sun::star::uno::RuntimeException) = 0;
102*cdf0e10cSrcweir 
103*cdf0e10cSrcweir 	//-------------------------------------------------------------------------------------------------------------
104*cdf0e10cSrcweir 	//	protected methods
105*cdf0e10cSrcweir 	//-------------------------------------------------------------------------------------------------------------
106*cdf0e10cSrcweir 	protected:
107*cdf0e10cSrcweir 
108*cdf0e10cSrcweir 		//	OPropertySetHelper
109*cdf0e10cSrcweir         virtual  sal_Bool                                            SAL_CALL convertFastPropertyValue        ( com::sun::star::uno::Any&        aConvertedValue ,
110*cdf0e10cSrcweir                                                                                                                com::sun::star::uno::Any&        aOldValue       ,
111*cdf0e10cSrcweir                                                                                                                sal_Int32                        nHandle         ,
112*cdf0e10cSrcweir                                                                                                                const com::sun::star::uno::Any&  aValue          ) throw( com::sun::star::lang::IllegalArgumentException );
113*cdf0e10cSrcweir         virtual  void                                                SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32                        nHandle         ,
114*cdf0e10cSrcweir                                                                                                                const com::sun::star::uno::Any&  aValue          ) throw( com::sun::star::uno::Exception                 );
115*cdf0e10cSrcweir         using cppu::OPropertySetHelper::getFastPropertyValue;
116*cdf0e10cSrcweir         virtual  void                                                SAL_CALL getFastPropertyValue( com::sun::star::uno::Any&    aValue          ,
117*cdf0e10cSrcweir                                                                                                    sal_Int32                    nHandle         ) const;
118*cdf0e10cSrcweir         virtual  ::cppu::IPropertyArrayHelper&                       SAL_CALL getInfoHelper();
119*cdf0e10cSrcweir         virtual  ::com::sun::star::uno::Reference< com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() throw (::com::sun::star::uno::RuntimeException);
120*cdf0e10cSrcweir 
121*cdf0e10cSrcweir         static  const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > impl_getStaticPropertyDescriptor();
122*cdf0e10cSrcweir 
123*cdf0e10cSrcweir         ::cppu::OMultiTypeInterfaceContainerHelper                          m_aListenerContainer;   /// container for ALL Listener
124*cdf0e10cSrcweir         rtl::OUString                                                       m_aResourceURL;
125*cdf0e10cSrcweir         com::sun::star::uno::WeakReference< com::sun::star::frame::XFrame > m_xWeakFrame;
126*cdf0e10cSrcweir         sal_Int16                                                           m_nType;
127*cdf0e10cSrcweir         sal_Bool                                                            m_bInitialized : 1,
128*cdf0e10cSrcweir                                                                             m_bDisposed;
129*cdf0e10cSrcweir };
130*cdf0e10cSrcweir 
131*cdf0e10cSrcweir } // namespace framework
132*cdf0e10cSrcweir 
133*cdf0e10cSrcweir #endif // __FRAMEWORK_HELPER_UIELEMENTWRAPPERBASE_HXX_
134