InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IProxyWidgetAttributes Class Referenceabstract

#include <IProxyWidgetAttributes.h>

Inheritance diagram for IProxyWidgetAttributes:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPROXYWIDGETATTRIBUTES }
 

Public Member Functions

virtual bool16 GetProxyIsLine ()=0
 
virtual void SetProxyIsLine (bool16 isLine)=0
 
virtual void SetProxyReferenceAngle (const PMReal &angle)=0
 
virtual void SetProxyReferenceXScale (const PMReal &xScale)=0
 
virtual void SetProxyReferenceYScale (const PMReal &yScale)=0
 
virtual void SetProxyReferenceXSkew (const PMReal &xSkew)=0
 
virtual void SetProxyReferenceLine (const PMLine &line)=0
 
virtual PMReal GetProxyReferenceAngle ()=0
 
virtual PMReal GetProxyReferenceXScale ()=0
 
virtual PMReal GetProxyReferenceYScale ()=0
 
virtual PMReal GetProxyReferenceXSkew ()=0
 
virtual PMLine GetProxyReferenceLine ()=0
 
virtual void SetProxyAppearance (const IReferencePointData::ReferenceAppearance &appearance)=0
 
virtual
IReferencePointData::ReferenceAppearance 
GetProxyAppearance ()=0
 
virtual void SetProxyPosition (const IReferencePointData::ReferencePointPosition &position)=0
 
virtual
IReferencePointData::ReferencePointPosition 
GetProxyPosition ()=0
 
virtual void UpdateProxyState (ISelectionManager *selectionManager, IControlView *view, PathInfo *pathInfo)=0
 
virtual void UpdateProxyValues (ISelectionManager *selectionManager)=0
 
virtual void UpdateProxyRotation (ISelectionManager *selectionManager)=0
 
virtual void UpdateProxyScale (ISelectionManager *selectionManager)=0
 
virtual void UpdateProxySkew (ISelectionManager *selectionManager)=0
 
virtual bool16 GetProxyIsRow ()=0
 
virtual void SetProxyIsRow (bool16 isRow)=0
 
virtual bool16 GetProxyIsColumn ()=0
 
virtual void SetProxyIsColumn (bool16 isColumn)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface responsible for getting and setting various attributes of proxy widgets. This is the widget that appears in the Transform panel that typically has a 9-point appearance, though it can also be rotated, or have a line or point appearance. The proxy widget generally reflects the current selection state of the document.

Member Function Documentation

virtual IReferencePointData::ReferenceAppearance IProxyWidgetAttributes::GetProxyAppearance ()
pure virtual

Return the appearance of the proxy

Parameters
none
Returns
IReferencePointData::ReferenceAppearance
virtual bool16 IProxyWidgetAttributes::GetProxyIsColumn ()
pure virtual
Return if the appearance is column only (just 3 points drawn vertically) or not.

Returns
bool16 kTrue for column appearance, kFalse otherwise.
virtual bool16 IProxyWidgetAttributes::GetProxyIsLine ()
pure virtual

Return if the appearance is a line state (just 3 points drawn) or not.

Parameters
none
Returns
bool16 kTrue for line appearance, kFalse otherwise.
virtual bool16 IProxyWidgetAttributes::GetProxyIsRow ()
pure virtual
Return if the appearance is row only (just 3 points drawn horizontally) or not.

Returns
bool16 kTrue for row appearance, kFalse otherwise.
virtual IReferencePointData::ReferencePointPosition IProxyWidgetAttributes::GetProxyPosition ()
pure virtual

Return the current position of the proxy. Usually one of 9 positions.

Parameters
none
Returns
IReferencePointData::ReferencePointPosition
virtual PMReal IProxyWidgetAttributes::GetProxyReferenceAngle ()
pure virtual

Return the angle of the proxy for the current selection.

Returns
PMReal
virtual PMLine IProxyWidgetAttributes::GetProxyReferenceLine ()
pure virtual

Return a line representing the line when proxy is using line appearance.

Parameters
none
Returns
PMLine
virtual PMReal IProxyWidgetAttributes::GetProxyReferenceXScale ()
pure virtual

Return the x scale of the proxy for the current selection.

