?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
bump product version to 4.1.6.2
[LibreOffice.git] / framework / inc / services / desktop.hxx
bloba4b98ddcb4fd902eb114027b766cb38b87b82ca8
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20 #ifndef __FRAMEWORK_SERVICES_DESKTOP_HXX_
21 #define __FRAMEWORK_SERVICES_DESKTOP_HXX_
22
23 #include <classes/framecontainer.hxx>
24 #include <threadhelp/threadhelpbase.hxx>
25 #include <helper/oframes.hxx>
26 #include <macros/generic.hxx>
27 #include <macros/debug.hxx>
28 #include <macros/xinterface.hxx>
29 #include <macros/xtypeprovider.hxx>
30 #include <macros/xserviceinfo.hxx>
31
32 #include <com/sun/star/frame/XUntitledNumbers.hpp>
33
34 #include <com/sun/star/frame/XController.hpp>
35 #include <com/sun/star/frame/XDesktop2.hpp>
36 #include <com/sun/star/frame/WindowArrange.hpp>
37 #include <com/sun/star/frame/TerminationVetoException.hpp>
38 #include <com/sun/star/frame/XTerminateListener.hpp>
39 #include <com/sun/star/frame/XWindowArranger.hpp>
40 #include <com/sun/star/frame/XTask.hpp>
41 #include <com/sun/star/frame/XStorable.hpp>
42 #include <com/sun/star/frame/XModel.hpp>
43 #include <com/sun/star/frame/XFramesSupplier.hpp>
44 #include <com/sun/star/frame/XFrames.hpp>
45 #include <com/sun/star/lang/XServiceName.hpp>
46 #include <com/sun/star/frame/XDispatchProvider.hpp>
47 #include <com/sun/star/frame/XDispatchProviderInterception.hpp>
48 #include <com/sun/star/frame/XComponentLoader.hpp>
49 #include <com/sun/star/frame/FrameAction.hpp>
50 #include <com/sun/star/frame/XTasksSupplier.hpp>
51 #include <com/sun/star/container/XEnumerationAccess.hpp>
52 #include <com/sun/star/lang/Locale.hpp>
53 #include <com/sun/star/frame/XDispatchResultListener.hpp>
54 #include <com/sun/star/lang/XEventListener.hpp>
55 #include <com/sun/star/frame/FeatureStateEvent.hpp>
56 #include <com/sun/star/task/XInteractionHandler.hpp>
57 #include <com/sun/star/frame/XDispatchRecorderSupplier.hpp>
58
59 #include <unotools/cmdoptions.hxx>
60 #include <cppuhelper/propshlp.hxx>
61 #include <cppuhelper/interfacecontainer.hxx>
62 #include <cppuhelper/weak.hxx>
63
64 #include <comphelper/numberedcollection.hxx>
65
66 namespace framework{
67
68 enum ELoadState
69 {
70 E_NOTSET ,
71 E_SUCCESSFUL ,
72 E_FAILED ,
73 E_INTERACTION
74 };
75
76 /*-************************************************************************************************************//**
77 @short implement the topframe of frame tree
78 @descr This is the root of the frame tree. The desktop has no window, is not visible but he is the logical
79 "masternode" to build the hierarchy.
80
81 @implements XInterface
82 XTypeProvider
83 XServiceInfo
84 XDesktop
85 XComponentLoader
86 XTasksSupplier
87 XDispatchProvider
88 XFramesSupplier
89 XFrame
90 XComponent
91 XPropertySet
92 XFastPropertySet
93 XMultiPropertySet
94 XDispatchResultListener
95 XEventListener
96 XInteractionHandler
97
98 @base ThreadHelpBase
99 TransactionBase
100 OBroadcastHelper
101 OPropertySetHelper
102
103 @devstatus ready to use
104 @threadsafe yes
105 *//*-*************************************************************************************************************/
106 class Desktop : // interfaces
107 public css::lang::XTypeProvider ,
108 public css::lang::XServiceInfo ,
109 public css::frame::XDesktop2 ,
110 public css::frame::XTasksSupplier ,
111 public css::frame::XDispatchResultListener , // => XEventListener
112 public css::task::XInteractionHandler ,
113 public css::frame::XUntitledNumbers ,
114 // base classes
115 // Order is necessary for right initialization!
116 private ThreadHelpBase ,
117 private TransactionBase ,
118 public ::cppu::OBroadcastHelper ,
119 public ::cppu::OPropertySetHelper ,
120 public ::cppu::OWeakObject
121 {
122 // internal used types, const etcpp.
123 private:
124
125 //---------------------------------------------------------------------
126 /** used temporary to know which listener was already called or not. */
127 typedef ::std::vector< css::uno::Reference< css::frame::XTerminateListener > > TTerminateListenerList;
128
129 // public methods
130 public:
131
132 // constructor / destructor
133 Desktop( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
134 virtual ~Desktop( );
135
136 // XInterface, XTypeProvider, XServiceInfo
137 FWK_DECLARE_XINTERFACE
138 FWK_DECLARE_XTYPEPROVIDER
139 DECLARE_XSERVICEINFO
140
141 //---------------------------------------------------------------------
142 /**
143 @interface XDesktop
144
145 @short try to shutdown these desktop environment.
146
147 @descr Will try to close all frames. If at least one frame could
148 not be closed successfully termination will be stopped.
149
150 Registered termination listener will be taken into account
151 also. As special feature some of our registered listener
152 are well known by it's UNO implementation name. They are handled
153 different to all other listener.
154
155 Btw: Desktop.terminate() was designed in the past to be used
156 within an UI based envrionment. So it's allowed e.g. to
157 call XController.suspend() here. If UI isnt an option ... please
158 use XCloseable.close() at these desktop implementation.
159 ... if it will be supported in the future .-))
160
161 @seealso XTerminateListener
162 @seealso XTerminateListener2
163
164 @return true if all open frames could be closed and no listener throwed
165 a veto exception; false otherwise.
166
167 @onerror False will be returned.
168 @threadsafe yes
169 */
170 virtual ::sal_Bool SAL_CALL terminate()
171 throw( css::uno::RuntimeException );
172
173 //---------------------------------------------------------------------
174 /**
175 @interface XDesktop
176
177 @short add a listener for termination events
178
179 @descr Additional to adding normal listener these method was implemented special.
180 Every listener will be asked for it's uno implementation name.
181 Some of them are well known ... and the corresponding listener wont be added
182 to the container of "normal listener". Those listener will be set as special
183 member.
184 see e.g. member m_xSfxTerminator
185
186 @seealso terminate()
187
188 @param xListener
189 the listener for registration.
190
191 @threadsafe yes
192 */
193 virtual void SAL_CALL addTerminateListener( const css::uno::Reference< css::frame::XTerminateListener >& xListener )
194 throw( css::uno::RuntimeException );
195
196 //---------------------------------------------------------------------
197 /**
198 @interface XDesktop
199
200 @short remove a listener from this container.
201
202 @descr Additional to removing normal listener these method was implemented special.
203 Every listener will be asked for it's uno implementation name.
204 Some of them are well known ... and the corresponding listener was set as special member.
205 Now those special member will be reseted also.
206 see e.g. member m_xSfxTerminator
207
208 @seealso terminate()
209
210 @param xListener
211 the listener for deregistration.
212
213 @threadsafe yes
214 */
215 virtual void SAL_CALL removeTerminateListener( const css::uno::Reference< css::frame::XTerminateListener >& xListener )
216 throw( css::uno::RuntimeException );
217
218 virtual css::uno::Reference< css::container::XEnumerationAccess > SAL_CALL getComponents ( ) throw( css::uno::RuntimeException );
219 virtual css::uno::Reference< css::lang::XComponent > SAL_CALL getCurrentComponent ( ) throw( css::uno::RuntimeException );
220 virtual css::uno::Reference< css::frame::XFrame > SAL_CALL getCurrentFrame ( ) throw( css::uno::RuntimeException );
221
222 // XComponentLoader
223 virtual css::uno::Reference< css::lang::XComponent > SAL_CALL loadComponentFromURL ( const OUString& sURL ,
224 const OUString& sTargetFrameName ,
225 sal_Int32 nSearchFlags ,
226 const css::uno::Sequence< css::beans::PropertyValue >& lArguments ) throw( css::io::IOException ,
227 css::lang::IllegalArgumentException ,
228 css::uno::RuntimeException );
229
230 // XTasksSupplier
231 virtual css::uno::Reference< css::container::XEnumerationAccess > SAL_CALL getTasks ( ) throw( css::uno::RuntimeException );
232 virtual css::uno::Reference< css::frame::XTask > SAL_CALL getActiveTask ( ) throw( css::uno::RuntimeException );
233
234 // XDispatchProvider
235 virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch ( const css::util::URL& aURL ,
236 const OUString& sTargetFrameName ,
237 sal_Int32 nSearchFlags ) throw( css::uno::RuntimeException );
238 virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches ( const css::uno::Sequence< css::frame::DispatchDescriptor >& lQueries ) throw( css::uno::RuntimeException );
239
240 // XDispatchProviderInterception
241 virtual void SAL_CALL registerDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor) throw( css::uno::RuntimeException);
242 virtual void SAL_CALL releaseDispatchProviderInterceptor ( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor) throw( css::uno::RuntimeException);
243
244 // XFramesSupplier
245 virtual css::uno::Reference< css::frame::XFrames > SAL_CALL getFrames ( ) throw( css::uno::RuntimeException );
246 virtual css::uno::Reference< css::frame::XFrame > SAL_CALL getActiveFrame ( ) throw( css::uno::RuntimeException );
247 virtual void SAL_CALL setActiveFrame ( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException );
248
249 // XFrame
250 // Attention: findFrame() is implemented only! Other methods make no sense for our desktop!
251 virtual css::uno::Reference< css::frame::XFrame > SAL_CALL findFrame ( const OUString& sTargetFrameName ,
252 sal_Int32 nSearchFlags ) throw( css::uno::RuntimeException );
253 virtual void SAL_CALL initialize ( const css::uno::Reference< css::awt::XWindow >& xWindow ) throw( css::uno::RuntimeException );
254 virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getContainerWindow ( ) throw( css::uno::RuntimeException );
255 virtual void SAL_CALL setCreator ( const css::uno::Reference< css::frame::XFramesSupplier >& xCreator ) throw( css::uno::RuntimeException );
256 virtual css::uno::Reference< css::frame::XFramesSupplier > SAL_CALL getCreator ( ) throw( css::uno::RuntimeException );
257 virtual OUString SAL_CALL getName ( ) throw( css::uno::RuntimeException );
258 virtual void SAL_CALL setName ( const OUString& sName ) throw( css::uno::RuntimeException );
259 virtual sal_Bool SAL_CALL isTop ( ) throw( css::uno::RuntimeException );
260 virtual void SAL_CALL activate ( ) throw( css::uno::RuntimeException );
261 virtual void SAL_CALL deactivate ( ) throw( css::uno::RuntimeException );
262 virtual sal_Bool SAL_CALL isActive ( ) throw( css::uno::RuntimeException );
263 virtual sal_Bool SAL_CALL setComponent ( const css::uno::Reference< css::awt::XWindow >& xComponentWindow ,
264 const css::uno::Reference< css::frame::XController >& xController ) throw( css::uno::RuntimeException );
265 virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getComponentWindow ( ) throw( css::uno::RuntimeException );
266 virtual css::uno::Reference< css::frame::XController > SAL_CALL getController ( ) throw( css::uno::RuntimeException );
267 virtual void SAL_CALL contextChanged ( ) throw( css::uno::RuntimeException );
268 virtual void SAL_CALL addFrameActionListener ( const css::uno::Reference< css::frame::XFrameActionListener >& xListener ) throw( css::uno::RuntimeException );
269 virtual void SAL_CALL removeFrameActionListener ( const css::uno::Reference< css::frame::XFrameActionListener >& xListener ) throw( css::uno::RuntimeException );
270
271 // XComponent
272 using cppu::OPropertySetHelper::disposing;
273 virtual void SAL_CALL dispose ( ) throw( css::uno::RuntimeException );
274 virtual void SAL_CALL addEventListener ( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw( css::uno::RuntimeException );
275 virtual void SAL_CALL removeEventListener ( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw( css::uno::RuntimeException );
276
277 // XDispatchResultListener
278 virtual void SAL_CALL dispatchFinished ( const css::frame::DispatchResultEvent& aEvent ) throw( css::uno::RuntimeException );
279
280 // XEventListener
281 virtual void SAL_CALL disposing ( const css::lang::EventObject& aSource ) throw( css::uno::RuntimeException );
282
283 // XInteractionHandler
284 virtual void SAL_CALL handle ( const css::uno::Reference< css::task::XInteractionRequest >& xRequest ) throw( css::uno::RuntimeException );
285
286 // css.frame.XUntitledNumbers
287 virtual ::sal_Int32 SAL_CALL leaseNumber( const css::uno::Reference< css::uno::XInterface >& xComponent )
288 throw (css::lang::IllegalArgumentException,
289 css::uno::RuntimeException );
290
291 // css.frame.XUntitledNumbers
292 virtual void SAL_CALL releaseNumber( ::sal_Int32 nNumber )
293 throw (css::lang::IllegalArgumentException,
294 css::uno::RuntimeException );
295
296 // css.frame.XUntitledNumbers
297 virtual void SAL_CALL releaseNumberForComponent( const css::uno::Reference< css::uno::XInterface >& xComponent )
298 throw (css::lang::IllegalArgumentException,
299 css::uno::RuntimeException );
300
301 // css.frame.XUntitledNumbers
302 virtual OUString SAL_CALL getUntitledPrefix()
303 throw (css::uno::RuntimeException);
304
305 // we need this wrapped terminate()-call to terminate even the QuickStarter
306 // non-virtual and non-UNO for now
307 bool SAL_CALL terminateQuickstarterToo()
308 throw( css::uno::RuntimeException );
309 //-------------------------------------------------------------------------------------------------------------
310 // protected methods
311 //-------------------------------------------------------------------------------------------------------------
312 protected:
313
314 // OPropertySetHelper
315 virtual sal_Bool SAL_CALL convertFastPropertyValue ( css::uno::Any& aConvertedValue ,
316 css::uno::Any& aOldValue ,
317 sal_Int32 nHandle ,
318 const css::uno::Any& aValue ) throw( css::lang::IllegalArgumentException );
319 virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle ,
320 const css::uno::Any& aValue ) throw( css::uno::Exception );
321 using cppu::OPropertySetHelper::getFastPropertyValue;
322 virtual void SAL_CALL getFastPropertyValue ( css::uno::Any& aValue ,
323 sal_Int32 nHandle ) const;
324 virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper ( );
325 virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo ( ) throw (css::uno::RuntimeException);
326
327 //-------------------------------------------------------------------------------------------------------------
328 // private methods
329 //-------------------------------------------------------------------------------------------------------------
330 private:
331
332 css::uno::Reference< css::lang::XComponent > impl_getFrameComponent ( const css::uno::Reference< css::frame::XFrame >& xFrame ) const;
333 static const css::uno::Sequence< css::beans::Property > impl_getStaticPropertyDescriptor( );
334
335 //---------------------------------------------------------------------
336 /** calls queryTermination() on every registered termination listener.
337 *
338 * Note: Only normal termination listener (registered in list m_aListenerContainer
339 * will be recognized here. Special listener like quick starter, pipe or others
340 * has to be handled explicitly !
341 *
342 * @param [out] lCalledListener
343 * every called listener will be returned here.
344 * Those list will be used to informa all called listener
345 * about cancel this termination request.
346 *
347 * @param [out] bVeto
348 * will be true if at least one listener throwed a veto exception;
349 * false otherwise.
350 *
351 * @see impl_sendCancelTerminationEvent()
352 */
353 void impl_sendQueryTerminationEvent(TTerminateListenerList& lCalledListener,
354 ::sal_Bool& bVeto );
355
356 //---------------------------------------------------------------------
357 /** calls cancelTermination() on every termination listener
358 * where queryTermination() was called before.
359 *
360 * Note: Only normal termination listener (registered in list m_aListenerContainer
361 * will be recognized here. Special listener like quick starter, pipe or others
362 * has to be handled explicitly !
363 *
364 * @param [in] lCalledListener
365 * every listener in this list was called within its method
366 * queryTermination() before.
367 *
368 * @see impl_sendQueryTerminationEvent()
369 */
370 void impl_sendCancelTerminationEvent(const TTerminateListenerList& lCalledListener);
371
372 //---------------------------------------------------------------------
373 /** calls notifyTermination() on every registered termination listener.
374 *
375 * Note: Only normal termination listener (registered in list m_aListenerContainer
376 * will be recognized here. Special listener like quick starter, pipe or others
377 * has to be handled explicitly !
378 */
379 void impl_sendNotifyTerminationEvent();
380
381 //---------------------------------------------------------------------
382 /** try to close all open frames.
383 *
384 * Iterates over all child frames and try to close them.
385 * Given parameter bAllowUI enable/disable showing any UI
386 * (which mostly occure on calling XController->suspend()).
387 *
388 * These method doesnt stop if one frame could not be closed.
389 * It will ignore such frames and try all other ones.
390 * But it returns false in such case - true otherwise.
391 *
392 * @param bAllowUI
393 * enable/disable showing of UI.
394 *
395 * @return true if all frames could be closed; false otherwise.
396 */
397 ::sal_Bool impl_closeFrames(::sal_Bool bAllowUI);
398
399 //-------------------------------------------------------------------------------------------------------------
400 // debug methods
401 // (should be private everytime!)
402 //-------------------------------------------------------------------------------------------------------------
403 #ifdef ENABLE_ASSERTIONS
404 private:
405
406 static sal_Bool implcp_ctor ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
407 static sal_Bool implcp_addEventListener ( const css::uno::Reference< css::lang::XEventListener >& xListener );
408 static sal_Bool implcp_removeEventListener ( const css::uno::Reference< css::lang::XEventListener >& xListener );
409
410 sal_Bool m_bIsTerminated ; /// check flag to protect us against dispose before terminate!
411 /// see dispose() for further information!
412
413 #endif // #ifdef ENABLE_ASSERTIONS
414
415 //-------------------------------------------------------------------------------------------------------------
416 // variables
417 // (should be private everytime!)
418 //-------------------------------------------------------------------------------------------------------------
419 private:
420
421 css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory ; /// reference to factory, which has create this instance
422 FrameContainer m_aChildTaskContainer ; /// array of child tasks (children of desktop are tasks; and tasks are also frames - But pure frames are not accepted!)
423 ::cppu::OMultiTypeInterfaceContainerHelper m_aListenerContainer ; /// container for ALL Listener
424 css::uno::Reference< css::frame::XFrames > m_xFramesHelper ; /// helper for XFrames, XIndexAccess, XElementAccess and implementation of a childcontainer!
425 css::uno::Reference< css::frame::XDispatchProvider > m_xDispatchHelper ; /// helper to dispatch something for new tasks, created by "_blank"!
426 ELoadState m_eLoadState ; /// hold information about state of asynchron loading of component for loadComponentFromURL()!
427 css::uno::Reference< css::frame::XFrame > m_xLastFrame ; /// last target of "loadComponentFromURL()"!
428 css::uno::Any m_aInteractionRequest ;
429 sal_Bool m_bSuspendQuickstartVeto ; /// don't ask quickstart for a veto
430 SvtCommandOptions m_aCommandOptions ; /// ref counted class to support disabling commands defined by configuration file
431 OUString m_sName ;
432 OUString m_sTitle ;
433 css::uno::Reference< css::frame::XDispatchRecorderSupplier > m_xDispatchRecorderSupplier ;
434
435 //---------------------------------------------------------------------
436 /** special terminate listener to close pipe and block external requests
437 * during/after termination process is/was running
438 */
439 css::uno::Reference< css::frame::XTerminateListener > m_xPipeTerminator;
440
441 //---------------------------------------------------------------------
442 /** special terminate listener shown inside system tray (quick starter)
443 * Will hinder the office on shutdown ... but wish to allow closing
444 * of open documents. And because thats different to a normal terminate listener
445 * it has to be handled special .-)
446 */
447 css::uno::Reference< css::frame::XTerminateListener > m_xQuickLauncher;
448
449 //---------------------------------------------------------------------
450 /** special terminate listener which loads images asynchronous for current open documents.
451 * Because internaly it uses blocking system APIs ... it cant be guaranteed that
452 * running jobs can be cancelled successfully if the corressponding document will be closed ...
453 * it will not hinder those documents on closing. Instead it let all jobs running ...
454 * but at least on terminate we have to wait for all those blocked requests.
455 * So these implementation must be a special terminate listener too .-(
456 */
457 css::uno::Reference< css::frame::XTerminateListener > m_xSWThreadManager;
458
459 //---------------------------------------------------------------------
460 /** special terminate listener shuting down the SfxApplication.
461 * Because these desktop instance closes documents and informs listener
462 * only ... it does not realy shutdown the whole application.
463 *
464 * Btw: That wouldnt be possible by design ... because Desktop.terminate()
465 * has to return a boolean value about success ... it cant realy shutdown the
466 * process .-)
467 *
468 * So we uses a trick: A special listener (exactly these one here) listen for notifyTermination()
469 * and shutdown the process asynchronous. But desktop has to make this special
470 * notification as realy last one ... Otherwhise it can happen that asynchronous
471 * shutdown will be faster then all other code around Desktop.terminate() .-))
472 */
473 css::uno::Reference< css::frame::XTerminateListener > m_xSfxTerminator;
474
475 css::uno::Reference< css::frame::XUntitledNumbers > m_xTitleNumberGenerator;
476
477 }; // class Desktop
478
479 } // namespace framework
480
481 #endif // #ifndef __FRAMEWORK_SERVICES_DESKTOP_HXX_
482
483 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
FREE OFFICE SUITE