DVHostedWidgetView.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2008 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and may be covered by U.S. and Foreign Patents,
// patents in process, and are protected by trade secret or copyright law.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
//========================================================================================

#ifndef __DVHostedWidgetView__
#define __DVHostedWidgetView__

#include "AbstractControlView.h"

#include "DVAForwardDeclarations.h"

#ifdef DV_WIDGET_BUILD
#endif

class DV_ DVHostedWidgetView : public AbstractControlView
{

 typedef AbstractControlView inherited;

public:

 DVHostedWidgetView(IPMUnknown *boss); 
 virtual ~DVHostedWidgetView();

 virtual void DoPostCreate();
 virtual void ReadWrite(IPMStream *s, ImplementationID prop);

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

 virtual const PMRect& GetFrame() const;

 virtual const PMRect GetLocalFrame() const;

 virtual PMRect GetInnerContentFrame() const;

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

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

 virtual void SetFrameBinding(const FrameBinding& binding);
 virtual FrameBinding GetFrameBinding() const;

 virtual void AdaptToParentsSize(const PMPoint& dimensions);

 virtual void AdaptToChildsGeometry(const PMPoint& delta, const FrameBinding& childsBinding, bool16 invalidate = kFalse);

 virtual SysRgn GetDrawRegion();

 virtual bool16 DrawRegionEncompassesChildRegions() const;

 virtual void DeleteDrawRegion();
 
 virtual int32 HitTest(const SysPoint& where);

 virtual void Draw(IViewPort* viewPort, SysRgn updateRgn);
 
 virtual void DV_Draw(dvaui::drawbot::Drawbot* drawbotP) const {};

 virtual void ForceRedraw(SysRgn invalidRgn, bool16 forceRedraw);

 virtual void Invalidate(PMRect *bbox = nil);

 virtual void Validate(PMRect *bbox = nil);

 virtual void Hilite(bool16 doHilite = kTrue);

 virtual void Unhilite();

 virtual bool16 IsHilited() const;

 virtual bool16 IsRolledOver() const;

 virtual void Show(bool16 doShow);
 
 virtual void Hide();

 virtual bool16 GetVisibleState() const;

 virtual bool16 IsVisible(bool16 requireVisibleWindow = kFalse) const;

 virtual void Enable(bool16 doEnable, bool16 invalidate);

 virtual void Disable(bool16 invalidate);

 virtual bool16 GetEnableState() const;

 virtual bool16 IsEnabled() const;
 
 virtual void ParentsEnableStateChanged(bool16 enable, bool16 invalidate);

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

 virtual void DoAutoDetach();
 
 // GlobalToLocal(window or view) transformations (replaces similar methods in IWindowPort)
 virtual PMRect GlobalToView(const PMRect& convertRect) const;
 virtual PMPoint GlobalToView(const PMPoint& convertPoint) const;
 virtual PMRect GlobalToWindow(const PMRect& convertRect) const;
 virtual PMPoint GlobalToWindow(const PMPoint& convertPoint) const;

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

 virtual void SetClipToSelfEnabled(bool16 clipChildren) const; 

protected:
 virtual void SetVisibleState(bool16 isVisible = kTrue);
 virtual void SetEnableState(bool16 isVisible = kTrue);
 
 virtual bool16 AncestorsAreVisible(bool16 requireVisibleWindow) const;

 virtual PMMatrix* GetUpdatedContentToWindowTransform();

 virtual void CreateDrawRegion(SysRgn& drawRgn);

 virtual bool16 IsAutoAttached() const;
 virtual void SetIsAutoAttached(bool16 flag = kTrue);
 
 void Set_UI_Node(dvaui::ui::UI_Node* node);
 dvaui::ui::UI_Node* Get_UI_Node() const;

 void Release_UI_Node();

 virtual void BoundsChangedCallback();
 virtual void ParentEnableStateChangedCallback();

 virtual void ResizeChildren(const PMPoint& delta, bool16 invalidate);
 virtual void AdaptLayoutToFrameBindings(const PMPoint& delta, bool16 invalidate = kTrue);
 
 virtual void DoAfterKeyfocusChangedCallback() {}
 unsigned int fGeometryBusy : 1;
 class AcquireGeometry;

private:
 /* If this view can display multiple tips while moving on the same widget, depending on the context.
 Then following function should be called after setting the UI_Node in the view.
 Normally, drover asks for new tool tip when the ui_node/widget under the mouse point changes.
 In Indesign we have some widgets which are bigger controls that contain multiple sub-items which 
 are individual drawable entities but under the same widget.
 So, to enable that drover asks tool tip text for these kind of controls on a bit frequent basis,
 clients need to call this function to enable it.
 For example, layout view is a single view for drover and it asks for new tool tip text only on ui node changes
 changes. So we call this function from DVLayoutControlView constructor.
 This function is also used for grid of glyphs in bullets and numbering and glyphs panel
 */
 void UpdateToolTipOnMouseMove(); 

 void CommonInit();

 void ConnectCursorProviderToRegion(); 

 // Non-persistent data
 bool16 fAutoAttached;
 bool16 fHilited;
 mutable SysRgn fDrawRegion;

 // Private implementation class
 class PrivateImpl;
 PrivateImpl* Impl() const {return fImpl;}
 PrivateImpl* fImpl;

public:

 bool16 IsWidgetConstructionFinished() const;
 void WidgetConstructionFinished(const bool16 bFlag);

 void MarkDisabledByNonSuppressedUIIfRequired(const bool16 bFlag);

 void MarkHiddenByNonSuppressedUIIfRequired(const bool16 bFlag);

 bool16 IsDisabledBySuppressedUI() const;
 void DisableBySuppressedUI(const bool16 bFlag);

 bool16 IsHiddenBySuppressedUI() const;
 void HideBySuppressedUI(const bool16 bFlag); 

private:

 bool16 IsEnableOrDisableFuncCalledFromSuppressedUI() const;
 void EnableOrDisableFuncCalledFromSuppressedUI(const bool16 bFlag);

 bool16 IsDisabledByNonSuppressedUI() const;
 void DisableByNonSuppressedUI(const bool16 bFlag);

 bool16 IsMarkedDisabled();

 bool16 IsShowOrHideFuncCalledFromSuppressedUI() const;
 void ShowOrHideFuncCalledFromSuppressedUI(const bool16 bFlag);

 bool16 IsHiddenByNonSuppressedUI() const;
 void HideByNonSuppressedUI(const bool16 bFlag);

 bool16 IsMarkedHidden();
};

//========================================================================================
// DVHostedWidgetView::AcquireGeometry
//========================================================================================
class DVHostedWidgetView::AcquireGeometry
{
public:
 AcquireGeometry(DVHostedWidgetView* view);
 ~AcquireGeometry();
private:
 DVHostedWidgetView* fView;
};

inline DVHostedWidgetView::AcquireGeometry::AcquireGeometry(DVHostedWidgetView* view) 
 :
 fView(view)
{ 
 ASSERT_MSG(fView->fGeometryBusy == 0,"AcquireGeometry - fGeometryBusy is already set, and it's a 1 bit bitfield. Not good.");
 fView->fGeometryBusy++;
}

inline DVHostedWidgetView::AcquireGeometry::~AcquireGeometry()
{
 ASSERT_MSG(fView->fGeometryBusy == 1,"~AcquireGeometry - fGeometryBusy is already unset, and it's a 1 bit bitfield. Not good.");
 fView->fGeometryBusy--;
}


#endif