Inheritance diagram for Facade::IObjectStylesFacade:

Public Types
enum	{ kDefaultIID = IID_IOBJECTSTYLESFACADE }

Public Member Functions
virtual ErrorCode	CreateNewObjectStyle (IPMUnknown objectStyleTarget, IWorkspace ws, const PMString &newStyleName, const UID basedOnUID, const bool16 &bStyleNameTranslatable=kFalse, const VirtualKey virtualKey=kVirtualNullKey, const int16 modifier=0, const UID parentUID=kInvalidUID, const int32 position=-1)=0

virtual ErrorCode	ApplyObjectStyleToUIDList (const UIDList &list, IWorkspace *ws, UID uidOfStyle, K2Vector< ClassID > &categoriesToOverride, bool16 applyEmptyCatWithRoot)=0

virtual ErrorCode	EditObjectStyle (IPMUnknown objectStyleTarget, IObjectStyleInfo iObjectStyleInfo, const IWorkspace *ws, const PMString &originalStyleName, int32 numApplies=0, const bool16 bNotify=kTrue)=0

virtual ErrorCode	ReplaceObjectStyles (IWorkspace *ws, const K2Vector< PMString > &stylesToBeReplaced, const PMString &sourceStyleName)=0

virtual ErrorCode	BreakLinkFromProvidedObjectStyles (IWorkspace *ws, const K2Vector< PMString > &styleNames)=0

virtual ErrorCode	DeleteObjectStyles (IWorkspace *ws, const K2Vector< PMString > &styleNames, const PMString &styleToReplaceWith, const bool16 &bPerserveFormat=kFalse)=0

virtual ErrorCode	LoadObjectStyles (IWorkspace *ws, const bool16 &overrideLocal, const IDFile &sourceFile, std::map< PMString, bool32 > importMap, std::map< PMString, bool32 > clashMap, std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy > resolveMap, const StyleClashResolutionTypes::GlobalClashResolutionStrategy &globalClashResolutionStrategy)=0

virtual ErrorCode	ExportObjectStyles (IWorkspace *ws, const IDFile &targetFile, const K2Vector< PMString > &objectStyles)=0

virtual ErrorCode	ImportObjectStyles (IWorkspace *ws, const IDFile &sourceFile)=0

virtual ErrorCode	SortObjectStyles (IWorkspace *ws)=0

virtual ErrorCode	MoveObjectStyles (IWorkspace *ws, const K2Vector< PMString > &selectedObjectStylesPaths, const int32 &dropBefore, const UID newParent, const RemappingList &remaplist, const IStyleRemapData::ConflictFlagEnum conflictFlag)=0

virtual ErrorCode	MoveObjectStyles (const UIDList &selectedObjectStyles, const int32 &dropBefore, const UID newParent, const RemappingList &remaplist, const IStyleRemapData::ConflictFlagEnum conflictFlag)=0

virtual ErrorCode	ChangeDefaultTextStyle (IWorkspace *ws, UID newDefaultStyleUID, bool16 bApplyAttrs=kFalse, bool16 bClearOverrides=kFalse)=0

virtual ErrorCode	ChangeDefaultFrameGridStyle (IWorkspace *ws, UID newDefaultStyleUID, bool16 bApplyAttrs=kFalse, bool16 bClearOverrides=kFalse)=0

virtual ErrorCode	RenameObjectStyle (IWorkspace *ws, const UID styleUID, const PMString &newName, const bool16 bNotify=kTrue)=0

virtual ErrorCode	DuplicateObjectStyles (IWorkspace *ws, const K2Vector< PMString > &styleNames, K2Vector< PMString > &namesCreated)=0

virtual ErrorCode	ChangeDefaultGraphicStyle (IWorkspace *ws, UID newDefaultStyleUID, bool16 bApplyAttrs=kFalse, bool16 bClearOverrides=kFalse)=0

virtual PMString	GetDefaultGraphicStyle (IWorkspace *ws)=0

virtual PMString	GetDefaultTextStyle (IWorkspace *ws)=0

virtual PMString	GetDefaultFrameGridStyle (IWorkspace *ws)=0

virtual ErrorCode	CreateNewObjectStyleGroup (IWorkspace *ws, const PMString newStyleGroupName, const UID parent, const int32 position)=0

virtual ErrorCode	RenameObjectStyleGroup (IWorkspace *ws, const UID styleGroupUID, const PMString &newName)=0

virtual ErrorCode	DuplicateObjectStyleGroups (const UIDList &styleGroups)=0

virtual ErrorCode	DeleteStyleGroups (const UIDList &styleGroups, const RemappingList &remaplist)=0

