Facade::IFrameContentFacade Class Reference

Inheritance diagram for Facade::IFrameContentFacade:

Public Types
enum	{ kDefaultIID = IID_IFRAMECONTENTFACADE }

Public Member Functions
virtual bool16	CanConvertItemToFrame (UIDList &items) const =0
virtual bool16	CanSelectConvertItemToFrame (UIDList &items) const =0
virtual bool16	CanMultiSelectConvertItemToFrame (UIDList &items) const =0
virtual bool16	CanConvertItemToText (UIDList &items) const =0
virtual bool16	CanSelectConvertItemToText (UIDList &items) const =0
virtual bool16	CanMultiSelectConvertItemToText (UIDList &items) const =0
virtual bool16	CanConvertFrameToItem (UIDList &items) const =0
virtual bool16	CanSelectConvertFrameToItem (UIDList &items) const =0
virtual bool16	CanMultiSelectConvertFrameToItem (UIDList &items) const =0
virtual bool16	CanFitFrameToContent (UIDList &items) const =0
virtual bool16	CanFitContentToFrame (UIDList &items) const =0
virtual bool16	CanFitContentProp (UIDList &items) const =0
virtual bool16	CanCenterContentInFrame (UIDList &items) const =0
virtual bool16	CanFillFrameProp (UIDList &items) const =0
virtual bool16	CanSetFittingOptions (UIDList &items) const =0
virtual bool16	GetFittingOptions (UIDList &items, IReferencePointData::ReferencePointPosition *refPoint, PMRect *cropAmounts, IFrameContentSuite::PersistentFitOptions *fitting, bool16 *autoFit) const =0
virtual ErrorCode	ConvertItemToFrame (UIDList &items)=0
virtual ErrorCode	ConvertItemToText (UIDList &items)=0
virtual ErrorCode	ConvertFrameToItem (UIDList &items)=0
virtual ErrorCode	FitFrameToContent (UIDList &items)=0
virtual ErrorCode	FitContentToFrame (UIDList &items)=0
virtual ErrorCode	FitContentProp (UIDList &items)=0
virtual ErrorCode	CenterContentInFrame (UIDList &items)=0
virtual ErrorCode	FillFrameProp (UIDList &items)=0
virtual ErrorCode	SetFittingOptions (UIDList &items, IReferencePointData::ReferencePointPosition refPoint, const PMRect &cropAmounts, IFrameContentSuite::PersistentFitOptions fitting, bool16 autoFit, bool16 reApplyFitting)=0
virtual ErrorCode	ApplyFittingOptionsToContent (UIDList &items, bool16 listenerTriggered=kFalse)=0
virtual ErrorCode	ClearFittingOptions (UIDList &targetItemList)=0
virtual bool16	CanEnableConvertToText (const UIDList *items) const =0
virtual bool16	CanEnableConvertToFrame (const UIDList *items) const =0
virtual bool16	CanEnableConvertToItem (const UIDList *items) const =0
virtual bool16	CanEnableFitFrameToContent (const UIDList *items) const =0
virtual bool16	CanEnableFitContentToFrame (const UIDList *items) const =0
virtual ErrorCode	RecordFitOption (AutomationContext *ac, ScriptID fitType)=0
virtual ErrorCode	AddFitOptionActionAtom (AutomationContext *ac, ScriptID fitType)=0
virtual void	TellListenerUserTriggered (const UIDList &frames)=0
virtual bool16	CanApplyContentAwareFit (const UIDList &listOfFrames)=0
virtual ErrorCode	ApplyContentAwareFit (const UIDList &listOfFrames)=0
virtual ErrorCode	EnableContentAwareFitAsDefault (bool16 enable=kTrue)=0
virtual bool16	IsContentAwareFitAsDefaultEnabled ()=0
virtual bool16	CanSearchSimilar (const UIDList &listOfFrames)=0
virtual ErrorCode	SearchSimilar (const UIDList &listOfFrames)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode Facade::IFrameContentFacade::AddFitOptionActionAtom ( AutomationContext *  ac, ScriptID  fitType  )

