?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Update ooo320-m1
[ooovba.git] / framework / inc / services / task.hxx
blob13181a110253b180aaba5364d307a1fdd01c1630
1 /*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * $RCSfile: task.hxx,v $
10 * $Revision: 1.9 $
11 *
12 * This file is part of OpenOffice.org.
13 *
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
17 *
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
23 *
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
28 *
29 ************************************************************************/
30
31 #ifndef __FRAMEWORK_SERVICES_TASK_HXX_
32 #define __FRAMEWORK_SERVICES_TASK_HXX_
33
34 //_________________________________________________________________________________________________________________
35 // my own includes
36 //_________________________________________________________________________________________________________________
37
38 #include <services/frame.hxx>
39 #include <macros/generic.hxx>
40 #include <macros/debug.hxx>
41 #include <macros/xinterface.hxx>
42 #include <macros/xtypeprovider.hxx>
43 #include <macros/xserviceinfo.hxx>
44
45 //_________________________________________________________________________________________________________________
46 // interface includes
47 //_________________________________________________________________________________________________________________
48 #include <com/sun/star/frame/XTask.hpp>
49 #include <com/sun/star/awt/Point.hpp>
50 #include <com/sun/star/awt/Size.hpp>
51
52 //_________________________________________________________________________________________________________________
53 // other includes
54 //_________________________________________________________________________________________________________________
55 #include <cppuhelper/weak.hxx>
56 #include <cppuhelper/propshlp.hxx>
57
58 #include <tools/link.hxx>
59 #include <vcl/evntpost.hxx>
60
61 //_________________________________________________________________________________________________________________
62 // namespace
63 //_________________________________________________________________________________________________________________
64
65 namespace framework{
66
67 //_________________________________________________________________________________________________________________
68 // exported const
69 //_________________________________________________________________________________________________________________
70
71 //_________________________________________________________________________________________________________________
72 // exported definitions
73 //_________________________________________________________________________________________________________________
74
75 /*-************************************************************************************************************//**
76 @short implements an special frame - a task frame
77
78 @descr -
79
80 @implements XTask
81
82 @base Frame
83 OPropertySet
84 *//*-*************************************************************************************************************/
85
86 class Task : public css::frame::XTask , // => XFrame => XComponent
87 public Frame // Order of baseclasses is neccessary for right initialization!
88 {
89 //-------------------------------------------------------------------------------------------------------------
90 // public methods
91 //-------------------------------------------------------------------------------------------------------------
92
93 public:
94
95 //---------------------------------------------------------------------------------------------------------
96 // constructor / destructor
97 //---------------------------------------------------------------------------------------------------------
98
99 /*-****************************************************************************************************//**
100 @short standard constructor to create instance
101
102 @descr This constructor initialize a new instance of this class,
103 and will be set valid values on his member and baseclasses.
104
105 @seealso -
106
107 @param -
108
109 @return -
110
111 @onerror -
112 *//*-*****************************************************************************************************/
113
114 Task( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
115
116 /*-****************************************************************************************************//**
117 @short standard destructor
118
119 @descr This method destruct an instance of this class and clear some member.
120
121 @seealso -
122
123 @param -
124
125 @return -
126
127 @onerror -
128 *//*-*****************************************************************************************************/
129
130 virtual ~Task();
131
132 //---------------------------------------------------------------------------------------------------------
133 // XInterface, XTypeProvider, XServiceInfo
134 //---------------------------------------------------------------------------------------------------------
135
136 DECLARE_XINTERFACE
137 DECLARE_XTYPEPROVIDER
138 DECLARE_XSERVICEINFO
139
140 //---------------------------------------------------------------------------------------------------------
141 // XTask
142 //---------------------------------------------------------------------------------------------------------
143
144 /*-****************************************************************************************************//**
145 @short -
146
147 @descr -
148
149 @seealso -
150
151 @param -
152
153 @return -
154
155 @onerror -
156 *//*-*****************************************************************************************************/
157
158 virtual sal_Bool SAL_CALL close() throw( css::uno::RuntimeException );
159
160 /*-****************************************************************************************************//**
161 @short -
162
163 @descr -
164
165 @seealso -
166
167 @param -
168
169 @return -
170
171 @onerror -
172 *//*-*****************************************************************************************************/
173
174 virtual void SAL_CALL tileWindows() throw( css::uno::RuntimeException );
175
176 /*-****************************************************************************************************//**
177 @short -
178
179 @descr -
180
181 @seealso -
182
183 @param -
184
185 @return -
186
187 @onerror -
188 *//*-*****************************************************************************************************/
189
190 virtual void SAL_CALL arrangeWindowsVertical() throw( css::uno::RuntimeException );
191
192 /*-****************************************************************************************************//**
193 @short -
194
195 @descr -
196
197 @seealso -
198
199 @param -
200
201 @return -
202
203 @onerror -
204 *//*-*****************************************************************************************************/
205
206 virtual void SAL_CALL arrangeWindowsHorizontal() throw( css::uno::RuntimeException );
207
208 //---------------------------------------------------------------------------------------------------------
209 // XComponent
210 //---------------------------------------------------------------------------------------------------------
211
212 /*-****************************************************************************************************//**
213 @short -
214
215 @descr We must overwrite this method, because baseclass Frame implements XFrame and XComponent.
216 XTask is derived from these classes to! The compiler don't know, which base is the right one.
217
218 @seealso -
219
220 @param -
221
222 @return -
223
224 @onerror -
225 *//*-*****************************************************************************************************/
226
227 virtual void SAL_CALL dispose() throw( css::uno::RuntimeException )
228 {
229 Frame::dispose();
230 }
231
232 /*-*******************************************************************************************************/
233 virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw( css::uno::RuntimeException )
234 {
235 Frame::addEventListener( xListener );
236 }
237
238 /*-*******************************************************************************************************/
239 virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw( css::uno::RuntimeException )
240 {
241 Frame::removeEventListener( xListener );
242 }
243
244 //---------------------------------------------------------------------------------------------------------
245 // XFrame
246 //---------------------------------------------------------------------------------------------------------
247
248 /*-****************************************************************************************************//**
249 @short -
250
251 @descr We must overwrite this method, because baseclass Frame implements XFrame and XComponent.
252 XTask is derived from these classes to! The compiler don't know, which base is right.
253
254 @seealso -
255
256 @param -
257
258 @return -
259
260 @onerror -
261 *//*-*****************************************************************************************************/
262
263 virtual void SAL_CALL initialize( const css::uno::Reference< css::awt::XWindow >& xWindow ) throw( css::uno::RuntimeException )
264 {
265 Frame::initialize( xWindow );
266 }
267
268 virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getContainerWindow() throw( css::uno::RuntimeException )
269 {
270 return Frame::getContainerWindow();
271 }
272
273 virtual void SAL_CALL setCreator( const css::uno::Reference< css::frame::XFramesSupplier >& xCreator ) throw( css::uno::RuntimeException )
274 {
275 Frame::setCreator( xCreator );
276 }
277
278 virtual css::uno::Reference< css::frame::XFramesSupplier > SAL_CALL getCreator() throw( css::uno::RuntimeException )
279 {
280 return Frame::getCreator();
281 }
282
283 virtual ::rtl::OUString SAL_CALL getName() throw( css::uno::RuntimeException )
284 {
285 return Frame::getName();
286 }
287
288 virtual void SAL_CALL setName( const ::rtl::OUString& sName ) throw( css::uno::RuntimeException )
289 {
290 Frame::setName( sName );
291 }
292
293 virtual sal_Bool SAL_CALL isTop() throw( css::uno::RuntimeException )
294 {
295 return Frame::isTop();
296 }
297
298 virtual void SAL_CALL activate() throw( css::uno::RuntimeException )
299 {
300 Frame::activate();
301 }
302
303 virtual void SAL_CALL deactivate() throw( css::uno::RuntimeException )
304 {
305 Frame::deactivate();
306 }
307
308 virtual sal_Bool SAL_CALL isActive() throw( css::uno::RuntimeException )
309 {
310 return Frame::isActive();
311 }
312
313 virtual sal_Bool SAL_CALL setComponent( const css::uno::Reference< css::awt::XWindow >& xComponentWindow ,
314 const css::uno::Reference< css::frame::XController >& xController ) throw( css::uno::RuntimeException )
315 {
316 return Frame::setComponent( xComponentWindow, xController );
317 }
318
319 virtual css::uno::Reference< css::awt::XWindow > SAL_CALL getComponentWindow() throw( css::uno::RuntimeException )
320 {
321 return Frame::getComponentWindow();
322 }
323
324 virtual css::uno::Reference< css::frame::XController > SAL_CALL getController() throw( css::uno::RuntimeException )
325 {
326 return Frame::getController();
327 }
328
329 virtual void SAL_CALL contextChanged() throw( css::uno::RuntimeException )
330 {
331 Frame::contextChanged();
332 }
333
334 virtual void SAL_CALL addFrameActionListener( const css::uno::Reference< css::frame::XFrameActionListener >& xListener ) throw( css::uno::RuntimeException )
335 {
336 Frame::addFrameActionListener( xListener );
337 }
338
339 virtual void SAL_CALL removeFrameActionListener( const css::uno::Reference< css::frame::XFrameActionListener >& xListener ) throw( css::uno::RuntimeException )
340 {
341 Frame::removeFrameActionListener( xListener );
342 }
343
344 virtual css::uno::Reference< css::frame::XFrame > SAL_CALL findFrame( const ::rtl::OUString& sTargetFrameName ,
345 sal_Int32 nSearchFlags ) throw( css::uno::RuntimeException );
346
347 //---------------------------------------------------------------------------------------------------------
348 // XTopWindowListener
349 //---------------------------------------------------------------------------------------------------------
350
351 /*-****************************************************************************************************//**
352 @short -
353
354 @descr -
355
356 @seealso -
357 @seealso -
358
359 @param -
360
361 @return -
362
363 @onerror -
364 *//*-*****************************************************************************************************/
365
366 virtual void SAL_CALL windowClosing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
367
368 /*-****************************************************************************************************//**
369 @short -
370
371 @descr -
372
373 @seealso -
374 @seealso -
375
376 @param -
377
378 @return -
379
380 @onerror -
381 *//*-*****************************************************************************************************/
382
383 virtual void SAL_CALL windowActivated( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
384
385 /*-****************************************************************************************************//**
386 @short -
387
388 @descr -
389
390 @seealso -
391 @seealso -
392
393 @param -
394
395 @return -
396
397 @onerror -
398 *//*-*****************************************************************************************************/
399
400 virtual void SAL_CALL windowDeactivated( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
401
402 //---------------------------------------------------------------------------------------------------------
403 // XEventListener
404 //---------------------------------------------------------------------------------------------------------
405
406 /*-****************************************************************************************************//**
407 @short -
408
409 @descr This object is forced to release all references to the interfaces given
410 by the parameter Source.
411
412 @seealso -
413
414 @param -
415
416 @return -
417
418 @onerror -
419 *//*-*****************************************************************************************************/
420
421 virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException );
422
423 //-------------------------------------------------------------------------------------------------------------
424 // protected methods
425 //-------------------------------------------------------------------------------------------------------------
426
427 protected:
428
429 //---------------------------------------------------------------------------
430 // OPropertySetHelper
431 //---------------------------------------------------------------------------
432
433 /*-****************************************************************************************************//**
434 @short try to convert a property value
435 @descr This method is calling from helperclass "OPropertySetHelper".
436 Don't use this directly!
437 You must try to convert the value of given propertyhandle and
438 return results of this operation. This will be use to ask vetoable
439 listener. If no listener have a veto, we will change value realy!
440 ( in method setFastPropertyValue_NoBroadcast(...) )
441
442 @seealso OPropertySetHelper
443 @seealso setFastPropertyValue_NoBroadcast()
444
445 @param "aConvertedValue" new converted value of property
446 @param "aOldValue" old value of property
447 @param "nHandle" handle of property
448 @param "aValue" new value of property
449
450 @return sal_True if value will be changed, sal_FALSE otherway
451
452 @onerror IllegalArgumentException, if you call this with an invalid argument
453 *//*-*****************************************************************************************************/
454 /*
455 virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any& aConvertedValue ,
456 css::uno::Any& aOldValue ,
457 sal_Int32 nHandle ,
458 const css::uno::Any& aValue ) throw( css::lang::IllegalArgumentException );
459 */
460 /*-****************************************************************************************************//**
461 @short set value of a transient property
462 @descr This method is calling from helperclass "OPropertySetHelper".
463 Don't use this directly!
464 Handle and value are valid everyway! You must set the new value only.
465 After this, baseclass send messages to all listener automaticly.
466
467 @seealso OPropertySetHelper
468
469 @param "nHandle" handle of property to change
470 @param "aValue" new value of property
471
472 @return -
473
474 @onerror An exception is thrown.
475 *//*-*****************************************************************************************************/
476 /*
477 virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle ,
478 const css::uno::Any& aValue ) throw( css::uno::Exception );
479 */
480 /*-****************************************************************************************************//**
481 @short get value of a transient property
482 @descr This method is calling from helperclass "OPropertySetHelper".
483 Don't use this directly!
484
485 @seealso OPropertySetHelper
486
487 @param "nHandle" handle of property to change
488 @param "aValue" current value of property
489
490 @return -
491
492 @onerror -
493 *//*-*****************************************************************************************************/
494 /*
495 virtual void SAL_CALL getFastPropertyValue( css::uno::Any& aValue ,
496 sal_Int32 nHandle ) const;
497 */
498 /*-****************************************************************************************************//**
499 @short return structure and information about transient properties
500 @descr This method is calling from helperclass "OPropertySetHelper".
501 Don't use this directly!
502
503 @seealso OPropertySetHelper
504
505 @param -
506
507 @return structure with property-informations
508
509 @onerror -
510 *//*-*****************************************************************************************************/
511 /*
512 virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
513 */
514 /*-****************************************************************************************************//**
515 @short return propertysetinfo
516 @descr You can call this method to get information about transient properties
517 of this object.
518
519 @seealso OPropertySetHelper
520 @seealso XPropertySet
521 @seealso XMultiPropertySet
522
523 @param -
524
525 @return reference to object with information [XPropertySetInfo]
526
527 @onerror -
528 *//*-*****************************************************************************************************/
529 /*
530 virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo();
531 */
532 //-------------------------------------------------------------------------------------------------------------
533 // private methods
534 //-------------------------------------------------------------------------------------------------------------
535
536 private:
537
538 DECL_LINK( Close_Impl, void* );
539
540 // void impl_SaveWindowAttributes();
541
542 /* sal_Bool impl_tryToChangeProperty( sal_Bool bProperty ,
543 const css::uno::Any& aValue ,
544 css::uno::Any& aOldValue ,
545 css::uno::Any& aConvertedValue ) throw( css::lang::IllegalArgumentException );
546 sal_Bool impl_tryToChangeProperty( const ::rtl::OUString& sProperty ,
547 const css::uno::Any& aValue ,
548 css::uno::Any& aOldValue ,
549 css::uno::Any& aConvertedValue ) throw( css::lang::IllegalArgumentException );
550 sal_Bool impl_tryToChangeProperty( const css::awt::Point& aProperty ,
551 const css::uno::Any& aValue ,
552 css::uno::Any& aOldValue ,
553 css::uno::Any& aConvertedValue ) throw( css::lang::IllegalArgumentException );
554 sal_Bool impl_tryToChangeProperty( const css::awt::Size& aProperty ,
555 const css::uno::Any& aValue ,
556 css::uno::Any& aOldValue ,
557 css::uno::Any& aConvertedValue ) throw( css::lang::IllegalArgumentException );
558
559 static const css::uno::Sequence< css::beans::Property > impl_getStaticPropertyDescriptor();
560 */
561
562 //-------------------------------------------------------------------------------------------------------------
563 // debug methods
564 // (should be private everyway!)
565 //-------------------------------------------------------------------------------------------------------------
566
567 /*-****************************************************************************************************//**
568 @short debug-method to check incoming parameter of some other mehods of this class
569 @descr The following methods are used to check parameters for other methods
570 of this class. The return value is used directly for an ASSERT(...).
571
572 @seealso ASSERTs in implementation!
573
574 @param references to checking variables
575 @return sal_False on invalid parameter<BR>
576 sal_True otherway
577
578 @onerror -
579 *//*-*****************************************************************************************************/
580
581 #ifdef ENABLE_ASSERTIONS
582
583 private:
584
585 // Not used in the moment!
586
587 #endif // #ifdef ENABLE_ASSERTIONS
588
589 //-------------------------------------------------------------------------------------------------------------
590 // variables
591 // (should be private everyway!)
592 //-------------------------------------------------------------------------------------------------------------
593
594 protected:
595
596 // But some values are neede by derived classes!
597 // sal_Bool m_bIsPlugIn ; /// In objects of these class this member is set to FALSE.
598 /// But in derived class PlugInFrame it's overwrited with TRUE!
599
600 private:
601
602 // Properties
603 sal_Bool m_bIsAlwaysVisible ;
604 sal_Bool m_bIsFloating ;
605 css::awt::Point m_aPosition ;
606 css::awt::Size m_aSize ;
607 ::vcl::EventPoster m_aPoster ;
608
609 }; // class Tasks
610
611 } // namespace framework
612
613 #endif // #ifndef __FRAMEWORK_SERVICES_TASKS_HXX_
vba interoperability for OOo