virtual ErrorCode	MoveStyleGroups (const UIDList &styleGroups, const UID newParent, const int32 position, const RemappingList &remaplist, const IStyleRemapData::ConflictFlagEnum conflictFlag)=0

virtual ErrorCode	LoadObjectStyles (IWorkspace *ws, const bool16 &overrideLocal, const std::string &sourceFile, std::map< PMString, bool32 > importMap, std::map< PMString, bool32 > clashMap, std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy > resolveMap, const StyleClashResolutionTypes::GlobalClashResolutionStrategy &bLoadAllWithOverwrite)=0

virtual ErrorCode	LoadObjectStyles (const std::string &assetData)=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::IObjectStylesFacade::ApplyObjectStyleToUIDList	(	const UIDList &	list,
		IWorkspace *	ws,
		UID	uidOfStyle,
		K2Vector< ClassID > &	categoriesToOverride,
		bool16	applyEmptyCatWithRoot
	)

pure virtual

ApplyObjectStyleToUIDList: Applys the object style to the specified UIDList

Parameters

list	The list of UIDs to apply this style to
ws	The workspace the object style name table containing the style
overrideCategories	K2Vector<ClassID> of categories to clear (clear all overrides means all of the active categories in the style)
applyEmptyCatWithRoot	true if we are applying empty (unchecked) cateogories from the root style

virtual ErrorCode Facade::IObjectStylesFacade::BreakLinkFromProvidedObjectStyles	(	IWorkspace *	ws,
		const K2Vector< PMString > &	styleNames
	)

pure virtual

BreakLinkFromProvidedObjectStyles: perserve item's original formatting and set none style as its object style.

Parameters

ws	The workspace the object style name table containing the style
styleNames	The list of styles to be disassociated from

virtual ErrorCode Facade::IObjectStylesFacade::ChangeDefaultFrameGridStyle	(	IWorkspace *	ws,
		UID	newDefaultStyleUID,
		bool16	bApplyAttrs = `kFalse`,
		bool16	bClearOverrides = `kFalse`
	)

pure virtual

ChangeDefaultFrameGridStyle: Changes the default frame grid style

Parameters

ws	The workspace the object style name table containing the styles to sort
newDefaultStyleUID	The new text style UID
applyAttrs	True if we should apply the attrs from the style, this is not true when creating the style
clearOverrides	True if we want to clear overrides, otherwise kFalse.

virtual ErrorCode Facade::IObjectStylesFacade::ChangeDefaultGraphicStyle	(	IWorkspace *	ws,
		UID	newDefaultStyleUID,
		bool16	bApplyAttrs = `kFalse`,
		bool16	bClearOverrides = `kFalse`
	)

pure virtual

ChangeDefaultGraphicStyle: Changes the default graphic style

Parameters

ws	The workspace the object style name table containing the styles to sort
newDefaultStyleUID	The new graphic style UID
applyAttrs	True if we should apply the attrs from the style, this is not true when creating the style
clearOverrides	True if we want to clear overrides, otherwise kFalse.

virtual ErrorCode Facade::IObjectStylesFacade::ChangeDefaultTextStyle	(	IWorkspace *	ws,
		UID	newDefaultStyleUID,
		bool16	bApplyAttrs = `kFalse`,
		bool16	bClearOverrides = `kFalse`
	)

pure virtual

ChangeDefaultTextStyle: Changes the default text style

Parameters

ws	The workspace the object style name table containing the styles to sort
newDefaultStyleUID	The new text style UID
applyAttrs	True if we should apply the attrs from the style, this is not true when creating the style
clearOverrides	True if we want to clear overrides, otherwise kFalse.

virtual ErrorCode Facade::IObjectStylesFacade::CreateNewObjectStyle	(	IPMUnknown *	objectStyleTarget,
		IWorkspace *	ws,
		const PMString &	newStyleName,
		const UID	basedOnUID,
		const bool16 &	bStyleNameTranslatable = `kFalse`,
		const VirtualKey	virtualKey = `kVirtualNullKey`,
		const int16	modifier = `0`,
		const UID	parentUID = `kInvalidUID`,
		const int32	position = `-1`
	)

pure virtual

CreateNewObjectStyle: Creates a new object style on the workspace provided with the name and based on UID passed in

Parameters

objectStyleTarget	The target containing the attributes of the object style
ws	The workspace the object style name table is on to add the new style to
newStyleName	The name of the new style
basedOnUID	the UID this style is based on
bStyleNameTranslatable	the bool flag indicates if the style name is translatable or not
virtualKey	the virtualKey for KBSC
modifier	the modifier for KBSC
parentUID	the UID of the parent, kInvalidUID to create at root level
position	position at which the new UID to be created, -1 to create at the end.

