UnoControls/inc/basecontainercontrol.hxx

   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: basecontainercontrol.hxx,v $
  10  * $Revision: 1.5 $
  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_BASECONTAINERCONTROL_CTRL_HXX
  32 #define _UNOCONTROLS_BASECONTAINERCONTROL_CTRL_HXX
  33
  34 //____________________________________________________________________________________________________________
  35 //      includes of other projects
  36 //____________________________________________________________________________________________________________
  37
  38 #include <com/sun/star/lang/XServiceName.hpp>
  39 #include <com/sun/star/lang/XServiceInfo.hpp>
  40 #include <com/sun/star/container/XContainer.hpp>
  41 #include <com/sun/star/container/XIndexContainer.hpp>
  42 #include <com/sun/star/container/XNameReplace.hpp>
  43 #include <com/sun/star/container/XContainerListener.hpp>
  44 #include <com/sun/star/container/XSet.hpp>
  45 #include <com/sun/star/container/ContainerEvent.hpp>
  46 #include <com/sun/star/container/XIndexReplace.hpp>
  47 #include <com/sun/star/container/XNameContainer.hpp>
  48 #include <tools/list.hxx>
  49
  50 //____________________________________________________________________________________________________________
  51 //      includes of my own project
  52 //____________________________________________________________________________________________________________
  53 #include "basecontrol.hxx"
  54
  55 //____________________________________________________________________________________________________________
  56 //      "namespaces"
  57 //____________________________________________________________________________________________________________
  58
  59 namespace unocontrols{
  60
  61 #define UNO3_REFERENCE                                                          ::com::sun::star::uno::Reference
  62 #define UNO3_XCONTROL                                                           ::com::sun::star::awt::XControl
  63 #define UNO3_OUSTRING                                                           ::rtl::OUString
  64 #define UNO3_XCONTROLMODEL                                                      ::com::sun::star::awt::XControlModel
  65 #define UNO3_XCONTROLCONTAINER                                          ::com::sun::star::awt::XControlContainer
  66 #define UNO3_XMULTISERVICEFACTORY                                       ::com::sun::star::lang::XMultiServiceFactory
  67 #define UNO3_TYPE                                                                       ::com::sun::star::uno::Type
  68 #define UNO3_RUNTIMEEXCEPTION                                           ::com::sun::star::uno::RuntimeException
  69 #define UNO3_XTOOLKIT                                                           ::com::sun::star::awt::XToolkit
  70 #define UNO3_XWINDOWPEER                                                        ::com::sun::star::awt::XWindowPeer
  71 #define UNO3_EVENTOBJECT                                                        ::com::sun::star::lang::EventObject
  72 #define UNO3_SEQUENCE                                                           ::com::sun::star::uno::Sequence
  73 #define UNO3_XCONTAINERLISTENER                                         ::com::sun::star::container::XContainerListener
  74 #define UNO3_ANY                                                                        ::com::sun::star::uno::Any
  75 #define UNO3_XTABCONTROLLER                                                     ::com::sun::star::awt::XTabController
  76 #define UNO3_WINDOWDESCRIPTOR                                           ::com::sun::star::awt::WindowDescriptor
  77 #define UNO3_XGRAPHICS                                                          ::com::sun::star::awt::XGraphics
  78 #define UNO3_OMULTITYPEINTERFACECONTAINERHELPER         ::cppu::OMultiTypeInterfaceContainerHelper
  79 #define UNO3_ILLEGALARGUMENTEXCEPTION                           ::com::sun::star::lang::IllegalArgumentException
  80
  81 //____________________________________________________________________________________________________________
  82 //      structs, types, forwards
  83 //____________________________________________________________________________________________________________
  84
  85 struct IMPL_ControlInfo
  86 {
  87     UNO3_REFERENCE< UNO3_XCONTROL >     xControl        ;
  88     UNO3_OUSTRING                                               sName           ;
  89 };
  90
  91 // makro define a list-class for struct IMPL_ControlInfo!
  92 class IMPL_ControlInfoList ;
  93 DECLARE_LIST( IMPL_ControlInfoList, IMPL_ControlInfo* )
  94
  95 //____________________________________________________________________________________________________________
  96 //      classes
  97 //____________________________________________________________________________________________________________
  98
  99 class BaseContainerControl      : public UNO3_XCONTROLMODEL
 100                             , public UNO3_XCONTROLCONTAINER
 101                             , public BaseControl
 102 {
 103
 104 //____________________________________________________________________________________________________________
 105 //      public methods
 106 //____________________________________________________________________________________________________________
 107
 108 public:
 109
 110     //________________________________________________________________________________________________________
 111     //  construct/destruct
 112     //________________________________________________________________________________________________________
 113
 114     /**_______________________________________________________________________________________________________
 115         @short          -
 116         @descr          -
 117
 118         @seealso        -
 119
 120         @param          -
 121
 122         @return         -
 123
 124         @onerror        -
 125     */
 126
 127        BaseContainerControl( const UNO3_REFERENCE< UNO3_XMULTISERVICEFACTORY >& xFactory );
 128
 129     /**_______________________________________________________________________________________________________
 130         @short          -
 131         @descr          -
 132
 133         @seealso        -
 134
 135         @param          -
 136
 137         @return         -
 138
 139         @onerror        -
 140     */
 141
 142     virtual     ~BaseContainerControl();
 143
 144     //________________________________________________________________________________________________________
 145     //  XInterface
 146     //________________________________________________________________________________________________________
 147
 148     /**_______________________________________________________________________________________________________
 149         @short          give answer, if interface is supported
 150         @descr          The interfaces are searched by type.
 151
 152         @seealso        XInterface
 153
 154         @param      "rType" is the type of searched interface.
 155
 156         @return         Any             information about found interface
 157
 158         @onerror        A RuntimeException is thrown.
 159     */
 160
 161     virtual UNO3_ANY SAL_CALL queryInterface( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 162
 163     //________________________________________________________________________________________________________
 164     //  XTypeProvider
 165     //________________________________________________________________________________________________________
 166
 167     /**_______________________________________________________________________________________________________
 168         @short          get information about supported interfaces
 169         @descr      -
 170
 171         @seealso        XTypeProvider
 172
 173         @param      -
 174
 175         @return         Sequence of types of all supported interfaces
 176
 177         @onerror        A RuntimeException is thrown.
 178     */
 179
 180     virtual UNO3_SEQUENCE< UNO3_TYPE > SAL_CALL getTypes() throw( UNO3_RUNTIMEEXCEPTION );
 181
 182     //________________________________________________________________________________________________________
 183     //  XAggregation
 184     //________________________________________________________________________________________________________
 185
 186     /**_______________________________________________________________________________________________________
 187         @short          -
 188         @descr          -
 189
 190         @seealso        -
 191
 192         @param          -
 193
 194         @return         -
 195
 196         @onerror        -
 197     */
 198
 199     virtual UNO3_ANY SAL_CALL queryAggregation( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 200
 201     //________________________________________________________________________________________________________
 202     //  XControl
 203     //________________________________________________________________________________________________________
 204
 205     /**_______________________________________________________________________________________________________
 206         @short          -
 207         @descr          -
 208
 209         @seealso        -
 210
 211         @param          -
 212
 213         @return         -
 214
 215         @onerror        -
 216     */
 217
 218     virtual void SAL_CALL createPeer(   const   UNO3_REFERENCE< UNO3_XTOOLKIT >&        xToolkit        ,
 219                                         const   UNO3_REFERENCE< UNO3_XWINDOWPEER >&     xParent         ) throw( UNO3_RUNTIMEEXCEPTION );
 220
 221     /**_______________________________________________________________________________________________________
 222         @short          -
 223         @descr          -
 224
 225         @seealso        -
 226
 227         @param          -
 228
 229         @return         -
 230
 231         @onerror        -
 232     */
 233
 234     virtual sal_Bool SAL_CALL setModel( const UNO3_REFERENCE< UNO3_XCONTROLMODEL >& xModel ) throw( UNO3_RUNTIMEEXCEPTION );
 235
 236     /**_______________________________________________________________________________________________________
 237         @short          -
 238         @descr          -
 239
 240         @seealso        -
 241
 242         @param          -
 243
 244         @return         -
 245
 246         @onerror        -
 247     */
 248
 249     virtual UNO3_REFERENCE< UNO3_XCONTROLMODEL > SAL_CALL getModel() throw( UNO3_RUNTIMEEXCEPTION );
 250
 251     //________________________________________________________________________________________________________
 252     //  XComponent
 253     //________________________________________________________________________________________________________
 254
 255     /**_______________________________________________________________________________________________________
 256         @short          -
 257         @descr          -
 258
 259         @seealso        -
 260
 261         @param          -
 262
 263         @return         -
 264
 265         @onerror        -
 266     */
 267
 268     virtual void SAL_CALL dispose() throw( UNO3_RUNTIMEEXCEPTION );
 269
 270     //________________________________________________________________________________________________________
 271     //  XEventListener
 272     //________________________________________________________________________________________________________
 273
 274     /**_______________________________________________________________________________________________________
 275         @short          -
 276         @descr          -
 277
 278         @seealso        -
 279
 280         @param          -
 281
 282         @return         -
 283
 284         @onerror        -
 285     */
 286
 287     virtual void SAL_CALL disposing( const UNO3_EVENTOBJECT& rEvent ) throw( UNO3_RUNTIMEEXCEPTION );
 288
 289     //________________________________________________________________________________________________________
 290     //  XControlContainer
 291     //________________________________________________________________________________________________________
 292
 293     /**_______________________________________________________________________________________________________
 294         @short          -
 295         @descr          -
 296
 297         @seealso        -
 298
 299         @param          -
 300
 301         @return         -
 302
 303         @onerror        -
 304     */
 305
 306     virtual void SAL_CALL addControl(   const   UNO3_OUSTRING&                                          sName           ,
 307                                         const   UNO3_REFERENCE< UNO3_XCONTROL >&        xControl        ) throw( UNO3_RUNTIMEEXCEPTION  );
 308
 309     /**_______________________________________________________________________________________________________
 310         @short          -
 311         @descr          -
 312
 313         @seealso        -
 314
 315         @param          -
 316
 317         @return         -
 318
 319         @onerror        -
 320     */
 321
 322     virtual     void SAL_CALL addContainerListener( const UNO3_REFERENCE< UNO3_XCONTAINERLISTENER >& xListener ) throw( UNO3_RUNTIMEEXCEPTION );
 323
 324     /**_______________________________________________________________________________________________________
 325         @short          -
 326         @descr          -
 327
 328         @seealso        -
 329
 330         @param          -
 331
 332         @return         -
 333
 334         @onerror        -
 335     */
 336
 337     virtual void SAL_CALL removeControl( const UNO3_REFERENCE< UNO3_XCONTROL >& xControl ) throw( UNO3_RUNTIMEEXCEPTION );
 338
 339     /**_______________________________________________________________________________________________________
 340         @short          -
 341         @descr          -
 342
 343         @seealso        -
 344
 345         @param          -
 346
 347         @return         -
 348
 349         @onerror        -
 350     */
 351
 352     virtual void SAL_CALL removeContainerListener( const UNO3_REFERENCE< UNO3_XCONTAINERLISTENER >& xListener ) throw( UNO3_RUNTIMEEXCEPTION );
 353
 354     /**_______________________________________________________________________________________________________
 355         @short          -
 356         @descr          -
 357
 358         @seealso        -
 359
 360         @param          -
 361
 362         @return         -
 363
 364         @onerror        -
 365     */
 366
 367     virtual void SAL_CALL setStatusText( const UNO3_OUSTRING& sStatusText ) throw( UNO3_RUNTIMEEXCEPTION );
 368
 369     /**_______________________________________________________________________________________________________
 370         @short          -
 371         @descr          -
 372
 373         @seealso        -
 374
 375         @param          -
 376
 377         @return         -
 378
 379         @onerror        -
 380     */
 381
 382     virtual UNO3_REFERENCE< UNO3_XCONTROL > SAL_CALL getControl( const UNO3_OUSTRING& sName) throw( UNO3_RUNTIMEEXCEPTION );
 383
 384     /**_______________________________________________________________________________________________________
 385         @short          -
 386         @descr          -
 387
 388         @seealso        -
 389
 390         @param          -
 391
 392         @return         -
 393
 394         @onerror        -
 395     */
 396
 397     virtual UNO3_SEQUENCE< UNO3_REFERENCE< UNO3_XCONTROL > > SAL_CALL getControls() throw( UNO3_RUNTIMEEXCEPTION );
 398
 399     //________________________________________________________________________________________________________
 400     //  XUnoControlContainer
 401     //________________________________________________________________________________________________________
 402
 403     /**_______________________________________________________________________________________________________
 404         @short          -
 405         @descr          -
 406
 407         @seealso        -
 408
 409         @param          -
 410
 411         @return         -
 412
 413         @onerror        -
 414     */
 415
 416     virtual void SAL_CALL addTabController( const UNO3_REFERENCE< UNO3_XTABCONTROLLER >& xTabController ) throw( UNO3_RUNTIMEEXCEPTION );
 417
 418     /**_______________________________________________________________________________________________________
 419         @short          -
 420         @descr          -
 421
 422         @seealso        -
 423
 424         @param          -
 425
 426         @return         -
 427
 428         @onerror        -
 429     */
 430
 431     virtual void SAL_CALL removeTabController( const UNO3_REFERENCE< UNO3_XTABCONTROLLER >& xTabController ) throw( UNO3_RUNTIMEEXCEPTION );
 432
 433     /**_______________________________________________________________________________________________________
 434         @short          -
 435         @descr          -
 436
 437         @seealso        -
 438
 439         @param          -
 440
 441         @return         -
 442
 443         @onerror        -
 444     */
 445
 446     virtual void SAL_CALL setTabControllers( const UNO3_SEQUENCE< UNO3_REFERENCE< UNO3_XTABCONTROLLER > >& xTabControllers ) throw( UNO3_RUNTIMEEXCEPTION );
 447
 448     /**_______________________________________________________________________________________________________
 449         @short          -
 450         @descr          -
 451
 452         @seealso        -
 453
 454         @param          -
 455
 456         @return         -
 457
 458         @onerror        -
 459     */
 460
 461     virtual UNO3_SEQUENCE< UNO3_REFERENCE< UNO3_XTABCONTROLLER > > SAL_CALL getTabControllers() throw( UNO3_RUNTIMEEXCEPTION );
 462
 463     //________________________________________________________________________________________________________
 464     //  XWindow
 465     //________________________________________________________________________________________________________
 466
 467     /**_______________________________________________________________________________________________________
 468         @short          -
 469         @descr          -
 470
 471         @seealso        -
 472
 473         @param          -
 474
 475         @return         -
 476
 477         @onerror        -
 478     */
 479
 480     virtual void SAL_CALL setVisible( sal_Bool bVisible ) throw( UNO3_RUNTIMEEXCEPTION );
 481
 482 //____________________________________________________________________________________________________________
 483 //      protected methods
 484 //____________________________________________________________________________________________________________
 485
 486 protected:
 487     using OComponentHelper::disposing;
 488     /**_______________________________________________________________________________________________________
 489         @short
 490         @descr
 491
 492         @seealso
 493
 494         @param
 495
 496         @return
 497
 498         @onerror
 499     */
 500
 501     virtual UNO3_WINDOWDESCRIPTOR* impl_getWindowDescriptor( const UNO3_REFERENCE< UNO3_XWINDOWPEER >& xParentPeer );
 502
 503     /**_______________________________________________________________________________________________________
 504         @short
 505         @descr
 506
 507         @seealso
 508
 509         @param
 510
 511         @return
 512
 513         @onerror
 514     */
 515
 516     virtual void impl_paint(            sal_Int32                                                       nX                      ,
 517                                     sal_Int32                                                   nY                      ,
 518                             const       UNO3_REFERENCE< UNO3_XGRAPHICS >&       xGraphics       );
 519
 520 //____________________________________________________________________________________________________________
 521 //      private methods
 522 //____________________________________________________________________________________________________________
 523
 524 private:
 525
 526     /**_______________________________________________________________________________________________________
 527         @short
 528         @descr
 529
 530         @seealso
 531
 532         @param
 533
 534         @return
 535
 536         @onerror
 537     */
 538
 539     void impl_activateTabControllers();
 540
 541     /**_______________________________________________________________________________________________________
 542         @short
 543         @descr
 544
 545         @seealso
 546
 547         @param
 548
 549         @return
 550
 551         @onerror
 552     */
 553
 554     void impl_cleanMemory();
 555
 556 //____________________________________________________________________________________________________________
 557 //      private variables
 558 //____________________________________________________________________________________________________________
 559
 560 private:
 561
 562     IMPL_ControlInfoList*                                                                       m_pControlInfoList              ;       /// list of pointer of "struct IMPL_ControlInfo" to hold child-controls
 563     UNO3_SEQUENCE< UNO3_REFERENCE< UNO3_XTABCONTROLLER > >      m_xTabControllerList    ;       /// list of references of XTabController to hold tab-order in this container
 564     UNO3_OMULTITYPEINTERFACECONTAINERHELPER                                     m_aListeners                    ;
 565
 566 };      // class BaseContainerControl
 567
 568 }       // namespace unocontrols
 569
 570 #endif  // ifndef _UNOCONTROLS_BASECONTAINERCONTROL_CTRL_HXX