IControlView.h

//========================================================================================
// 
// $File$
// 
// Owner: Frits Habermann
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IControlView__
#define __IControlView__

#include "PMTypes.h"
#include "widgetid.h"
#include "SystemUtils.h"
#include "PMRect.h"
#include "PMString.h"
#include "IControlViewDefs.h"

class IViewPort;
//class ITransform;
class PMRect;
class PMPolygon4;
//========================================================================================
// Types
//========================================================================================

typedef uint32 WidgetAttributeID;
typedef uint16 FrameBinding;

static const WidgetID kDefaultWidgetId = 0;

class INTERFACE_DECL IControlView : public IPMUnknown
{
public:
 /* Default IID to be used by UseDefaultIID() */
 enum { kDefaultIID = IID_ICONTROLVIEW };

 // -----------------------------------------------------------

 virtual void Init(const WidgetID& widgetId = kDefaultWidgetId,
 const PMRect& fFrame = kZeroRect,
 RsrcID rsrcID = 0) = 0;
 virtual void DoPostCreate() = 0;
 

 // -----------------------------------------------------------

 virtual RsrcID GetRsrcID() const = 0;

 virtual void SetRsrcID(const RsrcID &id) = 0;
 
 virtual PluginID GetRsrcPluginID() const = 0;

 virtual void SetRsrcPluginID(const PluginID &id) = 0;
 // Get and set the resources plugin id for the widget.
 virtual WidgetID GetWidgetID() const = 0;

 virtual void SetWidgetID(const WidgetID &id) = 0;

 virtual void SetClipToSelfEnabled(bool16 clipChildren) const = 0; 
 


 // -----------------------------------------------------------
 virtual void SetFrame(const PMRect& newFrame, bool16 invalidate = kTrue) = 0;

 virtual const PMRect& GetFrame() const = 0;
 
 virtual const PMRect GetLocalFrame() const = 0;

 virtual void Resize(const PMPoint& newDimensions, bool16 invalidate = kTrue) = 0;

 virtual void MoveTo(const PMPoint& where, bool16 invalidate = kTrue) = 0;

 virtual void SetFrameBinding(const FrameBinding& binding) = 0;

 virtual FrameBinding GetFrameBinding() const = 0;

 virtual void AdaptToParentsSize(const PMPoint& dimensions) = 0;

 virtual void AdaptToChildsGeometry(const PMPoint& delta, const FrameBinding& childsBinding, bool16 invalidate = kFalse) = 0;
 
 virtual PMPoint ConstrainDimensions(const PMPoint& dimensions) const = 0;
 
 virtual SysRgn GetDrawRegion() = 0;
 
 virtual bool16 DrawRegionEncompassesChildRegions() const = 0;

 virtual SysRect GetBBox() const = 0;

 virtual PMMatrix* GetContentToWindowTransform() const = 0;
 virtual void ContentToWindowTransform( PMPoint * point) const = 0;
 virtual void ContentToWindowTransform( PMRect * rect) const = 0;
 virtual void ContentToWindowTransform( PMPolygon4 * poly) const = 0;
 virtual void WindowToContentTransform( PMPoint * point) const = 0;
 virtual void WindowToContentTransform( PMRect * rect) const = 0;
 virtual void WindowToContentTransform( PMPolygon4 * poly) const = 0;
 virtual PMMatrix GetContentToWindowMatrix() const = 0;
 virtual PMMatrix GetWindowToContentMatrix() const = 0;
 virtual PMRect GetContentBounds_() const = 0;
 
 virtual void InvalidateTransform() = 0;
 
 virtual void DeleteDrawRegion() = 0;

 virtual int32 HitTest(const SysPoint& where) = 0;
 
 // Geometry methods replacing similar ones from IWindowPort that are no longer supported, as of CS6.
 //
 // Note the unlike IWindowPort, these methods don't require an acquired and/or focused viewport to work.
 //
 // Also note that IWindowPort converts between global and window coordinates, so the term "local" can be misleading.
 // That why here we have two versions of, GlobalToLocal (and vice versa) one converting to window coords and one converting to view
 // coords. To avoid confusion, neither of the new methods is named GlobalToLocal.
 // Where the "window" is defined by the object above us in the hierarchy containing an IWindow interface.
 
 virtual PMRect GlobalToView(const PMRect& convertRect) const = 0;
 virtual PMPoint GlobalToView(const PMPoint& convertPoint) const = 0;
 virtual PMRect GlobalToWindow(const PMRect& convertRect) const = 0;
 virtual PMPoint GlobalToWindow(const PMPoint& convertPoint) const = 0;

 virtual PMRect ViewToGlobal(const PMRect& convertRect) const = 0;
 virtual PMPoint ViewToGlobal(const PMPoint& convertPoint) const = 0;
 virtual PMRect WindowToGlobal(const PMRect& convertRect) const = 0;
 virtual PMPoint WindowToGlobal(const PMPoint& convertPoint) const = 0;
 

 // -----------------------------------------------------------

 virtual void Draw(IViewPort* viewPort, SysRgn updateRgn = nil) = 0;
 
 virtual void Invalidate(PMRect *invalidRect = nil) = 0;
 
 virtual void Validate(PMRect *invalidRect = nil) = 0;
 
 
 virtual void ForceRedraw(SysRgn invalidRgn = nil, bool16 forceRedraw = kTrue) = 0;

 virtual void Hilite(bool16 doHilite = kTrue) = 0;

 virtual void Unhilite() = 0;

 virtual bool16 IsHilited() const = 0;
 
 virtual bool16 IsRolledOver() const = 0;

 // -----------------------------------------------------------
 void ShowView(bool16 doShow = kTrue)
 {
 Show( doShow);
 }
 void HideView()
 {
 Hide();
 }

private:
 virtual void Show(bool16 doShow = kTrue) = 0;

 virtual void Hide() = 0;
public:

 virtual bool16 GetVisibleState() const = 0;
 // 
 virtual bool16 IsVisible(bool16 requireVisibleWindow = kFalse) const = 0;
 // 
 virtual void ParentsVisibleStateChanged(bool16 visible) = 0;
 // Called whenever the widget's parent's visible state changes.

 virtual void Enable(bool16 doEnable = kTrue, bool16 invalidate = kTrue) = 0;
 virtual void Disable(bool16 invalidate = kTrue) = 0;
 virtual bool16 GetEnableState() const = 0;
 
 virtual bool16 IsEnabled() const = 0;
 
 virtual void ParentsEnableStateChanged(bool16 visible, bool16 invalidate = kTrue) = 0;
 

 // -----------------------------------------------------------

 virtual void WindowActivated() = 0;
 virtual void WindowDeactivated() = 0;
 
 
 virtual void WindowShown() = 0;

 virtual void WindowHidden() = 0;
 
 virtual void WindowChanged() = 0;
 

 virtual void WindowClosed() = 0;
 

 
 // -----------------------------------------------------------
 virtual void ParentPurged() = 0;
 


 // -----------------------------------------------------------

 virtual void DoAutoAttach() = 0;

 virtual void DoAutoDetach() = 0; 

 // -----------------------------------------------------------

 
 virtual void SetRsrcID(const RsrcID &id,const bool isDarkIcon) = 0;
//
//public : 
// // 
// //@}
};

#endif