virtual ErrorCode Facade::IObjectStylesFacade::CreateNewObjectStyleGroup	(	IWorkspace *	ws,
		const PMString	newStyleGroupName,
		const UID	parent,
		const int32	position
	)

pure virtual

Creates a new style group.

Parameters

ws	[IN] Workspace where to create the group.
newStyleGroupName	[IN] new style group name.
parent	[IN] UID of parent to create new group.
position	[IN] postion to create new style, pass -1 for last

virtual ErrorCode Facade::IObjectStylesFacade::DeleteObjectStyles	(	IWorkspace *	ws,
		const K2Vector< PMString > &	styleNames,
		const PMString &	styleToReplaceWith,
		const bool16 &	bPerserveFormat = `kFalse`
	)

pure virtual

DeleteObjectStyles: Deletes the styles in the list

Parameters

ws	The workspace the object style name table containing the style
styleNames	The list of styles to be deleted
styleToReplaceWith	The style used to replace with the deleted styles.
bPerserveFormat	The flag for perserve format setting.

virtual ErrorCode Facade::IObjectStylesFacade::DeleteStyleGroups	(	const UIDList &	styleGroups,
		const RemappingList &	remaplist
	)

pure virtual

Deletes a list of style groups.

Parameters

styleGroups	[IN] list of object style groups to be deleted.
remapList	[IN] remapping for the style inside the groups being deleted.

virtual ErrorCode Facade::IObjectStylesFacade::DuplicateObjectStyleGroups ( const UIDList & styleGroups )

pure virtual

Duplicates a list of style groups.

Parameters

styleGroups [IN] list of style groups to be duplicated.

virtual ErrorCode Facade::IObjectStylesFacade::DuplicateObjectStyles	(	IWorkspace *	ws,
		const K2Vector< PMString > &	styleNames,
		K2Vector< PMString > &	namesCreated
	)

pure virtual

DuplicateObjectStyles: Duplicates the object styles in the stylesToBeReplaced list

Parameters

ws	The workspace the object style name table containing the style
styleNames	The list of styles to be duplicate
namesCreated	The names of the newly created styles

virtual ErrorCode Facade::IObjectStylesFacade::EditObjectStyle	(	IPMUnknown *	objectStyleTarget,
		IObjectStyleInfo *	iObjectStyleInfo,
		const IWorkspace *	ws,
		const PMString &	originalStyleName,
		int32	numApplies = `0`,
		const bool16	bNotify = `kTrue`
	)

pure virtual

EditObjectStyle: Changes the data of the object style to reflect what was passed in

Parameters

objectStyleTarget	The target containing the new attributes of the object style
iObjectStyleInfo	The new name and based on UID for the style
ws	The workspace the object style name table containing the style
originalStyleName	the style's original name
numApplies	IN: used only by the dialog, set to the number of times we have applied this command
bNotify	IN: used to command indicating if we should do notification or not.

virtual ErrorCode Facade::IObjectStylesFacade::ExportObjectStyles	(	IWorkspace *	ws,
		const IDFile &	targetFile,
		const K2Vector< PMString > &	objectStyles
	)

pure virtual

ExportObjectStyles: Export the styles from the targetFile

Parameters

ws	The workspace the object style name table containing the style
targetFile	The file to load from
objectStyles	The styles to be exported.

virtual PMString Facade::IObjectStylesFacade::GetDefaultFrameGridStyle ( IWorkspace * ws )

pure virtual

Returns the default frame grid style

Returns: PMString

virtual PMString Facade::IObjectStylesFacade::GetDefaultGraphicStyle ( IWorkspace * ws )

pure virtual

Returns the default graphics style

Returns: PMString

virtual PMString Facade::IObjectStylesFacade::GetDefaultTextStyle ( IWorkspace * ws )

pure virtual

Returns the default text style

Returns: PMString

virtual ErrorCode Facade::IObjectStylesFacade::ImportObjectStyles	(	IWorkspace *	ws,
		const IDFile &	sourceFile
	)

pure virtual

ImportObjectStyles: Import the styles from the sourceFile

Parameters

ws	The workspace the object style name table containing the style
sourceFile	The file to load from

virtual ErrorCode Facade::IObjectStylesFacade::LoadObjectStyles	(	IWorkspace *	ws,
		const bool16 &	overrideLocal,
		const IDFile &	sourceFile,
		std::map< PMString, bool32 >	importMap,
		std::map< PMString, bool32 >	clashMap,
		std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy >	resolveMap,
		const StyleClashResolutionTypes::GlobalClashResolutionStrategy &	globalClashResolutionStrategy
	)

pure virtual

LoadObjectStyles: Loads the styles from the sourceFile

Parameters

