xref: /trunk/main/framework/inc/dispatch/selfdispatcher.hxx (revision 914d351e5f5b84e4342a86d6ab8d4aca7308b9bd)
1f8e07b45SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3f8e07b45SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4f8e07b45SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5f8e07b45SAndrew Rist  * distributed with this work for additional information
6f8e07b45SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7f8e07b45SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8f8e07b45SAndrew Rist  * "License"); you may not use this file except in compliance
9f8e07b45SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11f8e07b45SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13f8e07b45SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14f8e07b45SAndrew Rist  * software distributed under the License is distributed on an
15f8e07b45SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16f8e07b45SAndrew Rist  * KIND, either express or implied.  See the License for the
17f8e07b45SAndrew Rist  * specific language governing permissions and limitations
18f8e07b45SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20f8e07b45SAndrew Rist  *************************************************************/
21f8e07b45SAndrew Rist 
22f8e07b45SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef __FRAMEWORK_DISPATCH_SELFDISPATCHER_HXX_
25cdf0e10cSrcweir #define __FRAMEWORK_DISPATCH_SELFDISPATCHER_HXX_
26cdf0e10cSrcweir 
27cdf0e10cSrcweir //_________________________________________________________________________________________________________________
28cdf0e10cSrcweir //  my own includes
29cdf0e10cSrcweir //_________________________________________________________________________________________________________________
30cdf0e10cSrcweir 
31cdf0e10cSrcweir #include <dispatch/basedispatcher.hxx>
32cdf0e10cSrcweir 
33cdf0e10cSrcweir //_________________________________________________________________________________________________________________
34cdf0e10cSrcweir //  interface includes
35cdf0e10cSrcweir //_________________________________________________________________________________________________________________
36cdf0e10cSrcweir 
37cdf0e10cSrcweir //_________________________________________________________________________________________________________________
38cdf0e10cSrcweir //  other includes
39cdf0e10cSrcweir //_________________________________________________________________________________________________________________
40cdf0e10cSrcweir 
41cdf0e10cSrcweir //_________________________________________________________________________________________________________________
42cdf0e10cSrcweir //  namespace
43cdf0e10cSrcweir //_________________________________________________________________________________________________________________
44cdf0e10cSrcweir 
45cdf0e10cSrcweir namespace framework{
46cdf0e10cSrcweir 
47cdf0e10cSrcweir //_________________________________________________________________________________________________________________
48cdf0e10cSrcweir //  exported const
49cdf0e10cSrcweir //_________________________________________________________________________________________________________________
50cdf0e10cSrcweir 
51cdf0e10cSrcweir //_________________________________________________________________________________________________________________
52cdf0e10cSrcweir //  exported definitions
53cdf0e10cSrcweir //_________________________________________________________________________________________________________________
54cdf0e10cSrcweir 
55cdf0e10cSrcweir /*-************************************************************************************************************//**
56cdf0e10cSrcweir     @short          helper to dispatch into an existing owner frame
57cdf0e10cSrcweir     @descr          You should use it as dispatcher for "_self", flag::SELF ... cases, to load a document into an
58cdf0e10cSrcweir                     owner frame without creation of a new one.
59cdf0e10cSrcweir                     Use this class as member only! Never use it as baseclass.
60*b12a77c9Smseidel                     XInterface will be ambiguous and we hold a weakreference to our OWNER - not to our SUPERCLASS!
61cdf0e10cSrcweir 
62cdf0e10cSrcweir     @implements     XInterface
63cdf0e10cSrcweir                     XDispatch
64cdf0e10cSrcweir                     XStatusListener
65cdf0e10cSrcweir                     XLoadEventListener
66cdf0e10cSrcweir                     XEventListener
67cdf0e10cSrcweir 
68cdf0e10cSrcweir     @base           BaseDispatcher
69cdf0e10cSrcweir                     OWeakObject
70cdf0e10cSrcweir 
71cdf0e10cSrcweir     @devstatus      ready to use
72cdf0e10cSrcweir     @threadsafe     yes
73cdf0e10cSrcweir *//*-*************************************************************************************************************/
74cdf0e10cSrcweir class SelfDispatcher   :   // -interfaces  ... are supported by our BaseDispatcher!
7507a3d7f1SPedro Giffuni                            // -baseclasses ... order is necessary for right initialization!
76cdf0e10cSrcweir                            public BaseDispatcher
77cdf0e10cSrcweir {
78cdf0e10cSrcweir     //-------------------------------------------------------------------------------------------------------------
79cdf0e10cSrcweir     //  public methods
80cdf0e10cSrcweir     //-------------------------------------------------------------------------------------------------------------
81cdf0e10cSrcweir     public:
82cdf0e10cSrcweir         //  ctor
83cdf0e10cSrcweir                               SelfDispatcher      ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory   ,
84cdf0e10cSrcweir                                                     const css::uno::Reference< css::frame::XFrame >&              xTarget    );
85cdf0e10cSrcweir         //  XDispatch
86cdf0e10cSrcweir         virtual void SAL_CALL dispatch            ( const css::util::URL&                                         aURL       ,
87cdf0e10cSrcweir                                                     const css::uno::Sequence< css::beans::PropertyValue >&        lArguments ) throw( css::uno::RuntimeException );
88cdf0e10cSrcweir 
89cdf0e10cSrcweir     //-------------------------------------------------------------------------------------------------------------
90cdf0e10cSrcweir     //  protected methods
91cdf0e10cSrcweir     //-------------------------------------------------------------------------------------------------------------
92cdf0e10cSrcweir     protected:
93cdf0e10cSrcweir         virtual void SAL_CALL reactForLoadingState ( const css::util::URL&                                      aURL        ,
94cdf0e10cSrcweir                                                      const css::uno::Sequence< css::beans::PropertyValue >&     lDescriptor ,
95cdf0e10cSrcweir                                                      const css::uno::Reference< css::frame::XFrame >&           xTarget     ,
96cdf0e10cSrcweir                                                            sal_Bool                                             bState      ,
97cdf0e10cSrcweir                                                      const css::uno::Any&                                       aAsyncInfo  );
98cdf0e10cSrcweir 
99cdf0e10cSrcweir         virtual void SAL_CALL reactForHandlingState( const css::util::URL&                                      aURL        ,
100cdf0e10cSrcweir                                                      const css::uno::Sequence< css::beans::PropertyValue >&     lDescriptor ,
101cdf0e10cSrcweir                                                            sal_Bool                                             bState      ,
102cdf0e10cSrcweir                                                      const css::uno::Any&                                       aAsyncInfo  );
103cdf0e10cSrcweir 
104cdf0e10cSrcweir };      //  class SelfDispatcher
105cdf0e10cSrcweir 
106cdf0e10cSrcweir }       //  namespace framework
107cdf0e10cSrcweir 
108cdf0e10cSrcweir #endif  //  #ifndef __FRAMEWORK_DISPATCH_SELFDISPATCHER_HXX_
109