Inheritance diagram for ILiveEditSelectionSuite:

Public Types
enum	{ kDefaultIID = IID_ILIVEEDITSELECTIONSUITE }

Public Member Functions
virtual bool16	CanSaveEdits () const =0

virtual bool16	CanExport () const =0

virtual bool16	CanCheckIn () const =0

virtual bool16	CanCancelCheckOut () const =0

virtual bool16	CanCheckOut () const =0

virtual bool16	Export (const IDFile *destinationDir=nil, IAssignment::AssignmentCompatibility exportCompatibility=IAssignment::kUnassignedCompatibility) const =0

virtual bool16	CheckOut () const =0

virtual bool16	CancelCheckOut () const =0

virtual bool16	CheckIn () const =0

virtual bool16	CheckInAll () const =0

virtual bool16	Relink () const =0

virtual bool16	SaveEdits () const =0

virtual bool16	IsOutOfDate () const =0

virtual bool16	IsInCopyStorySelected () const =0

virtual void	SetPanel (WidgetID panelID)=0

virtual void	SetViewPoint (IControlView *view, const PMPoint &point)=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 bool16 ILiveEditSelectionSuite::CanCancelCheckOut ( ) const

pure virtual

Tests whether or not can cancel check out (revert edits).

Returns: kTrue if can cancel check out.

virtual bool16 ILiveEditSelectionSuite::CancelCheckOut ( ) const

pure virtual

Release the lock on a previously checked out selected story. This operation reverts local copy to match the project version. Collects stories from selection and processes ICBridgeRevertChangesCmd, which calls ILiveEditSelectionSuite::RevertChanges().

Returns: kTrue if operation succeeded.

virtual bool16 ILiveEditSelectionSuite::CanCheckIn ( ) const

pure virtual

Tests whether or not a we can check in the current selection.

Returns: kTrue if we can export

virtual bool16 ILiveEditSelectionSuite::CanCheckOut ( ) const

pure virtual

Tests whether or not can check out for editing.

Returns: kTrue if can lock.

virtual bool16 ILiveEditSelectionSuite::CanExport ( ) const

pure virtual

Tests whether or not a we can export the current selection.

Returns: kTrue if checked out.

virtual bool16 ILiveEditSelectionSuite::CanSaveEdits ( ) const

pure virtual

Tests whether or not we can save edits to the current selection.

Returns: kTrue if can save.

virtual bool16 ILiveEditSelectionSuite::CheckIn ( ) const

pure virtual

Save any local changes to a project and release the project lock

Returns: kTrue if operation succeeded.

virtual bool16 ILiveEditSelectionSuite::CheckInAll ( ) const

pure virtual

Save any local changes to a project and release the project lock

Returns: kTrue if operation succeeded for all the lewt.

virtual bool16 ILiveEditSelectionSuite::CheckOut ( ) const

pure virtual

Check out selected InCopy stories. Collects stories from selection and processes ICBridgeEditInPlaceCmd, which calls ILiveEditSelectionSuite::EditInPlace().

Returns: kTrue if story is editable.

virtual bool16 ILiveEditSelectionSuite::Export	(	const IDFile *	destinationDir = `nil`,
		IAssignment::AssignmentCompatibility	exportCompatibility = `IAssignment::kUnassignedCompatibility`
	)		const

pure virtual

Exports selected stories as InCopy stories.

Parameters

destinationDir	- A pointer to a directory path to be used in place of prompting the user, or nil to prompt.
exportCompatibility	- The export formats to allow.

Returns: kTrue if operation succeeded.

See Also: IAssignment::AssignmentCompatibility

virtual bool16 ILiveEditSelectionSuite::IsOutOfDate ( ) const

pure virtual

Determine if a story is out of date. Collects stories from selection checks the datalink.

Returns: kTrue if the selected story is out of date.

virtual bool16 ILiveEditSelectionSuite::Relink ( ) const

pure virtual

Reimport the selected story if changes have been made to it outside of the application

Returns: kTrue if operation succeeded.

virtual bool16 ILiveEditSelectionSuite::SaveEdits ( ) const

pure virtual

Saves edits to selected stories to their respective story files. Stories remain checked out.

Returns: kTrue if operation succeeded.

virtual void ILiveEditSelectionSuite::SetPanel ( WidgetID panelID )

pure virtual

Set the panel rsrc id, so the suite knows how to get selected items Two panels are using this suite, kLinksUIPanelWidgetID and kStoryListPanelWidgetID

Parameters

widgetID the panel widget id that the suite should get the selection items from

virtual void ILiveEditSelectionSuite::SetViewPoint	(	IControlView *	view,
		const PMPoint &	point
	)

pure virtual

Set the view and mouse point, so the default context suite knows how to get selected items from under the mouse point when there is no document selection (currently used by InCopy only).

Parameters

view	the relevant control view
point	the relevant mouse point

Public Types

Public Member Functions

Member Function Documentation