/* ***** BEGIN LICENSE BLOCK *****
 * Source last modified: $Id: vbasernd.h,v 1.3.24.3 2004/07/09 01:55:22 hubbe Exp $
 * 
 * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
 * 
 * The contents of this file, and the files included with this file,
 * are subject to the current version of the RealNetworks Public
 * Source License (the "RPSL") available at
 * http://www.helixcommunity.org/content/rpsl unless you have licensed
 * the file under the current version of the RealNetworks Community
 * Source License (the "RCSL") available at
 * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
 * will apply. You may also obtain the license terms directly from
 * RealNetworks.  You may not use this file except in compliance with
 * the RPSL or, if you have a valid RCSL with RealNetworks applicable
 * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
 * the rights, obligations and limitations governing use of the
 * contents of the file.
 * 
 * Alternatively, the contents of this file may be used under the
 * terms of the GNU General Public License Version 2 or later (the
 * "GPL") in which case the provisions of the GPL are applicable
 * instead of those above. If you wish to allow use of your version of
 * this file only under the terms of the GPL, and not to allow others
 * to use your version of this file under the terms of either the RPSL
 * or RCSL, indicate your decision by deleting the provisions above
 * and replace them with the notice and other provisions required by
 * the GPL. If you do not delete the provisions above, a recipient may
 * use your version of this file under the terms of any one of the
 * RPSL, the RCSL or the GPL.
 * 
 * This file is part of the Helix DNA Technology. RealNetworks is the
 * developer of the Original Code and owns the copyrights in the
 * portions it created.
 * 
 * This file, and the files included with this file, is distributed
 * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
 * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
 * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
 * ENJOYMENT OR NON-INFRINGEMENT.
 * 
 * Technology Compatibility Kit Test Suite(s) Location:
 *    http://www.helixcommunity.org/content/tck
 * 
 * Contributor(s):
 * 
 * ***** END LICENSE BLOCK ***** */

#ifndef _VBASERND_H
#define _VBASERND_H

#if defined(_UNIX) && (!(defined(_BEOS))) && (!(defined(_MAC_UNIX))) && (!(defined(_ARM)))
#include <X11/Xlib.h>
#endif

class CResourceLoader;

class CRNVisualBaseRenderer : public CRNBaseRenderer,
                              public IHXSiteUser
{
public:
    CRNVisualBaseRenderer();
    virtual ~CRNVisualBaseRenderer();

    // IUnknown methods
    STDMETHOD(QueryInterface)   (THIS_ REFIID riid, void** ppvObj);
    STDMETHOD_(ULONG32,AddRef)  (THIS);
    STDMETHOD_(ULONG32,Release) (THIS);

    // Need to override CRNBaseRenderer::InitPlugin()
    STDMETHOD(InitPlugin) (THIS_ IUnknown *pContext);

    // Need to override IHXRenderer::StartStream() to setup MISUS info
    STDMETHOD(StartStream) (THIS_ IHXStream* pStream, IHXPlayer* pPlayer);

    // IHXSiteUser methods
    STDMETHOD(AttachSite)               (THIS_ IHXSite *pSite);
    STDMETHOD(DetachSite)               (THIS);
    STDMETHOD(HandleEvent)              (THIS_ HXxEvent *pEvent);
    STDMETHOD_(BOOL,NeedsWindowedSites) (THIS);
protected:
    HXxSize                            m_cWindowSize;
    IHXMultiInstanceSiteUserSupplier* m_pMISUS;
    IHXSite*                          m_pSite;
    IHXStatusMessage*                 m_pStatusMessage;
    INT16                              m_sOldMouseX;
    INT16                              m_sOldMouseY;
    BOOL                               m_bSetHyperlinkCursor;
    BOOL                               m_bStatusMsgWillNeedErasing;
#if defined(_WINDOWS)
    HCURSOR                            m_hPreHyperlinkCursor;
    HCURSOR                            m_hHyperlinkCursor;
#elif defined(_MACINTOSH) || defined(_MAC_UNIX)
    CursHandle                         m_hHyperlinkCursor;
    typedef enum
    {
        CURSOR_ARROW,
        CURSOR_HYPERLINK
    }
    CursorShapes;
    CursorShapes                       m_eCurrentCursor;
    CResourceLoader*		       m_pResourceLoader;
#elif defined(_UNIX) && (!(defined(_BEOS))) && !defined(_ARM)
    Cursor                              m_hHyperlinkCursor;
    Cursor                              m_hCurrentCursor;
    Display*                            m_pDisplay;          
    Window                              m_Window;
#endif

    // Method to handle mouseover and status message changes
    STDMETHOD(OnMouseMove)              (THIS_ INT16 fwKeys, INT16 xPos, INT16 yPos);

    // Required derived methods
    STDMETHOD(GetWindowSize)            (THIS_ REF(HXxSize) rSize)                                            PURE;
    STDMETHOD(IsMouseOverActiveLink)    (THIS_ INT16 x, INT16 y, REF(BOOL) rbActive, REF(IHXBuffer*) rpLink) PURE;
    STDMETHOD(RMASurfaceUpdate)         (THIS_ IHXVideoSurface* pSurface)                                    PURE;

    
    STDMETHOD(HandleClick)              (THIS_ INT16 x, INT16 y)                                              PURE;
    
    virtual BOOL _IsValidRendererSurface();
    virtual HX_RESULT RMASurfaceUpdate2( IHXSubRectVideoSurface* pSurface,
                                         HXxRect*                 pExtents,
                                         HXxBoxRegion*              pDirtyRegion );
    virtual void _AttachSite();
};

#endif