Returns
PMReal
virtual PMReal IProxyWidgetAttributes::GetProxyReferenceXSkew ()
pure virtual

Return the skew value of the proxy for the current selection.

Parameters
none
Returns
PMReal
virtual PMReal IProxyWidgetAttributes::GetProxyReferenceYScale ()
pure virtual

Return the y scale of the proxy for the current selection.

Returns
PMReal
virtual void IProxyWidgetAttributes::SetProxyAppearance (const IReferencePointData::ReferenceAppearanceappearance)
pure virtual

Set the appearance of the proxy. There are several ways proxy can be drawn.

Parameters
appearancethe new appearance
See Also
IReferencePointData
virtual void IProxyWidgetAttributes::SetProxyIsColumn (bool16 isColumn)
pure virtual
Set the appearance to row only (just 3 points drawn vertically).

Parameters
isColumnkTrue for row appearance, kFalse will set nine points appearance.
virtual void IProxyWidgetAttributes::SetProxyIsLine (bool16 isLine)
pure virtual

Set the appearance of the proxy to a line

Parameters
isLinekTrue for line appearance, kFalse for 9-point appearance.
See Also
SetAppearance
virtual void IProxyWidgetAttributes::SetProxyIsRow (bool16 isRow)
pure virtual
Set the appearance to row only (just 3 points drawn horizontally).

Parameters
isRowkTrue for row appearance, kFalse will set nine points appearance.
virtual void IProxyWidgetAttributes::SetProxyPosition (const IReferencePointData::ReferencePointPositionposition)
pure virtual

Set the position of the proxy (where the black dot draws). Usually one of 9 positions.

Parameters
positionthe new position
See Also
IReferencePointData.h
virtual void IProxyWidgetAttributes::SetProxyReferenceAngle (const PMRealangle)
pure virtual

Set the anglee of the proxy. Reflects the rotation of the selection. Proxy will itself will rotate based on the rotation value of selection to make the proxy visually match the selection. e.g. Upper left of proxy is upper left of selection.

Parameters
angle
virtual void IProxyWidgetAttributes::SetProxyReferenceLine (const PMLineline)
pure virtual

Set the line of the proxy. Used for the line appearance when the selection is a line.

Parameters
line
See Also
SetAppearance
virtual void IProxyWidgetAttributes::SetProxyReferenceXScale (const PMRealxScale)
pure virtual

Set the x scale of the proxy. Reflects the x scale percentage of the selection. Proxy may "flip" if the selection is flipped to make the proxy visually match the selection. e.g. Upper left of proxy is upper left of selection.

Parameters
xScale
virtual void IProxyWidgetAttributes::SetProxyReferenceXSkew (const PMRealxSkew)
pure virtual

Set the skew of the proxy. Reflect the skew of the selection.

Parameters
xSkew
virtual void IProxyWidgetAttributes::SetProxyReferenceYScale (const PMRealyScale)
pure virtual

Set the y scale of the proxy. Reflects the y scale percentage of the selection. Proxy may "flip" if the selection is flipped to make the proxy visually match the selection. e.g. Upper left of proxy is upper left of selection.

Parameters
yScale
virtual void IProxyWidgetAttributes::UpdateProxyRotation (ISelectionManagerselectionManager)
pure virtual

Update the rotation from the current selection.

Parameters
selectionManager
virtual void IProxyWidgetAttributes::UpdateProxyScale (ISelectionManagerselectionManager)
pure virtual

Update the scale from the current selection.

Parameters
selectionManager
virtual void IProxyWidgetAttributes::UpdateProxySkew (ISelectionManagerselectionManager)
pure virtual

Update the skew from the current selection.

Parameters
selectionManager
virtual void IProxyWidgetAttributes::UpdateProxyState (ISelectionManagerselectionManager,
IControlViewview,
PathInfopathInfo 
)
pure virtual

Recompute the position and appearance of the proxy using the IReferencePointSuite

Parameters
selectionManager
pathInfoObsolete, unused argument
See Also
IReferencePointSuite.h
virtual void IProxyWidgetAttributes::UpdateProxyValues (ISelectionManagerselectionManager)
pure virtual

Update rotation, scale and skew from the selection manager

Parameters
selectionManager