hxinter.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:8k
源码类别:

Symbian

开发平台:

Visual C++

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