ws	The workspace the object style name table containing the style
overrideLocal	True if the local styles with the same name are just overwritten
sourceFile	The file to load from
importMap	Import styles.
clashMap	Styles that are conflict with existing styles.
resolveMap	Result styles after resolving the conflicts.
globalClashResolutionStrategy	IN: global clash resolution strategy.

virtual ErrorCode Facade::IObjectStylesFacade::LoadObjectStyles	(	IWorkspace *	ws,
		const bool16 &	overrideLocal,
		const std::string &	sourceFile,
		std::map< PMString, bool32 >	importMap,
		std::map< PMString, bool32 >	clashMap,
		std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy >	resolveMap,
		const StyleClashResolutionTypes::GlobalClashResolutionStrategy &	bLoadAllWithOverwrite
	)

pure virtual

LoadObjectStyles: Loads the styles from a cloud document

Parameters

ws	The workspace the object style name table containing the style
overrideLocal	True if the local styles with the same name are just overwritten
sourceFile	URI for cloud ID
importMap	Import styles.
clashMap	Styles that are conflict with existing styles.
resolveMap	Result styles after resolving the conflicts.
globalClashResolutionStrategy	IN: global clash resolution strategy.

virtual ErrorCode Facade::IObjectStylesFacade::MoveObjectStyles	(	IWorkspace *	ws,
		const K2Vector< PMString > &	selectedObjectStylesPaths,
		const int32 &	dropBefore,
		const UID	newParent,
		const RemappingList &	remaplist,
		const IStyleRemapData::ConflictFlagEnum	conflictFlag
	)

pure virtual

MoveObjectStyles: Moves the styles in the list to a new location before dropBefore

Parameters

ws	The workspace the object style name table containing the style
selectedObjectStylesName	The list of styles paths to be moved
dropBefore	The style to move before.
newParent	UID of the new parent.
RemappingList	remapping list in case of overwrite.
ConflictFlagEnum	what to do incase of conflict.

virtual ErrorCode Facade::IObjectStylesFacade::MoveObjectStyles	(	const UIDList &	selectedObjectStyles,
		const int32 &	dropBefore,
		const UID	newParent,
		const RemappingList &	remaplist,
		const IStyleRemapData::ConflictFlagEnum	conflictFlag
	)

pure virtual

MoveObjectStyles: Moves the styles in the list to a new location before dropBefore

Parameters

ws	The workspace the object style name table containing the style
selectedObjectStyles	The list of styles UIDs to be moved
dropBefore	The style to move before.
newParent	UID of the new parent.
RemappingList	remapping list in case of overwrite.
ConflictFlagEnum	what to do incase of conflict.

virtual ErrorCode Facade::IObjectStylesFacade::MoveStyleGroups	(	const UIDList &	styleGroups,
		const UID	newParent,
		const int32	position,
		const RemappingList &	remaplist,
		const IStyleRemapData::ConflictFlagEnum	conflictFlag
	)

pure virtual

Moves a list of style groups to new parent and position.

Parameters

styleGroups	[IN] list of style groups.
newParent	[IN] UID of the new parent.
position	[IN] new position.
remapList	[IN] remapping in case a style is being overwritten due to move.
conflictFlag	[IN] what to do incase of conflict.

virtual ErrorCode Facade::IObjectStylesFacade::RenameObjectStyle	(	IWorkspace *	ws,
		const UID	styleUID,
		const PMString &	newName,
		const bool16	bNotify = `kTrue`
	)

pure virtual

RenameObjectStyle: Renames the given object style

Parameters

ws	The workspace the object style name table containing the style
styleUID	The style to rename
newName	The new name of the style
bNotify	Flag indicates if we should do notify or not.

virtual ErrorCode Facade::IObjectStylesFacade::RenameObjectStyleGroup	(	IWorkspace *	ws,
		const UID	styleGroupUID,
		const PMString &	newName
	)

pure virtual

Renames a style group.

Parameters

ws	[IN] workspace
styleGroupUID	[IN] style group UID.
newName	[IN] new style group name.

virtual ErrorCode Facade::IObjectStylesFacade::ReplaceObjectStyles	(	IWorkspace *	ws,
		const K2Vector< PMString > &	stylesToBeReplaced,
		const PMString &	sourceStyleName
	)

pure virtual

ReplaceObjectStyles: Replaces the object styles in the stylesToBeReplaced list with the new style sourceStyleName

Parameters

ws	The workspace the object style name table containing the style
stylesToBeReplaced	The list of styles to be replaces
sourceStyleName	The name of the style to replace them with

virtual ErrorCode Facade::IObjectStylesFacade::SortObjectStyles ( IWorkspace * ws )

pure virtual

DeleteObjectStyles:Sorts the styles

Parameters

ws	The workspace the object style name table containing the styles to sort

Public Types

Public Member Functions

Member Function Documentation