?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Update ooo320-m1
[ooovba.git] / UnoControls / source / inc / statusindicator.hxx
blob2210133c030437d327713116c3888bff8e5d7ffa
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: statusindicator.hxx,v $
10 * $Revision: 1.7 $
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 _UNOCONTROLS_STATUSINDICATOR_CTRL_HXX
32 #define _UNOCONTROLS_STATUSINDICATOR_CTRL_HXX
33
34 //____________________________________________________________________________________________________________
35 // includes of other projects
36 //____________________________________________________________________________________________________________
37
38 #include <com/sun/star/awt/XControlModel.hpp>
39 #include <com/sun/star/awt/XFixedText.hpp>
40 #include <com/sun/star/awt/XGraphics.hpp>
41 #include <com/sun/star/awt/XLayoutConstrains.hpp>
42 #include <com/sun/star/awt/XProgressBar.hpp>
43 #include <com/sun/star/task/XStatusIndicator.hpp>
44 #include <com/sun/star/awt/XToolkit.hpp>
45 #include <com/sun/star/awt/XWindowPeer.hpp>
46 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
47
48 //____________________________________________________________________________________________________________
49 // includes of my own project
50 //____________________________________________________________________________________________________________
51 #include "basecontainercontrol.hxx"
52
53 //____________________________________________________________________________________________________________
54 // namespace
55 //____________________________________________________________________________________________________________
56
57 namespace unocontrols{
58
59 #define UNO3_ANY ::com::sun::star::uno::Any
60 #define UNO3_OUSTRING ::rtl::OUString
61 #define UNO3_RECTANGLE ::com::sun::star::awt::Rectangle
62 #define UNO3_REFERENCE ::com::sun::star::uno::Reference
63 #define UNO3_RUNTIMEEXCEPTION ::com::sun::star::uno::RuntimeException
64 #define UNO3_SEQUENCE ::com::sun::star::uno::Sequence
65 #define UNO3_SIZE ::com::sun::star::awt::Size
66 #define UNO3_TYPE ::com::sun::star::uno::Type
67 #define UNO3_XCONTROLMODEL ::com::sun::star::awt::XControlModel
68 #define UNO3_XFIXEDTEXT ::com::sun::star::awt::XFixedText
69 #define UNO3_XGRAPHICS ::com::sun::star::awt::XGraphics
70 #define UNO3_XLAYOUTCONSTRAINS ::com::sun::star::awt::XLayoutConstrains
71 #define UNO3_XMULTISERVICEFACTORY ::com::sun::star::lang::XMultiServiceFactory
72 #define UNO3_XPROGRESSBAR ::com::sun::star::awt::XProgressBar
73 #define UNO3_XSTATUSINDICATOR ::com::sun::star::task::XStatusIndicator
74 #define UNO3_XTOOLKIT ::com::sun::star::awt::XToolkit
75 #define UNO3_XWINDOWPEER ::com::sun::star::awt::XWindowPeer
76
77 //____________________________________________________________________________________________________________
78 // defines
79 //____________________________________________________________________________________________________________
80
81 #define SERVICENAME_STATUSINDICATOR "com.sun.star.task.XStatusIndicator"
82 #define IMPLEMENTATIONNAME_STATUSINDICATOR "stardiv.UnoControls.StatusIndicator"
83 #undef FREEBORDER
84 #define FREEBORDER 5 // border around and between the controls
85 #define FIXEDTEXT_SERVICENAME "com.sun.star.awt.UnoControlFixedText"
86 #define FIXEDTEXT_MODELNAME "com.sun.star.awt.UnoControlFixedTextModel"
87 #define CONTROLNAME_TEXT "Text" // identifier the control in container
88 #define CONTROLNAME_PROGRESSBAR "ProgressBar" // -||-
89 #define DEFAULT_TEXT "\0"
90 #define BACKGROUNDCOLOR TRGB_COLORDATA( 0x00, 0xC0, 0xC0, 0xC0 ) // lighgray
91 #define LINECOLOR_BRIGHT TRGB_COLORDATA( 0x00, 0xFF, 0xFF, 0xFF ) // white
92 #define LINECOLOR_SHADOW TRGB_COLORDATA( 0x00, 0x00, 0x00, 0x00 ) // black
93 // Overwrite defines from basecontrol.hxx!!!
94 #undef DEFAULT_WIDTH
95 #undef DEFAULT_HEIGHT
96 #define DEFAULT_WIDTH 300
97 #define DEFAULT_HEIGHT 25
98
99 //____________________________________________________________________________________________________________
100 // structs, types
101 //____________________________________________________________________________________________________________
102
103 //____________________________________________________________________________________________________________
104 // class declaration
105 //____________________________________________________________________________________________________________
106
107 class StatusIndicator : public UNO3_XLAYOUTCONSTRAINS
108 , public UNO3_XSTATUSINDICATOR
109 , public BaseContainerControl
110 {
111
112 //-------------------------------------------------------------------------------------------------------------
113 // public methods
114 //-------------------------------------------------------------------------------------------------------------
115
116 public:
117
118 //---------------------------------------------------------------------------------------------------------
119 // construct/destruct
120 //---------------------------------------------------------------------------------------------------------
121
122 /**_______________________________________________________________________________________________________
123 @short
124 @descr
125
126 @seealso
127
128 @param
129
130 @return
131
132 @onerror
133 */
134
135 StatusIndicator( const UNO3_REFERENCE< UNO3_XMULTISERVICEFACTORY >& xFactory );
136
137 /**_______________________________________________________________________________________________________
138 @short
139 @descr
140
141 @seealso
142
143 @param
144
145 @return
146
147 @onerror
148 */
149
150 virtual ~StatusIndicator();
151
152 //---------------------------------------------------------------------------------------------------------
153 // XInterface
154 //---------------------------------------------------------------------------------------------------------
155
156 /**_______________________________________________________________________________________________________
157 @short give answer, if interface is supported
158 @descr The interfaces are searched by type.
159
160 @seealso XInterface
161
162 @param "rType" is the type of searched interface.
163
164 @return Any information about found interface
165
166 @onerror A RuntimeException is thrown.
167 */
168
169 virtual UNO3_ANY SAL_CALL queryInterface( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
170
171 /**_______________________________________________________________________________________________________
172 @short increment refcount
173 @descr -
174
175 @seealso XInterface
176 @seealso release()
177
178 @param -
179
180 @return -
181
182 @onerror A RuntimeException is thrown.
183 */
184
185 virtual void SAL_CALL acquire() throw();
186
187 /**_______________________________________________________________________________________________________
188 @short decrement refcount
189 @descr -
190
191 @seealso XInterface
192 @seealso acquire()
193
194 @param -
195
196 @return -
197
198 @onerror A RuntimeException is thrown.
199 */
200
201 virtual void SAL_CALL release() throw();
202
203 //---------------------------------------------------------------------------------------------------------
204 // XTypeProvider
205 //---------------------------------------------------------------------------------------------------------
206
207 /**_______________________________________________________________________________________________________
208 @short get information about supported interfaces
209 @descr -
210
211 @seealso XTypeProvider
212
213 @param -
214
215 @return Sequence of types of all supported interfaces
216
217 @onerror A RuntimeException is thrown.
218 */
219
220 virtual UNO3_SEQUENCE< UNO3_TYPE > SAL_CALL getTypes() throw( UNO3_RUNTIMEEXCEPTION );
221
222 //---------------------------------------------------------------------------------------------------------
223 // XAggregation
224 //---------------------------------------------------------------------------------------------------------
225
226 /**_______________________________________________________________________________________________________
227 @short -
228 @descr -
229
230 @seealso -
231
232 @param -
233
234 @return -
235
236 @onerror -
237 */
238
239 virtual UNO3_ANY SAL_CALL queryAggregation( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
240
241 //---------------------------------------------------------------------------------------------------------
242 // XStatusIndicator
243 //---------------------------------------------------------------------------------------------------------
244
245 /*-****************************************************************************************************//**
246 @short -
247 @descr -
248
249 @seealso -
250
251 @param -
252
253 @return -
254
255 @onerror -
256 *//*-*****************************************************************************************************/
257
258 virtual void SAL_CALL start( const UNO3_OUSTRING& sText ,
259 sal_Int32 nRange ) throw( UNO3_RUNTIMEEXCEPTION );
260
261 /*-****************************************************************************************************//**
262 @short -
263 @descr -
264
265 @seealso -
266
267 @param -
268
269 @return -
270
271 @onerror -
272 *//*-*****************************************************************************************************/
273
274 virtual void SAL_CALL end() throw( UNO3_RUNTIMEEXCEPTION );
275
276 /*-****************************************************************************************************//**
277 @short -
278 @descr -
279
280 @seealso -
281
282 @param -
283
284 @return -
285
286 @onerror -
287 *//*-*****************************************************************************************************/
288
289 virtual void SAL_CALL reset() throw( UNO3_RUNTIMEEXCEPTION );
290
291 /*-****************************************************************************************************//**
292 @short -
293 @descr -
294
295 @seealso -
296
297 @param -
298
299 @return -
300
301 @onerror -
302 *//*-*****************************************************************************************************/
303
304 virtual void SAL_CALL setText( const UNO3_OUSTRING& sText ) throw( UNO3_RUNTIMEEXCEPTION );
305
306 /*-****************************************************************************************************//**
307 @short -
308 @descr -
309
310 @seealso -
311
312 @param -
313
314 @return -
315
316 @onerror -
317 *//*-*****************************************************************************************************/
318
319 virtual void SAL_CALL setValue( sal_Int32 nValue ) throw( UNO3_RUNTIMEEXCEPTION );
320
321 //---------------------------------------------------------------------------------------------------------
322 // XLayoutConstrains
323 //---------------------------------------------------------------------------------------------------------
324
325 /**_______________________________________________________________________________________________________
326 @short -
327 @descr -
328
329 @seealso -
330
331 @param -
332
333 @return -
334
335 @onerror -
336 */
337
338 virtual UNO3_SIZE SAL_CALL getMinimumSize() throw( UNO3_RUNTIMEEXCEPTION );
339
340 /**_______________________________________________________________________________________________________
341 @short -
342 @descr -
343
344 @seealso -
345
346 @param -
347
348 @return -
349
350 @onerror -
351 */
352
353 virtual UNO3_SIZE SAL_CALL getPreferredSize() throw( UNO3_RUNTIMEEXCEPTION );
354
355 /**_______________________________________________________________________________________________________
356 @short -
357 @descr -
358
359 @seealso -
360
361 @param -
362
363 @return -
364
365 @onerror -
366 */
367
368 virtual UNO3_SIZE SAL_CALL calcAdjustedSize( const UNO3_SIZE& aNewSize ) throw( UNO3_RUNTIMEEXCEPTION );
369
370 //---------------------------------------------------------------------------------------------------------
371 // XControl
372 //---------------------------------------------------------------------------------------------------------
373
374 /**_______________________________________________________________________________________________________
375 @short -
376 @descr -
377
378 @seealso -
379
380 @param -
381
382 @return -
383
384 @onerror -
385 */
386
387 virtual void SAL_CALL createPeer( const UNO3_REFERENCE< UNO3_XTOOLKIT >& xToolkit ,
388 const UNO3_REFERENCE< UNO3_XWINDOWPEER >& xParent ) throw( UNO3_RUNTIMEEXCEPTION );
389
390 /**_______________________________________________________________________________________________________
391 @short -
392 @descr -
393
394 @seealso -
395
396 @param -
397
398 @return -
399
400 @onerror -
401 */
402
403 virtual sal_Bool SAL_CALL setModel( const UNO3_REFERENCE< UNO3_XCONTROLMODEL >& xModel ) throw( UNO3_RUNTIMEEXCEPTION );
404
405 /**_______________________________________________________________________________________________________
406 @short -
407 @descr -
408
409 @seealso -
410
411 @param -
412
413 @return -
414
415 @onerror -
416 */
417
418 virtual UNO3_REFERENCE< UNO3_XCONTROLMODEL > SAL_CALL getModel() throw( UNO3_RUNTIMEEXCEPTION );
419
420 //---------------------------------------------------------------------------------------------------------
421 // XComponent
422 //---------------------------------------------------------------------------------------------------------
423
424 /**_______________________________________________________________________________________________________
425 @short -
426 @descr -
427
428 @seealso -
429
430 @param -
431
432 @return -
433
434 @onerror -
435 */
436
437 virtual void SAL_CALL dispose() throw( UNO3_RUNTIMEEXCEPTION );
438
439 //---------------------------------------------------------------------------------------------------------
440 // XWindow
441 //---------------------------------------------------------------------------------------------------------
442
443 /**_______________________________________________________________________________________________________
444 @short -
445 @descr -
446
447 @seealso -
448
449 @param -
450
451 @return -
452
453 @onerror -
454 */
455
456 virtual void SAL_CALL setPosSize( sal_Int32 nX ,
457 sal_Int32 nY ,
458 sal_Int32 nWidth ,
459 sal_Int32 nHeight ,
460 sal_Int16 nFlags ) throw( UNO3_RUNTIMEEXCEPTION );
461
462 //---------------------------------------------------------------------------------------------------------
463 // BaseControl
464 //---------------------------------------------------------------------------------------------------------
465
466 /**_______________________________________________________________________________________________________
467 @short -
468 @descr -
469
470 @seealso -
471
472 @param -
473
474 @return -
475
476 @onerror -
477 */
478
479 static const UNO3_SEQUENCE< UNO3_OUSTRING > impl_getStaticSupportedServiceNames();
480
481 /**_______________________________________________________________________________________________________
482 @short -
483 @descr -
484
485 @seealso -
486
487 @param -
488
489 @return -
490
491 @onerror -
492 */
493
494 static const UNO3_OUSTRING impl_getStaticImplementationName();
495
496 //____________________________________________________________________________________________________________
497 // protected methods
498 //____________________________________________________________________________________________________________
499
500 protected:
501
502 /**_______________________________________________________________________________________________________
503 @short -
504 @descr -
505
506 @seealso -
507
508 @param -
509
510 @return -
511
512 @onerror -
513 */
514
515 virtual UNO3_WINDOWDESCRIPTOR* impl_getWindowDescriptor( const UNO3_REFERENCE< UNO3_XWINDOWPEER >& xParentPeer );
516
517 /**_______________________________________________________________________________________________________
518 @short -
519 @descr -
520
521 @seealso -
522
523 @param -
524
525 @return -
526
527 @onerror -
528 */
529
530 virtual void impl_paint ( sal_Int32 nX, sal_Int32 nY, const UNO3_REFERENCE< UNO3_XGRAPHICS > & rGraphics );
531
532 /**_______________________________________________________________________________________________________
533 @short -
534 @descr -
535
536 @seealso -
537
538 @param -
539
540 @return -
541
542 @onerror -
543 */
544
545 virtual void impl_recalcLayout( const UNO3_WINDOWEVENT& aEvent );
546
547 //____________________________________________________________________________________________________________
548 // debug methods
549 //____________________________________________________________________________________________________________
550
551 private:
552
553 /**_______________________________________________________________________________________________________
554 @short -
555 @descr -
556
557 @seealso -
558
559 @param -
560
561 @return -
562
563 @onerror -
564 */
565
566 #if OSL_DEBUG_LEVEL > 1
567
568 #endif
569
570 //____________________________________________________________________________________________________________
571 // private variables
572 //____________________________________________________________________________________________________________
573
574 private:
575
576 UNO3_REFERENCE< UNO3_XFIXEDTEXT > m_xText ;
577 UNO3_REFERENCE< UNO3_XPROGRESSBAR > m_xProgressBar ;
578
579 }; // class StatusIndicator
580
581 } // namespace unocontrols
582
583 #endif // #ifndef _UNOCONTROLS_STATUSINDICATOR_CTRL_HXX
vba interoperability for OOo