pure virtual

Record a Fit Option action atom

Parameters

automationContext	- automation context in which the event is recorded,
fitType	- the type of fitting

Returns

ErrorCode

virtual ErrorCode Facade::IFrameContentFacade::ApplyContentAwareFit ( const UIDList &  listOfFrames )

pure virtual

Applies Content-aware Fit for a given list of items. Used by IFrameContentSuite::ApplyContentAwareFit

Parameters

items

IN UIDList of items to examine.

Returns

ErrorCode

virtual ErrorCode Facade::IFrameContentFacade::ApplyFittingOptionsToContent ( UIDList &  items, bool16  listenerTriggered = kFalse  )

pure virtual

Apply current fitting options, which are stored on a graphic frame, to the contents of those frames.

Parameters

items

(IN): UIDList of the page items to which to apply the fitting options.

virtual bool16 Facade::IFrameContentFacade::CanApplyContentAwareFit ( const UIDList &  listOfFrames )

pure virtual

Determine if Content-aware Fit can be applied for a given list of items. Used by IFrameContentSuite::CanApplyContentAwareFit

Parameters

items

IN UIDList of items to examine.

Returns

kTrue is the Content-aware fit can be applied, kFalse otherwise).

virtual bool16 Facade::IFrameContentFacade::CanCenterContentInFrame ( UIDList &  items ) const

pure virtual

Can fit content in the center of the frame?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanConvertFrameToItem ( UIDList &  items ) const

pure virtual

Can convert the selected frame to page item?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanConvertItemToFrame ( UIDList &  items ) const

pure virtual

Can convert the selected item be to Frame?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanConvertItemToText ( UIDList &  items ) const

pure virtual

Can convert the selected item to text?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanEnableConvertToFrame ( const UIDList *  items ) const

pure virtual

Returns kTrue if any item in the list can be converted to a graphic frame

Parameters

items

IN UIDList of items to check for convertibility.

Returns

kTrue (can convert one or more items) or kFalse (can't convert any items).

virtual bool16 Facade::IFrameContentFacade::CanEnableConvertToItem ( const UIDList *  items ) const

pure virtual

Returns kTrue if any frame in the list can be converted to a page item

Parameters

items

IN UIDList of items to check for convertibility.

Returns

kTrue (can convert one or more items) or kFalse (can't convert any items).

virtual bool16 Facade::IFrameContentFacade::CanEnableConvertToText ( const UIDList *  items ) const

pure virtual

Returns kTrue if any item in the list can be converted to a text frame

Parameters

items

IN UIDList of items to check for convertibility.

Returns

kTrue (can convert one or more items) or kFalse (can't convert any items).

virtual bool16 Facade::IFrameContentFacade::CanEnableFitContentToFrame ( const UIDList *  items ) const

pure virtual

Determine if Fit Frame to Content menu item should be enabled for given list of items. Used by CanFitContentToFrame (and CanFitContentProp and CanCenterContentInFrame) suite functions in IFrameContentSuite.

Parameters

items

IN UIDList of items to examine.

Returns

enable state (kTrue for enabled, kFalse otherwise).

virtual bool16 Facade::IFrameContentFacade::CanEnableFitFrameToContent ( const UIDList *  items ) const

pure virtual

Determine if Fit Frame to Content menu item should be enabled for given list of items. Used by CanFitFrameToContent suite functions in IFrameContentSuite.

Parameters

items

IN UIDList of items to examine.

Returns

Enable state (kTrue for enabled, kFalse otherwise).

virtual bool16 Facade::IFrameContentFacade::CanFillFrameProp ( UIDList &  items ) const

pure virtual

Can fill frame proportionally?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanFitContentProp ( UIDList &  items ) const

pure virtual

Can fit content proportionally?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanFitContentToFrame ( UIDList &  items ) const

pure virtual

Can fit content to its frame?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanFitFrameToContent ( UIDList &  items ) const

pure virtual

Can fit frame to its content?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanMultiSelectConvertFrameToItem ( UIDList &  items ) const

pure virtual

Can MultiSelect "convert the selected frame to item" menu?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanMultiSelectConvertItemToFrame ( UIDList &  items ) const

pure virtual

Can MultiSelect "convert the selected item be to Frame" menu?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanMultiSelectConvertItemToText ( UIDList &  items ) const

pure virtual

Can MultiSelect "convert the selected item to text" menu?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanSearchSimilar ( const UIDList &  listOfFrames )

pure virtual

Determine if similar images can be found for a given list of items. Used by IFrameContentSuite::CanSearchSimilar

Parameters

items

IN UIDList of items to examine. Currently only a single page item is supported.

Returns

kTrue if the similar images can be searched, kFalse otherwise).

virtual bool16 Facade::IFrameContentFacade::CanSelectConvertFrameToItem ( UIDList &  items ) const

pure virtual

Can Select "convert the selected frame to page item" menu?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanSelectConvertItemToFrame ( UIDList &  items ) const

pure virtual

Can select "convert the selected item be to Frame" menu?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanSelectConvertItemToText ( UIDList &  items ) const

pure virtual

Can Select "convert the selected item to text" menu?

Parameters

none

Returns

bool16

virtual bool16 Facade::IFrameContentFacade::CanSetFittingOptions ( UIDList &  items ) const

pure virtual

Can set persistent fitting options on the frame?

Parameters

items

(IN): list of inputs to which the query pertains.

Returns

bool16

virtual ErrorCode Facade::IFrameContentFacade::CenterContentInFrame ( UIDList &  items )

pure virtual

Fit content in the center of the frame

Parameters

items

(IN): UIDList of the page items to which to apply the fitting.

Returns

ErrorCode Success or Failure

virtual ErrorCode Facade::IFrameContentFacade::ClearFittingOptions ( UIDList &  targetItemList )

pure virtual

Removes all the frame fitting attributes from a list of frames. This restores it to it's initial state.

Parameters

items

(IN): UIDList of the page items to which to clear the fitting options.

virtual ErrorCode Facade::IFrameContentFacade::ConvertFrameToItem ( UIDList &  items )

pure virtual

Convert the selected frame to page item

Parameters

void

Returns

Success or Failure

virtual ErrorCode Facade::IFrameContentFacade::ConvertItemToFrame ( UIDList &  items )

pure virtual

Convert the selected item to a Frame

Parameters

void

Returns

Success or Failure

virtual ErrorCode Facade::IFrameContentFacade::ConvertItemToText ( UIDList &  items )

pure virtual

Convert the selected item to text

Parameters

void

Returns

Success or Failure

virtual ErrorCode Facade::IFrameContentFacade::EnableContentAwareFitAsDefault ( bool16  enable = kTrue )

pure virtual

Global preference for Enabling Content-Aware Fit as default while placing items.

Parameters

enable

IN kTrue value depicts enabling the preference, kFalse otherwise.

Returns

ErrorCode

virtual ErrorCode Facade::IFrameContentFacade::FillFrameProp ( UIDList &  items )

pure virtual

Fill frame proportionally. Leaves no white space around image.

Parameters

items

(IN): UIDList of the page items to which to apply the fitting.

Returns

Success or Failure

virtual ErrorCode Facade::IFrameContentFacade::FitContentProp ( UIDList &  items )

pure virtual

Fit content proportionally. May leave white space around image.

Parameters

items

(IN): UIDList of the page items to which to apply the fitting.

Returns

Success or Failure

virtual ErrorCode Facade::IFrameContentFacade::FitContentToFrame ( UIDList &  items )

pure virtual

Fit content to its frame

Parameters

items

(IN): UIDList of the page items to which to apply the fitting.

Returns

Success or Failure

virtual ErrorCode Facade::IFrameContentFacade::FitFrameToContent ( UIDList &  items )

pure virtual

Fit frame to its content

Parameters

items

(IN): UIDList of the page items to which to apply the fitting.

Returns

Success or Failure

virtual bool16 Facade::IFrameContentFacade::GetFittingOptions ( UIDList &  items, IReferencePointData::ReferencePointPosition *  refPoint, PMRect *  cropAmounts, IFrameContentSuite::PersistentFitOptions *  fitting, bool16 *  autoFit  ) const

pure virtual

Get persistent fitting options to the frame.

Parameters

items	(IN): list of inputs to which the query pertains. Any item which cannot have fitting options applied will be ignored.
refPoint	(OUT): Which of the nine reference points are currently used when aligning or fitting the contents to the frames in the target. Note that kNone indicates a mixed setting, or if Frame Fitting Option attributes have never been applied to the frame.
cropAmounts	(OUT): Crop amounts to apply to the graphic contents before aligning or fitting to the frame. Note that a value of kMixedCropAmount for any of the coordinates indicates a mixed setting in the target. kZeroRect is returns if Frame Fitting Option attributes have never been applied to the frame.
fitting	(OUT): One of kMixedFitting, kNoFitting, kFitContents, kFitProportionally, kFillProportionally. Returns kNoFitting if Frame Fitting Option attributes have never been applied to the frame.
autoFit	(OUT): kTrue if auto-fit is on. This applies the Fitting Options to the frame whenever the frame changes size or shape.

Returns

kTrue if supported or kFalse if we can't get the options or they don't apply.

virtual bool16 Facade::IFrameContentFacade::IsContentAwareFitAsDefaultEnabled ( )

pure virtual

Returns the value of Global preference for Enabling Content-Aware Fit as default while placing items.

Returns

kTrue - the preference is enabled, kFalse otherwise.

virtual ErrorCode Facade::IFrameContentFacade::RecordFitOption ( AutomationContext *  ac, ScriptID  fitType  )

pure virtual

Record a Fit Option action, the caller is responsible for calling ShouldRecord()

Parameters

automationContext	- automation context in which the event is recorded,
fitType	- the type of fitting

Returns

ErrorCode

virtual ErrorCode Facade::IFrameContentFacade::SearchSimilar ( const UIDList &  listOfFrames )

pure virtual

Searches similar image for a given list of items. Used by IFrameContentSuite::SearchSimilar

Parameters

items

IN UIDList of items to examine. Currently only a single page item is supported.

Returns

ErrorCode

virtual ErrorCode Facade::IFrameContentFacade::SetFittingOptions ( UIDList &  items, IReferencePointData::ReferencePointPosition  refPoint, const PMRect &  cropAmounts, IFrameContentSuite::PersistentFitOptions  fitting, bool16  autoFit, bool16  reApplyFitting  )

pure virtual

Set persistent fitting options to the frame.

Parameters

items	(IN): UIDList of the page items to which to set the fitting options.
refPoint	(IN): Which of the nine reference points should be used when aligning or fitting the contents to this frame?
cropAmounts	(IN): Crop amounts to apply to the graphic contents before aligning or fitting to the frame.
fitting	(IN): One of kNoFitting, kFitContents, kFitProportionally, kFillProportionally.
autoFit	(IN): kTrue to turn auto-fit on. This applies the Fitting Options to the frame whenever the frame changes size or shape.
reApplyFitting	(IN): Whether to apply auto-fit now.

virtual void Facade::IFrameContentFacade::TellListenerUserTriggered ( const UIDList &  frames )

pure virtual

Tell AutoFit to temporarily ignore content changes for the duration of a command sequence. If a dialog is active you call this before every command within a sequence that changes content of an autofit frame.

Parameters

frames

- a list of frames to ignore content changes from.