IWidgetUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $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.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef __IWidgetUtils__
#define __IWidgetUtils__

#include "widgetid.h"
#include "IPMUnknown.h"
#include "PMPoint.h"
#include "PMRect.h"
#include "InterfaceFontInfo.h"
#include "IEvent.h"
#include "Utils.h"
#include "IInterfaceColors.h"
#include "IDResourceShell.h"

class IControlView;
class IDialog;
class IDVPlatformOffscreen;
class IEventHandler;
class IGraphicsContext;
class IGraphicsPort;
class IPanelControlData;
class IPMFont;
class IUIColorSpec;
class IEventHandler;
class IKeyFocusHandler;
class IWindow;

#ifdef WASM
#include "WasmDrawbot.h"
#else
#include "DVAForwardDeclarations.h"
#endif

class RoundedRectAppearance
{
public: 
 RoundedRectAppearance (const IControlView* controlView, PMReal radius, PMReal lineWidth, RealAGMColor strokeColor, 
 RealAGMColor fillColor, bool16 isRolledOverButton, RealAGMColor upperStrokeColor, 
 RealAGMColor lowerStrokeColor, PMReal inset = 1.0, bool16 isMoveReqd = kTrue) :
 fControlView(controlView),
 fRadius(radius),
 fLineWidth(lineWidth),
 fStrokeColor(strokeColor),
 fFillColor(fillColor),
 fIsRolledOverButton(isRolledOverButton),
 fUpperStrokeColor(upperStrokeColor),
 fLowerStrokeColor(lowerStrokeColor),
 fInset(inset),
 fIsMoveReqd(isMoveReqd)
 {
 ASSERT(controlView);
 }

 RoundedRectAppearance (const IControlView* controlView, PMReal radius, PMReal lineWidth, int32 strokeColorIndex, 
 int32 fillColorIndex, bool16 isRolledOverButton, int32 upperStrokeColorIndex, 
 int32 lowerStrokeColorIndex, PMReal inset = 1.0, bool16 isMoveReqd = kTrue) :
 fControlView(controlView),
 fRadius(radius),
 fLineWidth(lineWidth),
 fIsRolledOverButton(isRolledOverButton),
 fInset(inset),
 fIsMoveReqd(isMoveReqd)
 {
 ASSERT(controlView);

 RealAGMColor color;

 InterfacePtr<IInterfaceColors> colors(GetExecutionContextSession(), UseDefaultIID());

 colors->GetRealAGMColor(strokeColorIndex, fStrokeColor);
 colors->GetRealAGMColor(fillColorIndex, fFillColor);
 colors->GetRealAGMColor(lowerStrokeColorIndex, fLowerStrokeColor);
 colors->GetRealAGMColor(upperStrokeColorIndex, fUpperStrokeColor);
 }

 const IControlView* fControlView;
 PMReal fInset;
 PMReal fRadius;
 PMReal fLineWidth;
 RealAGMColor fStrokeColor;
 RealAGMColor fFillColor;
 bool16 fIsRolledOverButton;
 RealAGMColor fUpperStrokeColor;
 RealAGMColor fLowerStrokeColor;
 bool16 fIsMoveReqd;
};

typedef enum {
 kCanDraw,
 kCanDrawLocaleText,
 kCannotDraw,
 kDrawWithStandardFont
} DrawStatus;

class IWidgetUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IWIDGETUTILS };
 virtual SysPoint ConvertPointToLocalWindow(const PMPoint& mouseLocationInParentWindowCoords, IControlView* destinationView) = 0;

 virtual IPMUnknown* QueryRelatedWidget(const IPMUnknown* widget, const WidgetID& widgetId, const PMIID& iid) = 0;

 virtual const InterfaceFontInfo GetAppropriateFontForWidget(const IControlView* widget) = 0;

 virtual const IUIColorSpec* QueryColorSpecForWidget(const IPMUnknown* widget) = 0;
 
 virtual void GrayOutFrameContents (IGraphicsPort *gc, PMRect frame, PMReal transparency) = 0;

 virtual void DrawPaletteFill(const IControlView* widget, dvaui::drawbot::Drawbot * pDrawbot, const PMRect *rectToFill = nil) = 0;

 virtual void DrawPaletteFill (const IControlView* widget,IGraphicsPort * port, const PMRect* rectToFill = nil) = 0;

 // moved from GridPanelUtils.h
 virtual void GridPanel_PositionWidgets(IPanelControlData* panel, int32 first, int32 last) = 0;
 
 virtual void DeleteWidgetAndChildren(IControlView* widgetToDelete) = 0;

 virtual void StripUserDecimal(PMString* string) = 0;
 
 virtual void FormatUserDecimal(PMString* string) = 0;

 virtual void StripAccelerators(PMString &rawString) = 0;

 virtual void GetFormattedString(const PMReal& value, const bool16& bHorizontal, PMString& outString) = 0;

 virtual void GetFormattedScalingString(const PMReal& value, PMString& outString, const bool16 bFormatWithParens) = 0;
 
#ifdef MACINTOSH
 virtual void BringFinderToFront(void) = 0;
 virtual void SynchDocumentProxyIcons(bool16 forceValidation = kFalse) = 0;
#endif

 virtual PMReal GetViewYPosition(IGraphicsContext* gc, const InterfaceFontInfo &fontInfo, const PMReal &height) = 0;

 virtual void SimulateClick(IEventHandler* targetEH) = 0;

 virtual void CombineRegions(IControlView* widget, SysWireframe& theRgn) const = 0;

 virtual void DrawFocusRect(IControlView* view, const PMRect& r, bool16 flushDrawing) = 0;

#define kDefaultHiliteThickness 2.0
 virtual bool16 DrawHiliteRect(IControlView* view, const PMRect& r, bool16 flushDrawing = kTrue, PMReal hiliteThickness = kDefaultHiliteThickness) = 0;
 
 virtual bool16 DrawHilitePath(IControlView* view, const PMPointList& pts, bool16 flushDrawing = kTrue, PMReal hiliteThickness = kDefaultHiliteThickness) = 0;

 virtual bool16 DrawHilitePath(IControlView* view, const PMPointListCollection& subPaths, bool16 flushDrawing = kTrue, PMReal hiliteThickness = kDefaultHiliteThickness) = 0;
 
 virtual bool16 DrawHilitePath(IControlView* view, SysWireframe hilitePath, bool16 flushDrawing = kTrue, PMReal hiliteThickness = kDefaultHiliteThickness) = 0;
 
 virtual bool16 FillHiliteRect(IControlView* view, const PMRect& r, bool16 flushDrawing = kTrue) = 0;
 
 virtual bool16 FillHilitePath(IControlView* view, const PMPointListCollection& subPaths, bool16 flushDrawing = kTrue) = 0;


 virtual void SetTextHighlightColor(IGraphicsPort *gPort, const IControlView *view) = 0;
 
 virtual bool16 IsWidgetInPalette(const IControlView* iWidget) = 0;

 virtual bool16 CopyBitsToView(IControlView* view, const Int32Rect& dstBounds, IDVPlatformOffscreen* srcOffscreen, const Int32Rect& srcBounds,
 const PMMatrix& clip2destMatrix = PMMatrix(), const SysRgn clipRgn = nil) = 0;

 virtual PMReal GetViewScaleFactorReal(const IControlView* view) = 0; 

 virtual void DrawRoundedRect(dvaui::drawbot::Drawbot *drawBotP, const RoundedRectAppearance& roundedRectAppearance) = 0;

 virtual void DrawLeftRoundedRect(dvaui::drawbot::Drawbot *drawBotP, const RoundedRectAppearance& roundedRectAppearance) = 0;

 virtual void DrawRightRoundedRect(dvaui::drawbot::Drawbot *drawBotP, const RoundedRectAppearance& roundedRectAppearance) = 0;

 virtual bool16 IsClusterControllableChildWidget(IControlView* widget, bool16& isSelected, bool16 checkParentToBeCluster = kFalse) = 0;

 virtual IPMUnknown* QueryDescendentWidgetOfType(IPMUnknown* widget, PMIID interfaceID) = 0;

 virtual IDialog* CreateContextUI(const RsrcSpec& rSpec,
 const PMRect& globalAnchorRect,
 const ClassID& popupWindowClass = kPopupWindowBoss,
 bool16 preferredtoBeDrawnOnLeft = kFalse,
 bool16 invokedFromPalette = kFalse,
 bool16 okToCacheDialog = kFalse,
 bool16 openImmediately = kTrue) = 0;

 virtual IDialog* CreateContextUI_Generic(const RsrcSpec& rSpec, const PMRect& globalAnchorRect, const ClassID& popupWindowClass = kPopupWindowBoss,
 bool16 preferredtoBeDrawnOnLeft = kFalse, bool16 invokedFromPalette = kFalse, bool16 okToCacheDialog = kFalse, bool16 openImmediately = kTrue) = 0;

 virtual void RepositionAndShowContextUIPopup(IWindow* popupWindow,
 bool16 showWindow = kTrue,
 const PMRect& globalAnchorRect = kZeroRect,
 bool16 inFront = kTrue) = 0;

 /*
 Gets the effective icon rsrcID after adding the appropriate offset if applicable
 @param uiScale The scale factor in which to load the icon.
 @param baseRsrcID The base icon rsrcID to which offset is added.
 @return The effective rsrcID after adding the offset depending upon the scaleFactor.
 */
 virtual RsrcID GetEffectiveIconRsrcID(float uiSCale, RsrcID baseRsrcID) = 0;

 /*
 Fallback logic which decides which icon is loaded based on various factors.
 @param pluginID The plugin of the resource being considered.
 @param rsrcType The type of the resource , whether it is kPNGArtRsrcType etc.
 @param rscID The base rscID for the icon.
 @param iconRsrcID The rsrcID for which the try is made to load the icon before invoking fallback logic.
 @param iconScale The desired scaleFactor in which the icon is tried to be loaded.
 @param loadedIconScale The actual scaleFactor for which the icon is loaded after executing the fallback logic.
 @return The icon resource is returned.
 */
 virtual IDResource SetIconDimensions(PluginID pluginID, RsrcType rsrcType, RsrcID rscID, RsrcID iconRsrcID, float iconScale, float* loadedIconScale) = 0;

 virtual void DrawTopRoundedRect(dvaui::drawbot::Drawbot *drawBotP, const RoundedRectAppearance& roundedRectAppearance) = 0;
 
 virtual DrawStatus CanDrawSampleText(IPMFont* font, PMString &stringToDraw, float fontSize) = 0;
 
 virtual DrawStatus CanTQDrawSampleText(std::string fontName, PMString &stringToDraw, float fontSize) = 0;
 
 virtual std::string GetImageName(PluginID pluginID, RsrcType rsrcType, RsrcID iconRsrcID) = 0;
 
 /*
 Fallback logic which decides which icon is loaded based on various factors.
 @param pluginID The plugin of the resource being considered.
 @param iconRsrcID The icon resource ID for the icon.
 @param outRsrcType The type of the resource , whether it is kPNGArtRsrcType etc.
 @param outImageName The image name of the icon set by the function
 @param iconScale The desired scaleFactor in which the icon is tried to be loaded.
 @param loadedIconScale The actual scaleFactor for which the icon is loaded after executing the fallback logic.
 @param isDark Whether dark icon should be loaded.
 @return The icon resource is returned.
 */
 virtual IDResource LoadIconResource(PluginID pluginID, RsrcID iconRsrcID, RsrcType &outRsrcType, std::string &outImageName, float iconScale, float &loadedIconScale, bool16 isDark=kFalse) = 0;
 
 virtual float GetBoundingBoxScaleFactor() = 0;
 
 virtual PMReal GetEffectiveScaleFactor(const IControlView* view) = 0;
};

#endif // __IWidgetUtils__