FrmLblDataFacade Class Reference

Inheritance diagram for FrmLblDataFacade:

Public Member Functions
	FrmLblDataFacade (IPMUnknown *boss)
virtual	~FrmLblDataFacade ()
virtual ErrorCode	GetFrameLabelProperties (const UIDList &items, FrmLblInfo &frmLblInfo)
virtual ErrorCode	GetFrameLabelProperties (const UIDRef &item, FrmLblInfo &frmLblInfo)
virtual ErrorCode	UpdateFrameLabelProperties (const UIDRef &item, const FrmLblInfo &frmLblInfo)
virtual ErrorCode	UpdateFrameLabelProperties (const UIDList &items, const FrmLblInfo &frmLblInfo)
virtual ErrorCode	GetFrameLabelPreference (const UIDRef &workspace, FrmLblInfo &frmLblInfo)
virtual ErrorCode	SetFrameLabelPreference (const UIDRef &workspace, const FrmLblInfo &frmLblInfo)
virtual ErrorCode	GetFrameLabelPrintPreference (IWorkspace *workspace, bool16 &value)
virtual ErrorCode	SetFrameLabelPrintPreference (IWorkspace *workspace, bool16 value)
Public Member Functions inherited from CPMUnknown< IFrmLblDataFacade >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Additional Inherited Members
Public Types inherited from IFrmLblDataFacade
enum	{ kDefaultIID = IID_FRMLBLDATAFACADE }
Protected Member Functions inherited from CPMUnknown< IFrmLblDataFacade >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< IFrmLblDataFacade >
HelperInterface	fHelperInterface

Constructor & Destructor Documentation

FrmLblDataFacade::FrmLblDataFacade ( IPMUnknown *  boss )

inline

Constructor.

Parameters

boss	interface ptr from boss object on which this interface is aggregated.

virtual FrmLblDataFacade::~FrmLblDataFacade ( )

inlinevirtual

Destructor.

Member Function Documentation

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

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.

Implements IFrmLblDataFacade.

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

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.

Implements IFrmLblDataFacade.

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

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.

Implements IFrmLblDataFacade.

Binds the C implementation class onto its ImplementationID making the C code callable by the application *ErrorCode FrmLblDataFacade::GetFrameLabelProperties ( const UIDRef &  item, FrmLblInfo &  frmLblInfo  )

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.

Implements IFrmLblDataFacade.

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

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.

Implements IFrmLblDataFacade.

ErrorCode FrmLblDataFacade::SetFrameLabelPrintPreference ( IWorkspace *  workspace, bool16  value  )

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.

Implements IFrmLblDataFacade.

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

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.

Implements IFrmLblDataFacade.

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

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.

Implements IFrmLblDataFacade.