IStyleGroupManager Class Reference

#include <IStyleGroupManager.h>

Inheritance diagram for IStyleGroupManager:

Public Types
enum	StyleNameMatch { kUniqueName, kExactNameMatch, kStartofNameMatchesStyle, kNameMatchesStyleGroup }

Public Member Functions
virtual IStyleGroupHierarchy *	GetRootHierarchy () const =0
virtual UID	GetDefaultStyleUID () const =0
virtual UID	SetDefaultStyleUID (UID d)=0
virtual UID	GetRootStyleUID () const =0
virtual UID	FindByName (const PMString &stylePath, StyleNameMatch *matchInfo=nil) const =0
virtual UID	FindByName (UID parent, const PMString &name) const =0
virtual bool16	IsBasedOn (UID self, UID other) const =0
virtual void	Move (UID childToMove, UID newParent, int32 pos)=0
virtual void	Remove (UID childToRemove)=0
virtual bool16	IsHierarchyMember (UID id) const =0
virtual void	SetDefaultTextStyleUID (UID d)=0
virtual UID	GetDefaultTextStyleUID () const =0
virtual void	SetDefaultFrameGridStyleUID (UID d)=0
virtual UID	GetDefaultFrameGridStyleUID () const =0
virtual UID	SetRootStyleUID (UID id)=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

The IStyleGroupManager is the access point for style set management. It gives access to the root IStyleGroupHierarchy from where you can get the full style set hierarchy.

Member Enumeration Documentation

enum IStyleGroupManager::StyleNameMatch

What kind of style match was found

Enumerator
kUniqueName	Name is unique
kExactNameMatch	Name exactly matches existing name
kStartofNameMatchesStyle	Name match start of style group. For example. aa exists as a style name and stylePath is aa:newname. UID of matched style is returned
kNameMatchesStyleGroup	Name match style group. For example. aa exists as a group and stylePath is aa. UID of matched group is returned

Member Function Documentation

virtual UID IStyleGroupManager::FindByName ( const PMString &  stylePath, StyleNameMatch *  matchInfo = nil  ) const

pure virtual

Returns a UID whose path matches the passed path. The list may contain style sets as well as styles.

Parameters

stylePath	[IN] name to find.
matchInfo	[OUT] how found.

Returns

kInvalidUID if no match found, else UID of the found style.

virtual UID IStyleGroupManager::FindByName ( UID  parent, const PMString &  name  ) const

pure virtual

Returns the UID of the style whose name matches the passed name with in the specified paren.

Parameters

parent	[IN] style set node which will be searched for the style.
name	[IN] name to search for.

Returns

kInvalidUID if the style or style set is not found.

virtual UID IStyleGroupManager::GetDefaultFrameGridStyleUID ( ) const

pure virtual

USED ONLY BY OBJECT STYLES CURRENTLY Gets the Default Frame Grid Style for this name table

virtual UID IStyleGroupManager::GetDefaultStyleUID ( ) const

pure virtual

Returns the default Style UID for this style set hierarchy.

virtual UID IStyleGroupManager::GetDefaultTextStyleUID ( ) const

pure virtual

USED ONLY BY OBJECT STYLES CURRENTLY Gets the Default Text Style for this name table

virtual IStyleGroupHierarchy* IStyleGroupManager::GetRootHierarchy ( ) const

pure virtual

Returns the root hierarchy managed by this Manager.

virtual UID IStyleGroupManager::GetRootStyleUID ( ) const

pure virtual

Returns the root style UID for this style set hierarchy. All the styles are based on this style.

virtual bool16 IStyleGroupManager::IsBasedOn ( UID  self, UID  other  ) const

pure virtual

Is the selfUID object based on the otherUID parameter? This can be through any levels of hierarchy. This relies on the IStyleInfo interface.

Parameters

self	[IN] self UID
other	[in] other UID

Returns

kTrue if the self UID is based on other UID, kFalse otherwise.

virtual bool16 IStyleGroupManager::IsHierarchyMember ( UID  id ) const

pure virtual

Returns kTrue if the object specified by id a member of the hierarchy managed by this Manager.

Parameters

id	[IN] objects UID.

Returns

kTrue if the id belongs to the hierarchy managed by this.

virtual void IStyleGroupManager::Move ( UID  childToMove, UID  newParent, int32  pos  )

pure virtual

Move the child to a new parent before specific index.

Parameters

childToMove	[in] child to move.
newParent	[IN] new parent of the child.
pos	[IN] index position before which this child will be moved in to new parent. put IStyleGroupHierarchy::kAtTheEnd to move as last child.

virtual void IStyleGroupManager::Remove ( UID  childToRemove )

pure virtual

Remove this child from this hierarchy from deep with in this hierarchy

Parameters

childToRemove

[IN] child to remove.

virtual void IStyleGroupManager::SetDefaultFrameGridStyleUID ( UID  d )

pure virtual

USED ONLY BY OBJECT STYLES CURRENTLY Sets the Default Frame Grid Style for this name table

virtual UID IStyleGroupManager::SetDefaultStyleUID ( UID  d )

pure virtual

Sets the default style UID for this style set hierarchy.

Parameters

d	[IN] the default style uid to set.

virtual void IStyleGroupManager::SetDefaultTextStyleUID ( UID  d )

pure virtual

USED ONLY BY OBJECT STYLES CURRENTLY Sets the Default Text Style for this name table

virtual UID IStyleGroupManager::SetRootStyleUID ( UID  id )

pure virtual

PRIVATE USE ONLY, DO NOT CALL THIS. this is needed for document conversion.