IFrameContentSuite Class Reference

#include <IFrameContentSuite.h>

Inheritance diagram for IFrameContentSuite:

Public Types
enum	{ kDefaultIID = IID_IFRAMECONTENTSUITE }
enum	PersistentFitOptions {   kMixedFitting = -1, kNoFitting, kFitContents, kFitProportionally,   kFillProportionally }

Public Member Functions
virtual bool16	CanConvertItemToFrame (void) const =0
virtual bool16	CanSelectConvertItemToFrame (void) const =0
virtual bool16	CanMultiSelectConvertItemToFrame (void) const =0
virtual bool16	CanConvertItemToText (void) const =0
virtual bool16	CanSelectConvertItemToText (void) const =0
virtual bool16	CanMultiSelectConvertItemToText (void) const =0
virtual bool16	CanConvertFrameToItem (void) const =0
virtual bool16	CanSelectConvertFrameToItem (void) const =0
virtual bool16	CanMultiSelectConvertFrameToItem (void) const =0
virtual bool16	CanFitFrameToContent (void) const =0
virtual bool16	CanFitContentToFrame (void) const =0
virtual bool16	CanFitContentProp (void) const =0
virtual bool16	CanCenterContentInFrame (void) const =0
virtual bool16	CanFillFrameProp (void) const =0
virtual bool16	CanSetFittingOptions (void) const =0
virtual bool16	CanClearFittingOptions (void) const =0
virtual bool16	GetFittingOptions (IReferencePointData::ReferencePointPosition *refPoint, PMRect *cropAmounts, PersistentFitOptions *fitting, bool16 *autoFit) const =0
virtual ErrorCode	ConvertItemToFrame (void)=0
virtual ErrorCode	ConvertItemToText (void)=0
virtual ErrorCode	ConvertFrameToItem (void)=0
virtual ErrorCode	FitFrameToContent (void)=0
virtual ErrorCode	FitContentToFrame (void)=0
virtual ErrorCode	FitContentProp (void)=0
virtual ErrorCode	CenterContentInFrame (void)=0
virtual ErrorCode	FillFrameProp (void)=0
virtual ErrorCode	SetFittingOptions (IReferencePointData::ReferencePointPosition refPoint, const PMRect &cropAmounts, PersistentFitOptions fitting, bool16 autoFit)=0
virtual ErrorCode	ClearFittingOptions (void)=0
virtual bool16	CanApplyContentAwareFit (void) const =0
virtual ErrorCode	ApplyContentAwareFit (void)=0
virtual bool16	CanSearchSimilar (void) const =0
virtual ErrorCode	SearchSimilar (void)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

IFrameContentSuite interface

Provide a suite for convert between pageitem frame and its contents

Member Enumeration Documentation

enum IFrameContentSuite::PersistentFitOptions

enumeration of possible persistent fitting options on a graphic frame. Note that kMixedFitting is only used as a return value from GetFittingOptions for the fitting parameter indicating that there is a multiple selection and that the elements of the selection have differing fitting settings.

Member Function Documentation

virtual ErrorCode IFrameContentSuite::ApplyContentAwareFit ( void  )

pure virtual

Apply content aware fit to the current selection. Choose the best area of the image to be shown in the frame.

Returns

Success or Failure

virtual bool16 IFrameContentSuite::CanApplyContentAwareFit ( void  ) const

pure virtual

Can apply Content-aware fit to the current selection

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanCenterContentInFrame ( void  ) const

pure virtual

Can fit content in the center of the frame?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanClearFittingOptions ( void  ) const

pure virtual

Can clear persistent fitting options on the frame?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanConvertFrameToItem ( void  ) const

pure virtual

Can convert the selected frame to page item?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanConvertItemToFrame ( void  ) const

pure virtual

Can convert the selected item be to Frame?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanConvertItemToText ( void  ) const

pure virtual

Can convert the selected item to text?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanFillFrameProp ( void  ) const

pure virtual

Can fill frame proportionally?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanFitContentProp ( void  ) const

pure virtual

Can fit content proportionally?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanFitContentToFrame ( void  ) const

pure virtual

Can fit content to its frame?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanFitFrameToContent ( void  ) const

pure virtual

Can fit frame to its content?

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanMultiSelectConvertFrameToItem ( void  ) const

pure virtual

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

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanMultiSelectConvertItemToFrame ( void  ) const

pure virtual

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

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanMultiSelectConvertItemToText ( void  ) const

pure virtual

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

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanSearchSimilar ( void  ) const

pure virtual

Can search similar images for the current selection.

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanSelectConvertFrameToItem ( void  ) const

pure virtual

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

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanSelectConvertItemToFrame ( void  ) const

pure virtual

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

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanSelectConvertItemToText ( void  ) const

pure virtual

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

Parameters

none

Returns

bool16

virtual bool16 IFrameContentSuite::CanSetFittingOptions ( void  ) const

pure virtual

Can set persistent fitting options on the frame?

Parameters

none

Returns

bool16

virtual ErrorCode IFrameContentSuite::CenterContentInFrame ( void  )

pure virtual

Fit content in the center of the frame

Returns

ErrorCode Success or Failure

virtual ErrorCode IFrameContentSuite::ClearFittingOptions ( void  )

pure virtual

Clear frame fitting options .

Returns

Success or Failure

virtual ErrorCode IFrameContentSuite::ConvertFrameToItem ( void  )

pure virtual

Convert the selected frame to page item

Parameters

void

Returns

Success or Failure

virtual ErrorCode IFrameContentSuite::ConvertItemToFrame ( void  )

pure virtual

Convert the selected item to a Frame

Parameters

void

Returns

Success or Failure

virtual ErrorCode IFrameContentSuite::ConvertItemToText ( void  )

pure virtual

Convert the selected item to text

Parameters

void

Returns

Success or Failure

virtual ErrorCode IFrameContentSuite::FillFrameProp ( void  )

pure virtual

Fill frame proportionally. Leaves no white space around image.

Returns

Success or Failure

virtual ErrorCode IFrameContentSuite::FitContentProp ( void  )

pure virtual

Fit content proportionally. May leave white space around image.

Returns

Success or Failure

virtual ErrorCode IFrameContentSuite::FitContentToFrame ( void  )

pure virtual

Fit content to its frame

Returns

Success or Failure

virtual ErrorCode IFrameContentSuite::FitFrameToContent ( void  )

pure virtual

Fit frame to its content

Returns

Success or Failure

virtual bool16 IFrameContentSuite::GetFittingOptions ( IReferencePointData::ReferencePointPosition *  refPoint, PMRect *  cropAmounts, PersistentFitOptions *  fitting, bool16 *  autoFit  ) const

pure virtual

Get persistent fitting options to the frame.

Parameters

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.
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.
fitting	(OUT): One of kMixedFitting, kNoFitting, kFitContents, kFitProportionally, kFillProportionally.
autoFit	(OUT): if kTrue, fitting options are reapplied when the frame is resized

Returns

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

virtual ErrorCode IFrameContentSuite::SearchSimilar ( void  )

pure virtual

Search similar images for the current selection.

Returns

Success or Failure

virtual ErrorCode IFrameContentSuite::SetFittingOptions ( IReferencePointData::ReferencePointPosition  refPoint, const PMRect &  cropAmounts, PersistentFitOptions  fitting, bool16  autoFit  )

pure virtual

Set persistent fitting options to the frame.

Parameters

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): Turn auto-fit on or off.