UnoControls/source/inc/framecontrol.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: framecontrol.hxx,v $
  10  * $Revision: 1.6 $
  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_FRAMECONTROL_CTRL_HXX
  32 #define _UNOCONTROLS_FRAMECONTROL_CTRL_HXX
  33
  34 //______________________________________________________________________________________________________________
  35 //      includes of other projects
  36 //______________________________________________________________________________________________________________
  37
  38 #include <com/sun/star/frame/XFrameActionListener.hpp>
  39 #include <com/sun/star/frame/XComponentLoader.hpp>
  40 #include <com/sun/star/frame/XFrame.hpp>
  41 #include <com/sun/star/frame/FrameActionEvent.hpp>
  42 #include <com/sun/star/frame/FrameAction.hpp>
  43 #include <com/sun/star/lang/XServiceName.hpp>
  44 #include <com/sun/star/lang/XServiceInfo.hpp>
  45 #include <com/sun/star/lang/XConnectionPointContainer.hpp>
  46 #include <cppuhelper/propshlp.hxx>
  47
  48 //______________________________________________________________________________________________________________
  49 //      includes of my own project
  50 //______________________________________________________________________________________________________________
  51 #include "basecontrol.hxx"
  52 #include "OConnectionPointContainerHelper.hxx"
  53
  54 //______________________________________________________________________________________________________________
  55 //      namespaces
  56 //______________________________________________________________________________________________________________
  57
  58 namespace unocontrols{
  59
  60 #define UNO3_ANY                                                                                ::com::sun::star::uno::Any
  61 #define UNO3_ILLEGALARGUMENTEXCEPTION                                   ::com::sun::star::lang::IllegalArgumentException
  62 #define UNO3_IPROPERTYARRAYHELPER                                               ::cppu::IPropertyArrayHelper
  63 #define UNO3_OBROADCASTHELPER                                                   ::cppu::OBroadcastHelper
  64 #define UNO3_OCONNECTIONPOINTCONTAINERHELPER                    OConnectionPointContainerHelper
  65 #define UNO3_OMULTITYPEINTERFACECONTAINERHELPER                 ::cppu::OMultiTypeInterfaceContainerHelper
  66 #define UNO3_OPROPERTYSETHELPER                                                 ::cppu::OPropertySetHelper
  67 #define UNO3_OUSTRING                                                                   ::rtl::OUString
  68 #define UNO3_PROPERTY                                                                   ::com::sun::star::beans::Property
  69 #define UNO3_PROPERTYVALUE                                                              ::com::sun::star::beans::PropertyValue
  70 #define UNO3_REFERENCE                                                                  ::com::sun::star::uno::Reference
  71 #define UNO3_RUNTIMEEXCEPTION                                                   ::com::sun::star::uno::RuntimeException
  72 #define UNO3_SEQUENCE                                                                   ::com::sun::star::uno::Sequence
  73 #define UNO3_TYPE                                                                               ::com::sun::star::uno::Type
  74 #define UNO3_WINDOWDESCRIPTOR                           ::com::sun::star::awt::WindowDescriptor
  75 #define UNO3_XCONNECTIONPOINT                                                   ::com::sun::star::lang::XConnectionPoint
  76 #define UNO3_XCONNECTIONPOINTCONTAINER                                  ::com::sun::star::lang::XConnectionPointContainer
  77 #define UNO3_XCONTROLMODEL                                                              ::com::sun::star::awt::XControlModel
  78 #define UNO3_XFRAME                                                                             ::com::sun::star::frame::XFrame
  79 #define UNO3_XGRAPHICS                                                                  ::com::sun::star::awt::XGraphics
  80 #define UNO3_XINTERFACE                                                                 ::com::sun::star::uno::XInterface
  81 #define UNO3_XMULTISERVICEFACTORY                                               ::com::sun::star::lang::XMultiServiceFactory
  82 #define UNO3_XPROPERTYSETINFO                                                   ::com::sun::star::beans::XPropertySetInfo
  83 #define UNO3_XTOOLKIT                                                                   ::com::sun::star::awt::XToolkit
  84 #define UNO3_XWINDOWPEER                                                                ::com::sun::star::awt::XWindowPeer
  85
  86 //______________________________________________________________________________________________________________
  87 //      defines
  88 //______________________________________________________________________________________________________________
  89
  90 #define SERVICENAME_FRAMECONTROL                                                "com.sun.star.frame.FrameControl"
  91 #define IMPLEMENTATIONNAME_FRAMECONTROL                                 "stardiv.UnoControls.FrameControl"
  92 #define PROPERTYNAME_LOADERARGUMENTS                                    "LoaderArguments"
  93 #define PROPERTYNAME_COMPONENTURL                                               "ComponentURL"
  94 #define PROPERTYNAME_FRAME                                                              "Frame"
  95 #define ERRORTEXT_VOSENSHURE                                                    "This is an invalid property handle."
  96 #define PROPERTY_COUNT                                                                  3                                                                       // you must count the propertys
  97 #define PROPERTYHANDLE_COMPONENTURL                                             0                                                                                                               // Id must be the index into the array
  98 #define PROPERTYHANDLE_FRAME                                                    1
  99 #define PROPERTYHANDLE_LOADERARGUMENTS                                  2
 100
 101 //______________________________________________________________________________________________________________
 102 //      class
 103 //______________________________________________________________________________________________________________
 104
 105 class FrameControl      : public UNO3_XCONTROLMODEL
 106                     , public UNO3_XCONNECTIONPOINTCONTAINER
 107                     , public BaseControl                                                                // This order is neccessary for right initialization of m_aMutex!
 108                     , public UNO3_OBROADCASTHELPER
 109                     , public UNO3_OPROPERTYSETHELPER
 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     FrameControl( 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     ~FrameControl();
 151
 152     //__________________________________________________________________________________________________________
 153     //  XInterface
 154     //__________________________________________________________________________________________________________
 155
 156     /**_________________________________________________________________________________________________________
 157         @short
 158         @descr
 159
 160         @seealso
 161
 162         @param
 163
 164         @return
 165
 166         @onerror
 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
 209         @descr
 210
 211         @seealso
 212
 213         @param
 214
 215         @return
 216
 217         @onerror
 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     UNO3_ANY SAL_CALL queryAggregation( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 240
 241     //__________________________________________________________________________________________________________
 242     //  XControl
 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 createPeer(   const   UNO3_REFERENCE< UNO3_XTOOLKIT >&        xToolkit        ,
 259                                         const   UNO3_REFERENCE< UNO3_XWINDOWPEER >&     xParent         ) 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 sal_Bool SAL_CALL setModel( const UNO3_REFERENCE< UNO3_XCONTROLMODEL >& xModel ) 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 UNO3_REFERENCE< UNO3_XCONTROLMODEL > SAL_CALL getModel() throw( UNO3_RUNTIMEEXCEPTION );
 290
 291     //__________________________________________________________________________________________________________
 292     //  XComponent
 293     //__________________________________________________________________________________________________________
 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 dispose() throw( UNO3_RUNTIMEEXCEPTION );
 309
 310     //__________________________________________________________________________________________________________
 311     //  XView
 312     //__________________________________________________________________________________________________________
 313
 314     /**_________________________________________________________________________________________________________
 315         @short
 316         @descr
 317
 318         @seealso
 319
 320         @param
 321
 322         @return
 323
 324         @onerror
 325     */
 326
 327     virtual sal_Bool SAL_CALL setGraphics( const UNO3_REFERENCE< UNO3_XGRAPHICS >& xDevice ) throw( UNO3_RUNTIMEEXCEPTION );
 328
 329     /**_________________________________________________________________________________________________________
 330         @short
 331         @descr
 332
 333         @seealso
 334
 335         @param
 336
 337         @return
 338
 339         @onerror
 340     */
 341
 342     virtual UNO3_REFERENCE< UNO3_XGRAPHICS > SAL_CALL getGraphics() throw( UNO3_RUNTIMEEXCEPTION );
 343
 344     //__________________________________________________________________________________________________________
 345     //  XConnectionPointContainer
 346     //__________________________________________________________________________________________________________
 347
 348     /**_________________________________________________________________________________________________________
 349         @short
 350         @descr
 351
 352         @seealso
 353
 354         @param
 355
 356         @return
 357
 358         @onerror
 359     */
 360
 361     virtual UNO3_SEQUENCE< UNO3_TYPE > SAL_CALL getConnectionPointTypes() throw( UNO3_RUNTIMEEXCEPTION );
 362
 363     /**_________________________________________________________________________________________________________
 364         @short
 365         @descr
 366
 367         @seealso
 368
 369         @param
 370
 371         @return
 372
 373         @onerror
 374     */
 375
 376     virtual UNO3_REFERENCE< UNO3_XCONNECTIONPOINT > SAL_CALL queryConnectionPoint( const UNO3_TYPE& aType ) throw( UNO3_RUNTIMEEXCEPTION );
 377
 378     /**_________________________________________________________________________________________________________
 379         @short
 380         @descr
 381
 382         @seealso
 383
 384         @param
 385
 386         @return
 387
 388         @onerror
 389     */
 390
 391     virtual void SAL_CALL advise(       const   UNO3_TYPE&                                                      aType           ,
 392                                     const       UNO3_REFERENCE< UNO3_XINTERFACE >&      xListener       ) throw( UNO3_RUNTIMEEXCEPTION );
 393
 394     /**_________________________________________________________________________________________________________
 395         @short
 396         @descr
 397
 398         @seealso
 399
 400         @param
 401
 402         @return
 403
 404         @onerror
 405     */
 406
 407     virtual void SAL_CALL unadvise(     const   UNO3_TYPE&                                                      aType           ,
 408                                     const       UNO3_REFERENCE< UNO3_XINTERFACE >&      xListener       ) throw( UNO3_RUNTIMEEXCEPTION );
 409
 410     //__________________________________________________________________________________________________________
 411     //  impl but public methods to register service!
 412     //__________________________________________________________________________________________________________
 413
 414     /**_________________________________________________________________________________________________________
 415         @short
 416         @descr
 417
 418         @seealso
 419
 420         @param
 421
 422         @return
 423
 424         @onerror
 425     */
 426
 427     static const UNO3_SEQUENCE< UNO3_OUSTRING > impl_getStaticSupportedServiceNames();
 428
 429     /**_________________________________________________________________________________________________________
 430         @short
 431         @descr
 432
 433         @seealso
 434
 435         @param
 436
 437         @return
 438
 439         @onerror
 440     */
 441
 442     static const UNO3_OUSTRING impl_getStaticImplementationName();
 443
 444 //______________________________________________________________________________________________________________
 445 //      protected methods
 446 //______________________________________________________________________________________________________________
 447
 448 protected:
 449     using OPropertySetHelper::getFastPropertyValue;
 450     //__________________________________________________________________________________________________________
 451     //  OPropertySetHelper
 452     //__________________________________________________________________________________________________________
 453
 454     /**_________________________________________________________________________________________________________
 455         @short
 456         @descr
 457
 458         @seealso
 459
 460         @param
 461
 462         @return
 463
 464         @onerror
 465     */
 466
 467     virtual sal_Bool SAL_CALL convertFastPropertyValue(                 UNO3_ANY&       rConvertedValue ,
 468                                                                 UNO3_ANY&       rOldValue               ,
 469                                                                 sal_Int32       nHandle                 ,
 470                                                         const   UNO3_ANY&       rValue                  ) throw( UNO3_ILLEGALARGUMENTEXCEPTION );
 471
 472     /**_________________________________________________________________________________________________________
 473         @short
 474         @descr
 475
 476         @seealso
 477
 478         @param
 479
 480         @return
 481
 482         @onerror
 483     */
 484
 485     virtual void SAL_CALL setFastPropertyValue_NoBroadcast(                     sal_Int32       nHandle ,
 486                                                               const     UNO3_ANY&       rValue  ) throw ( ::com::sun::star::uno::Exception );
 487
 488     /**_________________________________________________________________________________________________________
 489         @short
 490         @descr
 491
 492         @seealso
 493
 494         @param
 495
 496         @return
 497
 498         @onerror
 499     */
 500
 501     virtual void SAL_CALL getFastPropertyValue( UNO3_ANY&       rValue  ,
 502                                                   sal_Int32     nHandle ) const ;
 503
 504     /**_________________________________________________________________________________________________________
 505         @short
 506         @descr
 507
 508         @seealso
 509
 510         @param
 511
 512         @return
 513
 514         @onerror
 515     */
 516
 517     virtual UNO3_IPROPERTYARRAYHELPER& SAL_CALL getInfoHelper();
 518
 519     //__________________________________________________________________________________________________________
 520     //  XPropertySet
 521     //__________________________________________________________________________________________________________
 522
 523     /**_________________________________________________________________________________________________________
 524         @short
 525         @descr
 526
 527         @seealso
 528
 529         @param
 530
 531         @return
 532
 533         @onerror
 534     */
 535
 536     UNO3_REFERENCE< UNO3_XPROPERTYSETINFO > SAL_CALL getPropertySetInfo() throw( UNO3_RUNTIMEEXCEPTION );
 537
 538     //__________________________________________________________________________________________________________
 539     //  BaseControl
 540     //__________________________________________________________________________________________________________
 541
 542     /**_________________________________________________________________________________________________________
 543         @short
 544         @descr
 545
 546         @seealso
 547
 548         @param
 549
 550         @return
 551
 552         @onerror
 553     */
 554
 555     virtual UNO3_WINDOWDESCRIPTOR* impl_getWindowDescriptor( const UNO3_REFERENCE< UNO3_XWINDOWPEER >& xParentPeer );
 556
 557 //______________________________________________________________________________________________________________
 558 //      private methods
 559 //______________________________________________________________________________________________________________
 560
 561 private:
 562
 563     /**_________________________________________________________________________________________________________
 564         @short
 565         @descr
 566
 567         @seealso
 568
 569         @param
 570
 571         @return
 572
 573         @onerror
 574     */
 575
 576     void impl_createFrame(      const   UNO3_REFERENCE< UNO3_XWINDOWPEER >&             xPeer                   ,
 577                             const       UNO3_OUSTRING&                                                  sURL                    ,
 578                             const       UNO3_SEQUENCE< UNO3_PROPERTYVALUE >&    seqArguments    );
 579
 580     /**_________________________________________________________________________________________________________
 581         @short
 582         @descr
 583
 584         @seealso
 585
 586         @param
 587
 588         @return
 589
 590         @onerror
 591     */
 592
 593     void impl_deleteFrame();
 594
 595     /**_________________________________________________________________________________________________________
 596         @short
 597         @descr
 598
 599         @seealso
 600
 601         @param
 602
 603         @return
 604
 605         @onerror
 606     */
 607
 608     static const UNO3_SEQUENCE< UNO3_PROPERTY > impl_getStaticPropertyDescriptor();
 609
 610
 611 //______________________________________________________________________________________________________________
 612 //      private variables
 613 //______________________________________________________________________________________________________________
 614
 615 private:
 616
 617     UNO3_REFERENCE< UNO3_XFRAME >                               m_xFrame                                        ;
 618     UNO3_OUSTRING                                                               m_sComponentURL                         ;
 619     UNO3_SEQUENCE< UNO3_PROPERTYVALUE >                 m_seqLoaderArguments            ;
 620     UNO3_OMULTITYPEINTERFACECONTAINERHELPER             m_aInterfaceContainer           ;
 621     UNO3_OCONNECTIONPOINTCONTAINERHELPER                m_aConnectionPointContainer     ;
 622
 623 };      // class FrameControl
 624
 625 }       // namespace unocontrols
 626
 627 #endif  // #ifndef _UNOCONTROLS_FRAMECONTROL_CTRL_HXX