include/realmedia/rmawin.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmawin.h 7 2003-05-30 02:18:02Z gabest $
   4  *
   5  *  Copyright (C) 1995-1999 RealNetworks, Inc. All rights reserved.
   6  *
   7  *  http://www.real.com/devzone
   8  *
   9  *  This program contains proprietary
  10  *  information of Progressive Networks, Inc, and is licensed
  11  *  subject to restrictions on use and distribution.
  12  *
  13  *
  14  *  RealMedia Architecture Simple Window Interfaces.
  15  *
  16  */
  17
  18 #ifndef _RMAWIN_H_
  19 #define _RMAWIN_H_
  20
  21 /*
  22  * Forward declarations of some interfaces defined or used here-in.
  23  */
  24 typedef _INTERFACE      IRMASite                        IRMASite;
  25 typedef _INTERFACE      IRMASiteUser                    IRMASiteUser;
  26 typedef _INTERFACE      IRMASiteWindowed                IRMASiteWindowed;
  27 typedef _INTERFACE      IRMASiteEventHandler            IRMASiteEventHandler;
  28 typedef _INTERFACE      IRMASiteWindowless              IRMASiteWindowless;
  29 typedef _INTERFACE      IRMASiteWatcher                 IRMASiteWatcher;
  30 typedef _INTERFACE      IRMAValues                      IRMAValues;
  31 typedef _INTERFACE      IRMASiteFullScreen              IRMASiteFullScreen;
  32 typedef _INTERFACE      IRMALayoutSiteGroupManager      IRMALayoutSiteGroupManager;
  33 typedef _INTERFACE      IRMAEventHook                   IRMAEventHook;
  34
  35 typedef struct _PNxWindow   PNxWindow;
  36 typedef struct _PNxSize     PNxSize;
  37 typedef struct _PNxPoint    PNxPoint;
  38 typedef struct _PNxRect     PNxRect;
  39 typedef void* PNxRegion;
  40
  41
  42 /****************************************************************************
  43  *
  44  *  Interface:
  45  *
  46  *      IRMASiteWindowed
  47  *
  48  *  Purpose:
  49  *
  50  *      Interface for IRMASite objects which are associated with platform
  51  *      specific window objects on Microsoft Windows and X-Windows.
  52  *
  53  *  IID_IRMASiteWindowed:
  54  *
  55  *      {00000D01-0901-11d1-8B06-00A024406D59}
  56  *
  57  */
  58 DEFINE_GUID(IID_IRMASiteWindowed, 0x00000D01, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  59                         0xa0, 0x24, 0x40, 0x6d, 0x59);
  60
  61 #define CLSID_IRMASiteWindowed  IID_IRMASiteWindowed
  62
  63
  64 #undef  INTERFACE
  65 #define INTERFACE   IRMASiteWindowed
  66
  67 DECLARE_INTERFACE_(IRMASiteWindowed, IUnknown)
  68 {
  69     /*
  70      * IUnknown methods
  71      */
  72     STDMETHOD(QueryInterface)   (THIS_
  73                                 REFIID riid,
  74                                 void** ppvObj) PURE;
  75
  76     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
  77
  78     STDMETHOD_(ULONG,Release)   (THIS) PURE;
  79
  80     /*
  81      * IRMASiteWindowed methods called by site suppliers
  82      * when they want the site associated with a
  83      * previously created (and externally managed) window.
  84      * This method will "sub-class" that window (Win32).
  85      * On Unix, the site supplier must pass events from
  86      * the externally managed window to the core via
  87      * IRMAClientEngine::EventOccurred(). Please note that
  88      * The PNxWindow ptr must remain in scope for the life
  89      * of Site.
  90      *
  91      */
  92     STDMETHOD(AttachWindow)     (THIS_
  93                                 PNxWindow* /*IN*/ pWindow) PURE;
  94
  95     STDMETHOD(DetachWindow)     (THIS) PURE;
  96
  97     /*
  98      * IRMASiteWindowed methods called by Owners of the site
  99      * in the event that want a default top level window created
 100      * for the site.
 101      */
 102     STDMETHOD(Create)           (THIS_
 103                                 void* ParentWindow,
 104                                 UINT32 style) PURE;
 105
 106     STDMETHOD(Destroy)          (THIS) PURE;
 107
 108     /*
 109      * IRMASiteWindowed method. Returns actual window of the site.
 110      */
 111     STDMETHOD_(PNxWindow*,GetWindow)(THIS) PURE;
 112 };
 113
 114
 115
 116 /****************************************************************************
 117  *
 118  *  Interface:
 119  *
 120  *      IRMASiteWindowless
 121  *
 122  *  Purpose:
 123  *
 124  *      Interface for IRMASite objects which are "windowless" or not
 125  *      associated with platform specific window objects.
 126  *
 127  *  IID_IRMASiteWindowless:
 128  *
 129  *      {00000D02-0901-11d1-8B06-00A024406D59}
 130  *
 131  */
 132 DEFINE_GUID(IID_IRMASiteWindowless, 0x00000D02, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 133                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 134
 135 #undef  INTERFACE
 136 #define INTERFACE   IRMASiteWindowless
 137
 138 #define CLSID_IRMASiteWindowless IID_IRMASiteWindowless
 139
 140 DECLARE_INTERFACE_(IRMASiteWindowless, IUnknown)
 141 {
 142     /*
 143      * IUnknown methods
 144      */
 145     STDMETHOD(QueryInterface)   (THIS_
 146                                 REFIID riid,
 147                                 void** ppvObj) PURE;
 148
 149     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 150
 151     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 152
 153     /*
 154      * IRMASiteWindowless methods called by owners of the site.
 155      */
 156     STDMETHOD(EventOccurred)    (THIS_
 157                                 PNxEvent* /*IN*/ pEvent) PURE;
 158
 159     /*
 160      * IRMASiteWindowless method. Returns some parent window that
 161      * owns the windowless site. Useful for right-click menus and
 162      * dialog box calls.
 163      */
 164     STDMETHOD_(PNxWindow*,GetParentWindow)(THIS) PURE;
 165 };
 166
 167
 168 /****************************************************************************
 169  *
 170  *  Interface:
 171  *
 172  *      IRMASite
 173  *
 174  *  Purpose:
 175  *
 176  *      Interface for IRMASite objects.
 177  *
 178  *  IID_IRMASite:
 179  *
 180  *      {00000D03-0901-11d1-8B06-00A024406D59}
 181  *
 182  */
 183 DEFINE_GUID(IID_IRMASite, 0x00000D03, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 184                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 185
 186 #undef  INTERFACE
 187 #define INTERFACE   IRMASite
 188
 189 DECLARE_INTERFACE_(IRMASite, IUnknown)
 190 {
 191     /*
 192      * IUnknown methods
 193      */
 194     STDMETHOD(QueryInterface)   (THIS_
 195                                 REFIID riid,
 196                                 void** ppvObj) PURE;
 197
 198     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 199
 200     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 201
 202     /*
 203      * IRMASite methods usually called by the "context" to
 204      * associate users with the site, and to create child sites
 205      * as appropriate.
 206      */
 207     STDMETHOD(AttachUser)       (THIS_
 208                                 IRMASiteUser*   /*IN*/  pUser) PURE;
 209
 210     STDMETHOD(DetachUser)       (THIS) PURE;
 211
 212
 213     STDMETHOD(GetUser)          (THIS_
 214                                 REF(IRMASiteUser*) /*OUT*/ pUser) PURE;
 215
 216     STDMETHOD(CreateChild)      (THIS_
 217                                 REF(IRMASite*)  /*OUT*/ pChildSite) PURE;
 218
 219     STDMETHOD(DestroyChild)     (THIS_
 220                                 IRMASite*       /*IN*/  pChildSite) PURE;
 221
 222     /*
 223      * IRMASite methods called by the the "context" in which the site
 224      * is displayed in order to manage its position. Site users should
 225      * not generally call these methods.
 226      */
 227     STDMETHOD(AttachWatcher)    (THIS_
 228                                 IRMASiteWatcher* /*IN*/ pWatcher) PURE;
 229
 230     STDMETHOD(DetachWatcher)    (THIS) PURE;
 231
 232     STDMETHOD(SetPosition)      (THIS_
 233                                 PNxPoint                position) PURE;
 234
 235     STDMETHOD(GetPosition)      (THIS_
 236                                 REF(PNxPoint)           position) PURE;
 237
 238     /*
 239      * IRMASite methods called by the user of the site to get
 240      * information about the site, and to manipulate the site.
 241      */
 242     STDMETHOD(SetSize)          (THIS_
 243                                 PNxSize                 size) PURE;
 244
 245     STDMETHOD(GetSize)          (THIS_
 246                                 REF(PNxSize)            size) PURE;
 247
 248     STDMETHOD(DamageRect)       (THIS_
 249                                 PNxRect                 rect) PURE;
 250
 251     STDMETHOD(DamageRegion)     (THIS_
 252                                 PNxRegion               region) PURE;
 253
 254     STDMETHOD(ForceRedraw)      (THIS) PURE;
 255 };
 256
 257
 258 /****************************************************************************
 259  *
 260  *  Interface:
 261  *
 262  *      IRMASiteUser
 263  *
 264  *  Purpose:
 265  *
 266  *      Interface for the user of the IRMASite objects.
 267  *
 268  *  IID_IRMASiteUser:
 269  *
 270  *      {00000D04-0901-11d1-8B06-00A024406D59}
 271  *
 272  */
 273 DEFINE_GUID(IID_IRMASiteUser, 0x00000D04, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 274                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 275
 276 #undef  INTERFACE
 277 #define INTERFACE   IRMASiteUser
 278
 279 DECLARE_INTERFACE_(IRMASiteUser, IUnknown)
 280 {
 281     /*
 282      * IUnknown methods
 283      */
 284     STDMETHOD(QueryInterface)   (THIS_
 285                                 REFIID riid,
 286                                 void** ppvObj) PURE;
 287
 288     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 289
 290     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 291
 292     /*
 293      * IRMASiteUser methods usually called by the "context" to
 294      * associate users with the site.
 295      */
 296     STDMETHOD(AttachSite)       (THIS_
 297                                 IRMASite*       /*IN*/ pSite) PURE;
 298
 299     STDMETHOD(DetachSite)       (THIS) PURE;
 300
 301     /*
 302      * IRMASiteUser methods called to inform user of an event.
 303      */
 304     STDMETHOD(HandleEvent)      (THIS_
 305                                 PNxEvent*       /*IN*/ pEvent) PURE;
 306
 307     STDMETHOD_(BOOL,NeedsWindowedSites) (THIS) PURE;
 308 };
 309
 310 /****************************************************************************
 311  *
 312  *  Interface:
 313  *
 314  *      IRMASiteWatcher
 315  *
 316  *  Purpose:
 317  *
 318  *      Interface for IRMASiteWatcher objects.
 319  *
 320  *  IID_IRMASite:
 321  *
 322  *      {00000D05-0901-11d1-8B06-00A024406D59}
 323  *
 324  */
 325 DEFINE_GUID(IID_IRMASiteWatcher, 0x00000D05, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 326                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 327
 328 #undef  INTERFACE
 329 #define INTERFACE   IRMASiteWatcher
 330
 331 DECLARE_INTERFACE_(IRMASiteWatcher, IUnknown)
 332 {
 333     /*
 334      * IUnknown methods
 335      */
 336     STDMETHOD(QueryInterface)   (THIS_
 337                                 REFIID riid,
 338                                 void** ppvObj) PURE;
 339
 340     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 341
 342     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 343
 344     /*
 345      * IRMASiteWatcher methods called by the site when a watcher
 346      * is attached to or detached from it.
 347      */
 348     STDMETHOD(AttachSite)       (THIS_
 349                                 IRMASite*       /*IN*/  pSite) PURE;
 350
 351     STDMETHOD(DetachSite)       (THIS) PURE;
 352
 353     /*
 354      * IRMASiteWatcher methods called by the site an attempt is
 355      * made to change it's position or size. The site watcher must
 356      * return PNR_OK for the change to occur. If the site watcher
 357      * returns any value other than PNR_OK then the size or position
 358      * will not change. The site watcher can also modify the new
 359      * size of position.
 360      */
 361     STDMETHOD(ChangingPosition) (THIS_
 362                                 PNxPoint                posOld,
 363                                 REF(PNxPoint)/*IN-OUT*/ posNew) PURE;
 364
 365     STDMETHOD(ChangingSize)     (THIS_
 366                                 PNxSize                 sizeOld,
 367                                 REF(PNxSize) /*IN-OUT*/ sizeNew) PURE;
 368 };
 369
 370 /****************************************************************************
 371  *
 372  *  Interface:
 373  *
 374  *      IRMASiteUserSupplier
 375  *
 376  *  Purpose:
 377  *
 378  *      Interface implemented by renderers and objects with provide layouts to
 379  *      the client core. This interface is called by the core when it needs a
 380  *      new IRMASiteUser, or when it is done using an IRMASiteUser.
 381  *
 382  *  IID_IRMASiteUserSupplier:
 383  *
 384  *      {00000D06-0901-11d1-8B06-00A024406D59}
 385  *
 386  */
 387 DEFINE_GUID(IID_IRMASiteUserSupplier, 0x00000D06, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 388                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 389
 390 #undef  INTERFACE
 391 #define INTERFACE   IRMASiteUserSupplier
 392
 393 DECLARE_INTERFACE_(IRMASiteUserSupplier, IUnknown)
 394 {
 395     /*
 396      * IUnknown methods
 397      */
 398     STDMETHOD(QueryInterface)   (THIS_
 399                                 REFIID riid,
 400                                 void** ppvObj) PURE;
 401
 402     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 403
 404     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 405
 406     /*
 407      * IRMASiteUserSupplier methods usually called by the
 408      * "context" to ask for additional or to release previously
 409      * created site users.
 410      */
 411     STDMETHOD(CreateSiteUser)   (THIS_
 412                                 REF(IRMASiteUser*)/*OUT*/ pSiteUser) PURE;
 413
 414     STDMETHOD(DestroySiteUser)  (THIS_
 415                                 IRMASiteUser*     /*IN*/ pSiteUser) PURE;
 416
 417     STDMETHOD_(BOOL,NeedsWindowedSites) (THIS) PURE;
 418 };
 419
 420
 421 /****************************************************************************
 422  *
 423  *  Interface:
 424  *
 425  *      IRMASiteSupplier
 426  *
 427  *  Purpose:
 428  *
 429  *      Interface implemented by users of the client core. This interface is
 430  *      called by the core when it needs a new IRMASite, or when it is done
 431  *      using an IRMASite.
 432  *
 433  *  IID_IRMASiteSupplier:
 434  *
 435  *      {00000D07-0901-11d1-8B06-00A024406D59}
 436  *
 437  */
 438 DEFINE_GUID(IID_IRMASiteSupplier, 0x00000D07, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 439                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 440
 441 #undef  INTERFACE
 442 #define INTERFACE   IRMASiteSupplier
 443
 444 DECLARE_INTERFACE_(IRMASiteSupplier, IUnknown)
 445 {
 446     /*
 447      * IUnknown methods
 448      */
 449     STDMETHOD(QueryInterface)   (THIS_
 450                                 REFIID riid,
 451                                 void** ppvObj) PURE;
 452
 453     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 454
 455     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 456
 457     /*
 458      * IRMASiteSupplier methods
 459      */
 460
 461     /************************************************************************
 462      *  Method:
 463      *      IRMASiteSupplier::SitesNeeded
 464      *  Purpose:
 465      *    Called to inform the site supplier that a site with a particular
 466      *    set of characteristics is needed. If the site supplier can
 467      *    fulfill the request it should call the site manager and add one
 468      *    or more new sites.
 469      *    Note that the request for sites is associated with a Request ID
 470      *    the client core will inform the site supplier when this requested
 471      *    site is no longer needed.
 472      */
 473     STDMETHOD(SitesNeeded)      (THIS_
 474                                 UINT32                  uReqestID,
 475                                 IRMAValues*             pSiteProps) PURE;
 476
 477     /************************************************************************
 478      *  Method:
 479      *    IRMASiteSupplier::SitesNotNeeded
 480      *  Purpose:
 481      *    Called to inform the site supplier that all sites from a previos
 482      *    site request are no longer needed. If the site supplier had
 483      *    previously created non-persistant sites (like popup windows)
 484      *    to fulfill a request for sites it should call the site manager
 485      *    and remove those sites.
 486      */
 487     STDMETHOD(SitesNotNeeded)   (THIS_
 488                                 UINT32                  uReqestID) PURE;
 489
 490
 491     /************************************************************************
 492      *  Method:
 493      *    IRMASiteSupplier::BeginChangeLayout
 494      *  Purpose:
 495      *    Called to inform the site supplier a layout change has beginning
 496      *    it can expect to recieve SitesNeeded() and SitesNotNeeded() calls
 497      *    while a layout change is in progress,
 498      */
 499     STDMETHOD(BeginChangeLayout) (THIS) PURE;
 500
 501     /************************************************************************
 502      *  Method:
 503      *    IRMASiteSupplier::DoneChangeLayout
 504      *  Purpose:
 505      *    Called to inform the site supplier the layout change has been
 506      *    completed.
 507      */
 508     STDMETHOD(DoneChangeLayout) (THIS) PURE;
 509
 510 };
 511
 512
 513 /****************************************************************************
 514  *
 515  *  Interface:
 516  *
 517  *      IRMASiteManager
 518  *
 519  *  Purpose:
 520  *
 521  *      Interface implemented by the client core. This interface is called
 522  *      by users of the client core to inform it of IRMASite's which are
 523  *      available for layout of renderers
 524  *
 525  *  IID_IRMASiteManager:
 526  *
 527  *      {00000D08-0901-11d1-8B06-00A024406D59}
 528  *
 529  */
 530 DEFINE_GUID(IID_IRMASiteManager, 0x00000D08, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
 531                         0xa0, 0x24, 0x40, 0x6d, 0x59);
 532
 533 #undef  INTERFACE
 534 #define INTERFACE   IRMASiteManager
 535
 536 DECLARE_INTERFACE_(IRMASiteManager, IUnknown)
 537 {
 538     /*
 539      * IUnknown methods
 540      */
 541     STDMETHOD(QueryInterface)   (THIS_
 542                                 REFIID riid,
 543                                 void** ppvObj) PURE;
 544
 545     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 546
 547     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 548
 549     /*
 550      * IRMASiteManager methods
 551      */
 552
 553     /************************************************************************
 554      *  Method:
 555      *      IRMASiteManager::AddSite
 556      *  Purpose:
 557      *    Called to inform the site manager of the existance of a site.
 558      */
 559     STDMETHOD(AddSite)          (THIS_
 560                                 IRMASite*               pSite) PURE;
 561
 562     /************************************************************************
 563      *  Method:
 564      *      IRMASiteManager::RemoveSite
 565      *  Purpose:
 566      *    Called to inform the site manager that a site is no longer
 567      *    available.
 568      */
 569     STDMETHOD(RemoveSite)       (THIS_
 570                                 IRMASite*               pSite) PURE;
 571 };
 572
 573
 574 /****************************************************************************
 575  *
 576  *  Interface:
 577  *
 578  *      IRMAMultiInstanceSiteUserSupplier
 579  *
 580  *  Purpose:
 581  *
 582  *      This is the interface for a special default object which is available
 583  *      from the common class factory. This object will act as a site user
 584  *      supplier for any renderer (or other site user object) that wants
 585  *      default support for multiple instances. The site user must work as
 586  *      a windowless site for this default implementation to work. The
 587  *      default object also implements the IRMASite interfave to allow
 588  *      the site user object to control all the sites through a single
 589  *      interface instance.
 590  *
 591  *  IID_IRMAMultiInstanceSiteUserSupplier:
 592  *
 593  *      {00000D09-0901-11d1-8B06-00A024406D59}
 594  *
 595  */
 596 DEFINE_GUID(IID_IRMAMultiInstanceSiteUserSupplier, 0x00000D09, 0x901,
 597             0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 598
 599 #define CLSID_IRMAMultiInstanceSiteUserSupplier \
 600                 IID_IRMAMultiInstanceSiteUserSupplier
 601
 602 #undef  INTERFACE
 603 #define INTERFACE   IRMAMultiInstanceSiteUserSupplier
 604
 605 DECLARE_INTERFACE_(IRMAMultiInstanceSiteUserSupplier, IUnknown)
 606 {
 607     /*
 608      * IUnknown methods
 609      */
 610     STDMETHOD(QueryInterface)   (THIS_
 611                                 REFIID riid,
 612                                 void** ppvObj) PURE;
 613
 614     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 615
 616     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 617
 618     /*
 619      * IRMAMultiInstanceSiteUserSupplier methods called by site users.
 620      */
 621     STDMETHOD(SetSingleSiteUser)                (THIS_
 622                                                 IUnknown*       pUnknown) PURE;
 623
 624     STDMETHOD(ReleaseSingleSiteUser)            (THIS) PURE;
 625
 626 };
 627
 628 /****************************************************************************
 629  *
 630  *  Interface:
 631  *      IRMASiteFullScreen
 632  *
 633  *  Purpose:
 634  *
 635  *      This is the interface for turning on/off the full screen mode
 636  *
 637  *  IID_IRMASiteFullScreen:
 638  *
 639  *      {00000D0B-0901-11d1-8B06-00A024406D59}
 640  *
 641  */
 642 DEFINE_GUID(IID_IRMASiteFullScreen, 0x00000D0B, 0x901,
 643             0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 644
 645 #undef  INTERFACE
 646 #define INTERFACE   IRMASiteFullScreen
 647
 648 DECLARE_INTERFACE_(IRMASiteFullScreen, IUnknown)
 649 {
 650     /*
 651      * IUnknown methods
 652      */
 653     STDMETHOD(QueryInterface)   (THIS_
 654                                 REFIID riid,
 655                                 void** ppvObj) PURE;
 656
 657     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 658
 659     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 660
 661     /*
 662      * IRMASiteFullScreen methods
 663      */
 664     STDMETHOD(EnterFullScreen)  (THIS) PURE;
 665
 666     STDMETHOD(ExitFullScreen)   (THIS) PURE;
 667
 668     STDMETHOD(TestFullScreen)   (THIS_
 669                                 void* hTestBitmap,const char* pszStatusText) PURE;
 670
 671     STDMETHOD_(BOOL, IsFullScreen) (THIS) PURE;
 672 };
 673
 674
 675
 676
 677 /****************************************************************************
 678  *
 679  *  Interface:
 680  *      IRMAEventHookMgr
 681  *
 682  *  Purpose:
 683  *
 684  *      Add ability to hook events from a named region
 685  *
 686  *  IID_IRMAEventHookMgr:
 687  *
 688  *      {00000D0D-0901-11d1-8B06-00A024406D59}
 689  *
 690  */
 691 DEFINE_GUID(IID_IRMAEventHookMgr, 0x00000D0D, 0x901,
 692             0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 693
 694 #undef  INTERFACE
 695 #define INTERFACE   IRMAEventHookMgr
 696
 697 DECLARE_INTERFACE_(IRMAEventHookMgr, IUnknown)
 698 {
 699     /*
 700      * IUnknown methods
 701      */
 702     STDMETHOD(QueryInterface)   (THIS_
 703                                 REFIID riid,
 704                                 void** ppvObj) PURE;
 705
 706     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 707
 708     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 709
 710     /*
 711      * IRMAEventHookMgr methods
 712      */
 713     STDMETHOD(AddHook)          (THIS_
 714                                 IRMAEventHook* pHook,
 715                                 const char* pRegionName,
 716                                 UINT16 uLayer) PURE;
 717
 718     STDMETHOD(RemoveHook)       (THIS_
 719                                 IRMAEventHook* pHook,
 720                                 const char* pRegionName,
 721                                 UINT16 uLayer) PURE;
 722 };
 723
 724 /****************************************************************************
 725  *
 726  *  Interface:
 727  *      IRMAEventHook
 728  *
 729  *  Purpose:
 730  *
 731  *      Object that gets hooked events sent by IRMAEventHookMgr
 732  *
 733  *  IID_IRMAEventHookMgr:
 734  *
 735  *      {00000D0E-0901-11d1-8B06-00A024406D59}
 736  *
 737  */
 738 DEFINE_GUID(IID_IRMAEventHook, 0x00000D0E, 0x901,
 739             0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 740
 741 #undef  INTERFACE
 742 #define INTERFACE   IRMAEventHook
 743
 744 DECLARE_INTERFACE_(IRMAEventHook, IUnknown)
 745 {
 746     /*
 747      * IUnknown methods
 748      */
 749     STDMETHOD(QueryInterface)   (THIS_
 750                                 REFIID riid,
 751                                 void** ppvObj) PURE;
 752
 753     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 754
 755     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 756
 757     /*
 758      * IRMAEventHook methods
 759      */
 760     STDMETHOD(SiteAdded)        (THIS_
 761                                 IRMASite* pSite) PURE;
 762     STDMETHOD(HandleEvent)      (THIS_
 763                                 IRMASite* pSite,
 764                                 PNxEvent* pEvent) PURE;
 765     STDMETHOD(SiteRemoved)      (THIS_
 766                                 IRMASite* pSite) PURE;
 767 };
 768
 769
 770 /****************************************************************************
 771  *
 772  *  Interface:
 773  *      IRMAStatusMessage
 774  *
 775  *  Purpose:
 776  *
 777  *      This is the interface for setting the status text.
 778  *
 779  *  IID_IRMAStatusMessage:
 780  *
 781  *      {00000D10-0901-11d1-8B06-00A024406D59}
 782  *
 783  */
 784 DEFINE_GUID(IID_IRMAStatusMessage, 0x00000D10, 0x901,
 785             0x11d1, 0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 786
 787 #undef  INTERFACE
 788 #define INTERFACE   IRMAStatusMessage
 789
 790 DECLARE_INTERFACE_(IRMAStatusMessage, IUnknown)
 791 {
 792     /*
 793      * IUnknown methods
 794      */
 795     STDMETHOD(QueryInterface)   (THIS_
 796                                 REFIID riid,
 797                                 void** ppvObj) PURE;
 798
 799     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 800
 801     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 802
 803     /*
 804      * IRMAStatusMessage methods
 805      */
 806
 807     STDMETHOD(SetStatus)                (THIS_ const char* pText) PURE;
 808 };
 809
 810
 811 #endif /* _RMAWIN_H_ */