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

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: progsink.h,v 1.3.36.3 2004/07/09 01:45:13 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 _PROGSINK_H_
  50. #define _PROGSINK_H_
  51. /*
  52.  * Forward declarations of some interfaces defined here-in.
  53.  */
  54. typedef _INTERFACE IUnknown IUnknown;
  55. typedef _INTERFACE IHXProgressSink IHXProgressSink;
  56. typedef _INTERFACE IHXProgressSinkControl      IHXProgressSinkControl;
  57.  
  58. /****************************************************************************
  59.  * 
  60.  *  Interface:
  61.  *
  62.  *  IHXProgressSink
  63.  *
  64.  *  Purpose:
  65.  *
  66.  *  Supports callback notification about a job's progress
  67.  *
  68.  *  IHXProgressSink
  69.  *
  70.  *  {6F8C5FB0-C1D3-11d2-871B-00C0F031C266}
  71.  *
  72.  */
  73. DEFINE_GUID(IID_IHXProgressSink, 
  74.     0x6f8c5fb0, 0xc1d3, 0x11d2, 0x87, 0x1b, 0x0, 0xc0, 0xf0, 0x31, 0xc2, 0x66);
  75. #undef  INTERFACE
  76. #define INTERFACE   IHXProgressSink
  77. DECLARE_INTERFACE_(IHXProgressSink, IUnknown)
  78. {
  79.     /************************************************************************
  80.      * IUnknown methods
  81.      */
  82.     STDMETHOD(QueryInterface) (THIS_
  83. REFIID riid,
  84. void** ppvObj) PURE;
  85.     STDMETHOD_(UINT32,AddRef) (THIS) PURE;
  86.     STDMETHOD_(UINT32,Release) (THIS) PURE;
  87.     /************************************************************************
  88.      * IHXProgressSink methods
  89.      */
  90.    
  91.     /************************************************************************
  92.      * Method:
  93.      *     IHXProgressSink::SetProgress
  94.      * Purpose:
  95.      *     Set the percent complete.
  96.      * Parameters:
  97.      *     ulPercentComplete - [in] Percent of the merge that is complete.
  98.      */
  99.     STDMETHOD(SetProgress)     (THIS_ UINT32 ulPercentComplete) PURE;
  100.     /************************************************************************
  101.      * Method:
  102.      *     IHXProgressSink::NotifyStart
  103.      * Purpose:
  104.      *     Notification that the job is starting.
  105.      */
  106.     STDMETHOD(NotifyStart)     (THIS) PURE;
  107.     /************************************************************************
  108.      * Method:
  109.      *     IHXProgressSink::NotifyFinish
  110.      * Purpose:
  111.      *     Notification that the job is complete.
  112.      */
  113.     STDMETHOD(NotifyFinish)     (THIS) PURE;
  114. };
  115. /****************************************************************************
  116.  * 
  117.  *  Interface:
  118.  *
  119.  *  IHXProgressSinkControl
  120.  *
  121.  *  Purpose:
  122.  *
  123.  *  Used to register progress callbacks
  124.  *
  125.  *  IHXProgressSinkControl
  126.  *
  127.  *  {DC464800-C1D3-11d2-871B-00C0F031C266}
  128.  *
  129.  */
  130. DEFINE_GUID(IID_IHXProgressSinkControl, 
  131.     0xdc464800, 0xc1d3, 0x11d2, 0x87, 0x1b, 0x0, 0xc0, 0xf0, 0x31, 0xc2, 0x66);
  132. #undef  INTERFACE
  133. #define INTERFACE   IHXProgressSinkControl
  134. DECLARE_INTERFACE_(IHXProgressSinkControl, IUnknown)
  135. {
  136.     /************************************************************************
  137.      * IUnknown methods
  138.      */
  139.     STDMETHOD(QueryInterface) (THIS_
  140. REFIID riid,
  141. void** ppvObj) PURE;
  142.     STDMETHOD_(UINT32,AddRef) (THIS) PURE;
  143.     STDMETHOD_(UINT32,Release) (THIS) PURE;
  144.     /************************************************************************
  145.      * IHXProgressSinkControl methods
  146.      */
  147.     /* Type of progress sink */
  148.     enum SINK_TYPE
  149.     {
  150.         FILE_MERGE_PROGRESS = 0
  151.     };
  152.    
  153.     /************************************************************************
  154.      * Method:
  155.      *     IHXProgressSinkControl::AddSink
  156.      * Purpose:
  157.      *     Adds sink.
  158.      * Parameters:
  159.      *      nSinkType - [in] Type of progress sink 
  160.      *     pObj - [in] Object that supports the IHXProgressSink interface.
  161.      */
  162.     STDMETHOD(AddSink)     (THIS_ SINK_TYPE nSinkType, IHXProgressSink* pObj) PURE;
  163.     /************************************************************************
  164.      * Method:
  165.      *     IHXProgressSinkControl::RemoveSink
  166.      * Purpose:
  167.      *     Removes sink.
  168.      * Parameters:
  169.      *      nSinkType - [in] Type of progress sink 
  170.      *     pObj - [in] Object that supports the IHXProgressSink interface.
  171.      */
  172.     STDMETHOD(RemoveSink)     (THIS_ SINK_TYPE nSinkType, IHXProgressSink* pObj) PURE;
  173. };
  174. #endif //_PROGSINK_H_