include/realmedia/rmasite2.h

   1 /****************************************************************************
   2  *
   3  *  $Id: rmasite2.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 _RMASITE2_H_
  19 #define _RMASITE2_H_
  20
  21 /*
  22  * Forward declarations of some interfaces defined or used here-in.
  23  */
  24
  25 //typedef _INTERFACE  IRMASite2                     IRMASite2;
  26 typedef _INTERFACE  IRMAVideoSurface                IRMAVideoSurface;
  27 typedef _INTERFACE  IRMAPassiveSiteWatcher          IRMAPassiveSiteWatcher;
  28
  29 /****************************************************************************
  30  *
  31  *  Interface:
  32  *
  33  *      IRMASite2
  34  *
  35  *  Purpose:
  36  *
  37  *      Interface for IRMASite2 objects.
  38  *
  39  *  IID_IRMASite:
  40  *
  41  *      {0x00000D0A-0901-11d1-8B06-00A024406D59}
  42  *
  43  */
  44 DEFINE_GUID(IID_IRMASite2, 0x00000D0A, 0x901, 0x11d1, 0x8b, 0x6, 0x0,
  45                         0xa0, 0x24, 0x40, 0x6d, 0x59);
  46
  47 #undef  INTERFACE
  48 #define INTERFACE   IRMASite
  49
  50 DECLARE_INTERFACE_(IRMASite2, IUnknown)
  51 {
  52     /*
  53      * IUnknown methods
  54      */
  55     STDMETHOD(QueryInterface)   (THIS_
  56                                 REFIID riid,
  57                                 void** ppvObj) PURE;
  58
  59     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
  60
  61     STDMETHOD_(ULONG,Release)   (THIS) PURE;
  62
  63     /*
  64      * IRMASite2 method usually called by the "context"
  65      * when window attributes (like the window handle) have changed.
  66      */
  67     STDMETHOD(UpdateSiteWindow) (THIS_
  68                                 PNxWindow* /*IN*/ pWindow) PURE;
  69
  70     /*
  71      * IRMASite2 method usually called by the "context" to
  72      * to hide/show a site.
  73      */
  74     STDMETHOD(ShowSite)         (THIS_
  75                                  BOOL    bShow) PURE;
  76
  77     STDMETHOD_(BOOL, IsSiteVisible)         (THIS) PURE;
  78
  79     /*
  80      * IRMASite2 method usually called by the "context" to
  81      * set the site's Z-order
  82      */
  83     STDMETHOD(SetZOrder)        (THIS_
  84                                 INT32 lZOrder
  85                                 ) PURE;
  86
  87     /*
  88      * IRMASite2 method called to get the site's Z-order
  89      */
  90     STDMETHOD(GetZOrder)        (THIS_
  91                                 REF(INT32) lZOrder
  92                                 ) PURE;
  93
  94     /*
  95      * IRMASite2 method called to set the site at the top
  96      * of the Z-order
  97      */
  98     STDMETHOD(MoveSiteToTop)    (THIS) PURE;
  99
 100     /*
 101      * IRMASite2 method called to get the site's video surface
 102      */
 103     STDMETHOD(GetVideoSurface)  (THIS_
 104                                 REF(IRMAVideoSurface*) pSurface
 105                                 ) PURE;
 106
 107     /*
 108      * IRMASite2 method called to get the number of child sites.
 109      */
 110     STDMETHOD_(UINT32,GetNumberOfChildSites) (THIS) PURE;
 111
 112     /*
 113      * IRMASite2 method to add a watcher that does not affect the site
 114      */
 115     STDMETHOD(AddPassiveSiteWatcher)    (THIS_
 116                                         IRMAPassiveSiteWatcher* pWatcher
 117                                         ) PURE;
 118
 119     /*
 120      * IRMASite2 method to remove a watcher that does not affect the site
 121      */
 122     STDMETHOD(RemovePassiveSiteWatcher) (THIS_
 123                                         IRMAPassiveSiteWatcher* pWatcher
 124                                         ) PURE;
 125
 126     /*
 127      * IRMASite2 method used to do cursor management
 128      */
 129     STDMETHOD(SetCursor)                (THIS_
 130                                         PNxCursor ulCursor,
 131                                         REF(PNxCursor) ulOldCursor
 132                                         ) PURE;
 133 };
 134
 135 /****************************************************************************
 136  *
 137  *  Interface:
 138  *
 139  *      IRMAPassiveSiteWatcher
 140  *
 141  *  Purpose:
 142  *
 143  *      Interface for IRMAPassiveSiteWatcher objects.
 144  *
 145  *  IID_IRMAPassiveSiteWatcher:
 146  *
 147  *      {0x00000D0F-0901-11d1-8B06-00A024406D59}
 148  *
 149  */
 150 DEFINE_GUID(IID_IRMAPassiveSiteWatcher, 0x00000D0F, 0x901, 0x11d1, 0x8b, 0x6,
 151                         0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
 152
 153 #undef  INTERFACE
 154 #define INTERFACE   IRMAPassiveSiteWatcher
 155
 156 DECLARE_INTERFACE_(IRMAPassiveSiteWatcher, IUnknown)
 157 {
 158     /*
 159      * IUnknown methods
 160      */
 161     STDMETHOD(QueryInterface)   (THIS_
 162                                 REFIID riid,
 163                                 void** ppvObj) PURE;
 164
 165     STDMETHOD_(ULONG,AddRef)    (THIS) PURE;
 166
 167     STDMETHOD_(ULONG,Release)   (THIS) PURE;
 168
 169     /*
 170      * IRMAPassiveSiteWatcher method used to notify
 171      * about position updates
 172      */
 173     STDMETHOD(PositionChanged) (THIS_
 174                                 PNxPoint* /*IN*/ pPoint) PURE;
 175
 176     /*
 177      * IRMAPassiveSiteWatcher method used to notify
 178      * about size updates
 179      */
 180     STDMETHOD(SizeChanged)      (THIS_
 181                                 PNxSize* /*IN*/ pSize) PURE;
 182
 183 };
 184
 185 #endif //_RMASITE2_H_