UnoControls/inc/basecontainercontrol.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _UNOCONTROLS_BASECONTAINERCONTROL_CTRL_HXX
  30 #define _UNOCONTROLS_BASECONTAINERCONTROL_CTRL_HXX
  31
  32 //____________________________________________________________________________________________________________
  33 //  includes of other projects
  34 //____________________________________________________________________________________________________________
  35
  36 #include <com/sun/star/lang/XServiceName.hpp>
  37 #include <com/sun/star/lang/XServiceInfo.hpp>
  38 #include <com/sun/star/container/XContainer.hpp>
  39 #include <com/sun/star/container/XIndexContainer.hpp>
  40 #include <com/sun/star/container/XNameReplace.hpp>
  41 #include <com/sun/star/container/XContainerListener.hpp>
  42 #include <com/sun/star/container/XSet.hpp>
  43 #include <com/sun/star/container/ContainerEvent.hpp>
  44 #include <com/sun/star/container/XIndexReplace.hpp>
  45 #include <com/sun/star/container/XNameContainer.hpp>
  46 #include <vector>
  47
  48 //____________________________________________________________________________________________________________
  49 //  includes of my own project
  50 //____________________________________________________________________________________________________________
  51 #include "basecontrol.hxx"
  52
  53 //____________________________________________________________________________________________________________
  54 //  "namespaces"
  55 //____________________________________________________________________________________________________________
  56
  57 namespace unocontrols{
  58
  59 //____________________________________________________________________________________________________________
  60 //  structs, types, forwards
  61 //____________________________________________________________________________________________________________
  62
  63 struct IMPL_ControlInfo
  64 {
  65     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl > xControl ;
  66     ::rtl::OUString                         sName    ;
  67 };
  68
  69 //____________________________________________________________________________________________________________
  70 //  classes
  71 //____________________________________________________________________________________________________________
  72
  73 class BaseContainerControl  : public ::com::sun::star::awt::XControlModel
  74                             , public ::com::sun::star::awt::XControlContainer
  75                             , public BaseControl
  76 {
  77
  78 //____________________________________________________________________________________________________________
  79 //  public methods
  80 //____________________________________________________________________________________________________________
  81
  82 public:
  83
  84     //________________________________________________________________________________________________________
  85     //  construct/destruct
  86     //________________________________________________________________________________________________________
  87
  88     /**_______________________________________________________________________________________________________
  89         @short      -
  90         @descr      -
  91
  92         @seealso    -
  93
  94         @param      -
  95
  96         @return     -
  97
  98         @onerror    -
  99     */
 100
 101        BaseContainerControl( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xFactory );
 102
 103     /**_______________________________________________________________________________________________________
 104         @short      -
 105         @descr      -
 106
 107         @seealso    -
 108
 109         @param      -
 110
 111         @return     -
 112
 113         @onerror    -
 114     */
 115
 116     virtual ~BaseContainerControl();
 117
 118     //________________________________________________________________________________________________________
 119     //  XInterface
 120     //________________________________________________________________________________________________________
 121
 122     /**_______________________________________________________________________________________________________
 123         @short      give answer, if interface is supported
 124         @descr      The interfaces are searched by type.
 125
 126         @seealso    XInterface
 127
 128         @param      "rType" is the type of searched interface.
 129
 130         @return     Any     information about found interface
 131
 132         @onerror    A RuntimeException is thrown.
 133     */
 134
 135     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
 136         const ::com::sun::star::uno::Type& aType
 137     ) throw( ::com::sun::star::uno::RuntimeException );
 138
 139     //________________________________________________________________________________________________________
 140     //  XTypeProvider
 141     //________________________________________________________________________________________________________
 142
 143     /**_______________________________________________________________________________________________________
 144         @short      get information about supported interfaces
 145         @descr      -
 146
 147         @seealso    XTypeProvider
 148
 149         @param      -
 150
 151         @return     Sequence of types of all supported interfaces
 152
 153         @onerror    A RuntimeException is thrown.
 154     */
 155
 156     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes()
 157         throw( ::com::sun::star::uno::RuntimeException );
 158
 159     //________________________________________________________________________________________________________
 160     //  XAggregation
 161     //________________________________________________________________________________________________________
 162
 163     /**_______________________________________________________________________________________________________
 164         @short      -
 165         @descr      -
 166
 167         @seealso    -
 168
 169         @param      -
 170
 171         @return     -
 172
 173         @onerror    -
 174     */
 175
 176     virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation(
 177         const ::com::sun::star::uno::Type& aType
 178     ) throw( ::com::sun::star::uno::RuntimeException );
 179
 180     //________________________________________________________________________________________________________
 181     //  XControl
 182     //________________________________________________________________________________________________________
 183
 184     /**_______________________________________________________________________________________________________
 185         @short      -
 186         @descr      -
 187
 188         @seealso    -
 189
 190         @param      -
 191
 192         @return     -
 193
 194         @onerror    -
 195     */
 196
 197     virtual void SAL_CALL createPeer(
 198         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XToolkit >&      xToolkit ,
 199         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >&   xParent
 200     ) throw( ::com::sun::star::uno::RuntimeException );
 201
 202     /**_______________________________________________________________________________________________________
 203         @short      -
 204         @descr      -
 205
 206         @seealso    -
 207
 208         @param      -
 209
 210         @return     -
 211
 212         @onerror    -
 213     */
 214
 215     virtual sal_Bool SAL_CALL setModel(
 216         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel >& xModel
 217     ) throw( ::com::sun::star::uno::RuntimeException );
 218
 219     /**_______________________________________________________________________________________________________
 220         @short      -
 221         @descr      -
 222
 223         @seealso    -
 224
 225         @param      -
 226
 227         @return     -
 228
 229         @onerror    -
 230     */
 231
 232     virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControlModel > SAL_CALL getModel()
 233         throw( ::com::sun::star::uno::RuntimeException );
 234
 235     //________________________________________________________________________________________________________
 236     //  XComponent
 237     //________________________________________________________________________________________________________
 238
 239     /**_______________________________________________________________________________________________________
 240         @short      -
 241         @descr      -
 242
 243         @seealso    -
 244
 245         @param      -
 246
 247         @return     -
 248
 249         @onerror    -
 250     */
 251
 252     virtual void SAL_CALL dispose() throw( ::com::sun::star::uno::RuntimeException );
 253
 254     //________________________________________________________________________________________________________
 255     //  XEventListener
 256     //________________________________________________________________________________________________________
 257
 258     /**_______________________________________________________________________________________________________
 259         @short      -
 260         @descr      -
 261
 262         @seealso    -
 263
 264         @param      -
 265
 266         @return     -
 267
 268         @onerror    -
 269     */
 270
 271     virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& rEvent ) throw( ::com::sun::star::uno::RuntimeException );
 272
 273     //________________________________________________________________________________________________________
 274     //  XControlContainer
 275     //________________________________________________________________________________________________________
 276
 277     /**_______________________________________________________________________________________________________
 278         @short      -
 279         @descr      -
 280
 281         @seealso    -
 282
 283         @param      -
 284
 285         @return     -
 286
 287         @onerror    -
 288     */
 289
 290     virtual void SAL_CALL addControl(
 291         const ::rtl::OUString&                            sName    ,
 292         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >&    xControl
 293     ) throw( ::com::sun::star::uno::RuntimeException  );
 294
 295     /**_______________________________________________________________________________________________________
 296         @short      -
 297         @descr      -
 298
 299         @seealso    -
 300
 301         @param      -
 302
 303         @return     -
 304
 305         @onerror    -
 306     */
 307
 308     virtual void SAL_CALL addContainerListener(
 309         const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener
 310     ) throw( ::com::sun::star::uno::RuntimeException );
 311
 312     /**_______________________________________________________________________________________________________
 313         @short      -
 314         @descr      -
 315
 316         @seealso    -
 317
 318         @param      -
 319
 320         @return     -
 321
 322         @onerror    -
 323     */
 324
 325     virtual void SAL_CALL removeControl(
 326         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl >& xControl
 327     ) throw( ::com::sun::star::uno::RuntimeException );
 328
 329     /**_______________________________________________________________________________________________________
 330         @short      -
 331         @descr      -
 332
 333         @seealso    -
 334
 335         @param      -
 336
 337         @return     -
 338
 339         @onerror    -
 340     */
 341
 342     virtual void SAL_CALL removeContainerListener(
 343         const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener
 344     ) throw( ::com::sun::star::uno::RuntimeException );
 345
 346     /**_______________________________________________________________________________________________________
 347         @short      -
 348         @descr      -
 349
 350         @seealso    -
 351
 352         @param      -
 353
 354         @return     -
 355
 356         @onerror    -
 357     */
 358
 359     virtual void SAL_CALL setStatusText(
 360         const ::rtl::OUString& sStatusText
 361     ) throw( ::com::sun::star::uno::RuntimeException );
 362
 363     /**_______________________________________________________________________________________________________
 364         @short      -
 365         @descr      -
 366
 367         @seealso    -
 368
 369         @param      -
 370
 371         @return     -
 372
 373         @onerror    -
 374     */
 375
 376     virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl > SAL_CALL getControl(
 377         const ::rtl::OUString& sName
 378     ) throw( ::com::sun::star::uno::RuntimeException );
 379
 380     /**_______________________________________________________________________________________________________
 381         @short      -
 382         @descr      -
 383
 384         @seealso    -
 385
 386         @param      -
 387
 388         @return     -
 389
 390         @onerror    -
 391     */
 392
 393     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl > > SAL_CALL getControls()
 394         throw( ::com::sun::star::uno::RuntimeException );
 395
 396     //________________________________________________________________________________________________________
 397     //  XUnoControlContainer
 398     //________________________________________________________________________________________________________
 399
 400     /**_______________________________________________________________________________________________________
 401         @short      -
 402         @descr      -
 403
 404         @seealso    -
 405
 406         @param      -
 407
 408         @return     -
 409
 410         @onerror    -
 411     */
 412
 413     virtual void SAL_CALL addTabController(
 414         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTabController >& xTabController
 415     ) throw( ::com::sun::star::uno::RuntimeException );
 416
 417     /**_______________________________________________________________________________________________________
 418         @short      -
 419         @descr      -
 420
 421         @seealso    -
 422
 423         @param      -
 424
 425         @return     -
 426
 427         @onerror    -
 428     */
 429
 430     virtual void SAL_CALL removeTabController(
 431         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTabController >& xTabController
 432     ) throw( ::com::sun::star::uno::RuntimeException );
 433
 434     /**_______________________________________________________________________________________________________
 435         @short      -
 436         @descr      -
 437
 438         @seealso    -
 439
 440         @param      -
 441
 442         @return     -
 443
 444         @onerror    -
 445     */
 446
 447     virtual void SAL_CALL setTabControllers(
 448         const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTabController > >& xTabControllers
 449     ) throw( ::com::sun::star::uno::RuntimeException );
 450
 451     /**_______________________________________________________________________________________________________
 452         @short      -
 453         @descr      -
 454
 455         @seealso    -
 456
 457         @param      -
 458
 459         @return     -
 460
 461         @onerror    -
 462     */
 463
 464     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTabController > > SAL_CALL getTabControllers()
 465         throw( ::com::sun::star::uno::RuntimeException );
 466
 467     //________________________________________________________________________________________________________
 468     //  XWindow
 469     //________________________________________________________________________________________________________
 470
 471     /**_______________________________________________________________________________________________________
 472         @short      -
 473         @descr      -
 474
 475         @seealso    -
 476
 477         @param      -
 478
 479         @return     -
 480
 481         @onerror    -
 482     */
 483
 484     virtual void SAL_CALL setVisible( sal_Bool bVisible ) throw( ::com::sun::star::uno::RuntimeException );
 485
 486 //____________________________________________________________________________________________________________
 487 //  protected methods
 488 //____________________________________________________________________________________________________________
 489
 490 protected:
 491     using OComponentHelper::disposing;
 492     /**_______________________________________________________________________________________________________
 493         @short
 494         @descr
 495
 496         @seealso
 497
 498         @param
 499
 500         @return
 501
 502         @onerror
 503     */
 504
 505     virtual ::com::sun::star::awt::WindowDescriptor* impl_getWindowDescriptor(
 506         const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >& xParentPeer
 507     );
 508
 509     /**_______________________________________________________________________________________________________
 510         @short
 511         @descr
 512
 513         @seealso
 514
 515         @param
 516
 517         @return
 518
 519         @onerror
 520     */
 521
 522     virtual void impl_paint(
 523         sal_Int32                                           nX ,
 524         sal_Int32                                           nY ,
 525         const   ::com::sun::star::uno::Reference< ::com::sun::star::awt::XGraphics >&   xGraphics
 526     );
 527
 528 //____________________________________________________________________________________________________________
 529 //  private methods
 530 //____________________________________________________________________________________________________________
 531
 532 private:
 533
 534     /**_______________________________________________________________________________________________________
 535         @short
 536         @descr
 537
 538         @seealso
 539
 540         @param
 541
 542         @return
 543
 544         @onerror
 545     */
 546
 547     void impl_activateTabControllers();
 548
 549     /**_______________________________________________________________________________________________________
 550         @short
 551         @descr
 552
 553         @seealso
 554
 555         @param
 556
 557         @return
 558
 559         @onerror
 560     */
 561
 562     void impl_cleanMemory();
 563
 564 //____________________________________________________________________________________________________________
 565 //  private variables
 566 //____________________________________________________________________________________________________________
 567
 568 private:
 569     // list of pointer of "struct IMPL_ControlInfo" to hold child-controls
 570     ::std::vector< IMPL_ControlInfo* > maControlInfoList;
 571
 572     // list of references of XTabController to hold tab-order in this container
 573     ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference< ::com::sun::star::awt::XTabController > >  m_xTabControllerList    ;
 574
 575     ::cppu::OMultiTypeInterfaceContainerHelper                          m_aListeners            ;
 576
 577 };  // class BaseContainerControl
 578
 579 }   // namespace unocontrols
 580
 581 #endif  // ifndef _UNOCONTROLS_BASECONTAINERCONTROL_CTRL_HXX
 582
 583 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */