#include <IFrmLblDataFacade.h>

Inheritance diagram for IFrmLblDataFacade:

Public Types
enum	{ kDefaultIID = IID_FRMLBLDATAFACADE }

Public Member Functions
virtual ErrorCode	GetFrameLabelProperties (const UIDList &items, FrmLblInfo &frmLblInfo)=0

virtual ErrorCode	GetFrameLabelProperties (const UIDRef &item, FrmLblInfo &frmLblInfo)=0

virtual ErrorCode	UpdateFrameLabelProperties (const UIDRef &item, const FrmLblInfo &frmLblInfo)=0

virtual ErrorCode	UpdateFrameLabelProperties (const UIDList &items, const FrmLblInfo &frmLblInfo)=0

virtual ErrorCode	GetFrameLabelPreference (const UIDRef &workspace, FrmLblInfo &frmLblInfo)=0

virtual ErrorCode	SetFrameLabelPreference (const UIDRef &workspace, const FrmLblInfo &frmLblInfo)=0

virtual ErrorCode	GetFrameLabelPrintPreference (IWorkspace *workspace, bool16 &value)=0

virtual ErrorCode	SetFrameLabelPrintPreference (IWorkspace *workspace, bool16 value)=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

A facade that provides useful manipulations of IFrmLblData and IID_IFRMLBLPRINTBOOLDATA.

Member Function Documentation

virtual ErrorCode IFrmLblDataFacade::GetFrameLabelPreference	(	const UIDRef &	workspace,
		FrmLblInfo &	frmLblInfo
	)

pure virtual

Get default setting of the frame label from workspace.

Parameters

item	IN The workspae that contains the default setting.
frmLblInfo	OUT The default setting of frame label.

Returns: ErrorCode kSuccess if success, specific error code otherwise.

Implemented in FrmLblDataFacade.

virtual ErrorCode IFrmLblDataFacade::GetFrameLabelPrintPreference	(	IWorkspace *	workspace,
		bool16 &	value
	)

pure virtual

Get preference of printing frame label or not.

Parameters

workspace	IN The workspace that contains the printing preference.
value	OUT kTrue the frame label will be printed, kFalse not..

Returns: ErrorCode kSuccess if success, specific error code otherwise.

Implemented in FrmLblDataFacade.

virtual ErrorCode IFrmLblDataFacade::GetFrameLabelProperties	(	const UIDList &	items,
		FrmLblInfo &	frmLblInfo
	)

pure virtual

Get properties of the frame label on the selected items.

Parameters

items	IN The page items to get frame label properties from.
frmLblInfo	OUT The properties of frame label.

Returns: ErrorCode kSuccess if success, specific error code otherwise.

Implemented in FrmLblDataFacade.

virtual ErrorCode IFrmLblDataFacade::GetFrameLabelProperties	(	const UIDRef &	item,
		FrmLblInfo &	frmLblInfo
	)

pure virtual

Get properties of the frame label on the selected items.

Parameters

item	IN The page item to get frame label properties from.
frmLblInfo	OUT The properties of frame label.

Returns: ErrorCode kSuccess if success, specific error code otherwise.

Implemented in FrmLblDataFacade.

virtual ErrorCode IFrmLblDataFacade::SetFrameLabelPreference	(	const UIDRef &	workspace,
		const FrmLblInfo &	frmLblInfo
	)

pure virtual

Set default setting of the frame label to workspace.

Parameters

item	IN The workspae that contains the default setting.
frmLblInfo	IN The default setting of frame label.

Returns: ErrorCode kSuccess if success, specific error code otherwise.

Implemented in FrmLblDataFacade.

virtual ErrorCode IFrmLblDataFacade::SetFrameLabelPrintPreference	(	IWorkspace *	workspace,
		bool16	value
	)

pure virtual

Set preference of printing frame label or not.

Parameters

workspace	IN The workspace that contains the printing preference.
value	IN kTrue the frame label will be printed, kFalse not..

Returns: ErrorCode kSuccess if success, specific error code otherwise.

Implemented in FrmLblDataFacade.

virtual ErrorCode IFrmLblDataFacade::UpdateFrameLabelProperties	(	const UIDRef &	item,
		const FrmLblInfo &	frmLblInfo
	)

pure virtual

Set the frame label properties on the selected item.

Parameters

item	IN The page item to set frame label properties.
frmLblInfo	IN The frame label properties.

Returns: ErrorCode kSuccess if success, specific error code otherwise.

Implemented in FrmLblDataFacade.

virtual ErrorCode IFrmLblDataFacade::UpdateFrameLabelProperties	(	const UIDList &	items,
		const FrmLblInfo &	frmLblInfo
	)

pure virtual

Set the frame label properties on the selected items.

Parameters

items	IN The page item to set frame label properties.
frmLblInfo	IN The frame label properties.

Returns: ErrorCode kSuccess if success, specific error code otherwise.

Implemented in FrmLblDataFacade.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation