hxinter.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:8k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef HXINTER_H
  36. #define HXINTER_H
  37. /*
  38.  * Forward declarations of some interfaces defined here
  39.  */
  40. typedef _INTERFACE IHXEventManager IHXEventManager;
  41. typedef _INTERFACE IHXEventSink    IHXEventSink;
  42. /*
  43.  * Forward declarations of interfaces used here
  44.  */
  45. typedef _INTERFACE IHXValues       IHXValues;
  46. typedef _INTERFACE IHXBuffer       IHXBuffer;
  47. /*
  48.  * Definitions of filter rule key strings
  49.  */
  50. #define FILTER_RULE_KEY_URL       "url"
  51. #define FILTER_RULE_KEY_FRAGMENT  "fragment"
  52. #define FILTER_RULE_KEY_EVENTNAME "eventName"
  53. /****************************************************************************
  54.  * 
  55.  *  Interface:
  56.  *
  57.  *      IHXEventManager
  58.  *
  59.  *  Purpose:
  60.  *
  61.  *      Interface to manage inter-datatype events
  62.  *
  63.  *  IID_IHXEventManager:
  64.  *
  65.  *      {F932B582-0517-4ca4-844C-26A4E8E96983}
  66.  *
  67.  */
  68. DEFINE_GUID(IID_IHXEventManager, 0xf932b582, 0x517, 0x4ca4, 0x84, 0x4c,
  69.             0x26, 0xa4, 0xe8, 0xe9, 0x69, 0x83);
  70. #undef  INTERFACE
  71. #define INTERFACE IHXEventManager
  72. DECLARE_INTERFACE_(IHXEventManager, IUnknown)
  73. {
  74.     /*
  75.      * IUnknown methods
  76.      */
  77.     STDMETHOD(QueryInterface)   (THIS_ REFIID riid, void** ppvObj) PURE;
  78.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  79.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  80.     /*
  81.      * IHXEventManager methods
  82.      */
  83.     /************************************************************************
  84.      *  Method:
  85.      *      IHXEventManager::AddEventSink
  86.      *  Purpose:
  87.      *      Register an event sink
  88.      */
  89.     STDMETHOD(AddEventSink) (THIS_ IHXEventSink* pSink) PURE;
  90.     /************************************************************************
  91.      *  Method:
  92.      *      IHXEventManager::RemoveEventSink
  93.      *  Purpose:
  94.      *      Unregister an event sink
  95.      */
  96.     STDMETHOD(RemoveEventSink) (THIS_ IHXEventSink* pSink) PURE;
  97.     /************************************************************************
  98.      *  Method:
  99.      *      IHXEventManager::AddEventSinkFilterRule
  100.      *  Purpose:
  101.      *      Adds a rule to the event filter.
  102.      *
  103.      *      Filter rules are IHXValues with the following
  104.      *      well-known CString properties:
  105.      *
  106.      *      "url"       - URL generating the event
  107.      *      "fragment"  - object in the URL generating the event
  108.      *      "eventName" - name of event
  109.      *
  110.      *      The filter rule is an implicit AND across the
  111.      *      *specified* parameters of the rule. There is an implicit
  112.      *      OR between different calls to AddEventSinkFilterRule(). For
  113.      *      example, if a sink make two calls to AddEventSinkFilterRule()
  114.      *      with the following two IHXValues:
  115.      *
  116.      *      { "url"       = "rtsp://www.foo.com/bar.svg",
  117.      *        "fragment"  = "my_circle" }
  118.      *
  119.      *      { "eventName" = "ev:change_ads" }
  120.      *
  121.      *      Then this filter would pass:
  122.      *      a) ANY events from the "my_circle" object
  123.      *         in "rtsp://www.foo.com/bar.svg"; OR
  124.      *      b) The "ev:change_ads" event from ANY fragment in ANY URL.
  125.      *
  126.      */
  127.     STDMETHOD(AddEventSinkFilterRule) (THIS_ IHXEventSink* pSink,
  128.                                              IHXValues*    pRule) PURE;
  129.     /************************************************************************
  130.      *  Method:
  131.      *      IHXEventManager::RemoveEventSinkFilterRule
  132.      *  Purpose:
  133.      *      Removes a rule to the event filter. See the Purpose of
  134.      *      AddEventSinkFilterRule() for a description of the rule logic.
  135.      *      Note that the rule is removed based on the *content* of the
  136.      *      IHXValues, and not on the pointer value itself.
  137.      */
  138.     STDMETHOD(RemoveEventSinkFilterRule) (THIS_ IHXEventSink* pSink,
  139.                                                 IHXValues*    pRule) PURE;
  140.     /************************************************************************
  141.      *  Method:
  142.      *      IHXEventManager::FireEvent
  143.      *  Purpose:
  144.      *      Send an event to the manager
  145.      *
  146.      *      pURLStr       - URL of the event source (required, error if NULL)
  147.      *      pFragmentStr  - "object" within source that fired event (optional)
  148.      *      pEventNameStr - event name (required, error if NULL) 
  149.      *      pOtherValues  - properties associated with this event (optional)
  150.      */
  151.      STDMETHOD(FireEvent) (THIS_ IHXBuffer* pURLStr,
  152.                                  IHXBuffer* pFragmentStr,
  153.                                  IHXBuffer* pEventNameStr,
  154.                                  IHXValues* pOtherValues) PURE;
  155. };
  156. /****************************************************************************
  157.  * 
  158.  *  Interface:
  159.  *
  160.  *      IHXEventSink
  161.  *
  162.  *  Purpose:
  163.  *
  164.  *      Interface to receive events
  165.  *
  166.  *  IID_IHXEventSink
  167.  *
  168.  *      {76CF54BC-9FCE-45e7-90D1-034605F8DD14}
  169.  */
  170. DEFINE_GUID(IID_IHXEventSink, 0x76cf54bc, 0x9fce, 0x45e7, 0x90, 0xd1,
  171.             0x3, 0x46, 0x5, 0xf8, 0xdd, 0x14);
  172. #undef  INTERFACE
  173. #define INTERFACE IHXEventSink
  174. DECLARE_INTERFACE_(IHXEventSink, IUnknown)
  175. {
  176.     /*
  177.      * IUnknown methods
  178.      */
  179.     STDMETHOD(QueryInterface)   (THIS_ REFIID riid, void** ppvObj) PURE;
  180.     STDMETHOD_(ULONG32,AddRef)  (THIS) PURE;
  181.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  182.     /*
  183.      * IHXEventSink methods
  184.      */
  185.     /************************************************************************
  186.      *  Method:
  187.      *      IHXEventSink::EventFired
  188.      *  Purpose:
  189.      *      Fire an event that the sink has requested
  190.      *
  191.      *      pURLStr       - URL of the event source
  192.      *      pFragmentStr  - "object" within source that fired event
  193.      *      pEventNameStr - event name
  194.      *      pOtherValues  - properties associated with this event
  195.      */
  196.     STDMETHOD(EventFired) (THIS_ IHXBuffer* pURLStr,
  197.                                  IHXBuffer* pFragmentStr,
  198.                                  IHXBuffer* pEventNameStr,
  199.                                  IHXValues* pOtherValues) PURE;
  200. };
  201. #endif /* #ifndef HXINTER_H */