Inheritance diagram for Facade::IAppearanceItemFacade:

Public Types
enum	{ kDefaultIID = IID_IAPPEARANCEITEMFACADE }

enum	CopyItemsFlag { kCopyItems = kTrue, kDoNotCopyItems = kFalse }

enum	{ kInvalidIndex = -1 }

Public Member Functions
virtual ErrorCode	CreateAppearanceItem (const UIDList &inItems, const ClassID &inAppearanceItemClass, UIDList *outAppearanceItems=nil) const =0

virtual ErrorCode	CreateNewState (const UIDList &inItems, Form::AppearanceState inState, int32 inPosition=IAppearanceList::kLastInOrder, CopyItemsFlag inCopyItems=kCopyItems, INewStateCmdData::NamePolicy inNamePolicy=INewStateCmdData::kUseDefaultName, const PMString *inNameString=nil) const =0

virtual ErrorCode	MoveState (const UIDList &inAppearanceItems, Form::AppearanceState inState, int32 inPosition) const =0

virtual ErrorCode	DeleteState (const UIDList &inAppearanceItems, Form::AppearanceState inState) const =0

virtual ErrorCode	DeleteAppearance (const UIDList &inAppearanceItems, Form::AppearanceState inState) const =0

virtual ErrorCode	SetActiveState (const UIDList &inAppearanceItems, Form::AppearanceState inState) const =0

virtual ErrorCode	AddItemsToAppearance (const UIDRef &inAppearanceItem, const UIDList &inItemsToAdd, Form::AppearanceState inState) const =0

virtual ErrorCode	AddItemsAsState (const UIDRef &inAppearanceItem, const UIDList &inItemsToAdd, Form::AppearanceState inState) const =0

virtual ErrorCode	AddItemsAsStates (const UIDRef &inAppearanceItem, const UIDList &inItemsToAdd) const =0

virtual ErrorCode	ReleaseAppearanceAsObject (const UIDList &inAppearanceItems, Form::AppearanceState inState) const =0

virtual ErrorCode	ReleaseAllAppearancesAsObjects (const UIDList &inAppearanceItems) const =0

virtual Form::AppearanceState	GetActiveState (const UIDRef &inAppearanceItem) const =0

virtual Form::AppearanceState	GetNthState (const UIDRef &inAppearanceItem, int32 inStateIndex) const =0

virtual Form::AppearanceState	GetNextAvailableState (const UIDRef &inAppearanceItem) const =0

virtual ErrorCode	SetStateName (const UIDRef &inAppearanceItem, Form::AppearanceState inState, const PMString &inName) const =0

virtual PMString	GetStateName (const UIDRef &inAppearanceItem, Form::AppearanceState inState) const =0

virtual int32	GetNumStates (const UIDRef &inAppearanceItem) const =0

virtual int32	GetStatePosition (const UIDRef &inAppearanceItem, Form::AppearanceState inState) const =0

virtual bool16	HasState (const UIDRef &inAppearanceItem, Form::AppearanceState inState) const =0

virtual bool16	CanAddState (const UIDRef &inAppearanceItem, Form::AppearanceState inState) const =0

virtual ErrorCode	PasteIntoState (const UIDRef &inAppearanceItem, Form::AppearanceState inState, UIDList *outPastedItems=nil) const =0

virtual bool16	GetIsInitiallyHidden (const UIDRef &inItem) const =0

virtual ErrorCode	SetIsInitiallyHidden (const UIDRef &inItem, bool16 inHidden) const =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::IAppearanceItemFacade::AddItemsAsState	(	const UIDRef &	inAppearanceItem,
		const UIDList &	inItemsToAdd,
		Form::AppearanceState	inState
	)		const

pure virtual

Create a new state on an appearance item, and add page items to that state's appearance.

Parameters

inAppearanceItem	the appearance item to which a state is being added
inItemsToAdd	the page items to add to the state's appearance
inState	the new state to be created

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::AddItemsAsStates	(	const UIDRef &	inAppearanceItem,
		const UIDList &	inItemsToAdd
	)		const

pure virtual

Add page items to new states on an appearance item. Each page item in inItemsToAdd will be placed into its own new state on inAppearanceItem.

Parameters

inAppearanceItem	the appearance item to which a states are being added
inItemsToAdd	the page items to add as states

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::AddItemsToAppearance	(	const UIDRef &	inAppearanceItem,
		const UIDList &	inItemsToAdd,
		Form::AppearanceState	inState
	)		const

pure virtual

Move a state to a new position in the state ordering on its parent page item. Can be used on multiple page items, simultaneously.

Parameters

inAppearanceItems	the page items whose states to move
inState	the state to move
inPosition	the new position for the state

Returns: ErrorCode

virtual bool16 Facade::IAppearanceItemFacade::CanAddState	(	const UIDRef &	inAppearanceItem,
		Form::AppearanceState	inState
	)		const

pure virtual

Determines if a state is both supported and not already created.

Parameters

inAppearanceItem	the appearance item in question
inState	the state in question

Returns: whether inState can be added to inAppearanceItem

virtual ErrorCode Facade::IAppearanceItemFacade::CreateAppearanceItem	(	const UIDList &	inItems,
		const ClassID &	inAppearanceItemClass,
		UIDList *	outAppearanceItems = `nil`
	)		const

pure virtual

Creates a new appearance item of the specified class. Appearance items are created from already-existing page items. The page items that are passed into this method are used to define the how states of the appearance item look. If inAppearanceItemClass is kPushButtonItemBoss, then each of the items created will be individual buttons; if kMultiStateObjectItemBoss, then each of the items will be used to create individual states of a single Multi-State Object.

Parameters

inItems	the page items to use to create the appearance item(s)
inAppearanceItemClass	the class of the desired page item: either kMultiStateObjectItemBoss or kPushButtonItemBoss.
outAppearanceItem	a UIDList of the items that were created

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::CreateNewState	(	const UIDList &	inItems,
		Form::AppearanceState	inState,
		int32	inPosition = `IAppearanceList::kLastInOrder`,
		CopyItemsFlag	inCopyItems = `kCopyItems`,
		INewStateCmdData::NamePolicy	inNamePolicy = `INewStateCmdData::kUseDefaultName`,
		const PMString *	inNameString = `nil`
	)		const

pure virtual

Creates a new state on a page item that supports states.

Parameters

inItems	the item(s) to create the new state on
inState	the AppearanceState to create on the items
inPosition	the position in the ordering of states to create the state at
inCopyItems	whether to page items into the new state. for buttons, these come from the normal state. for multi-state objects, these come from the active state
inNamePolicy	the policy to use for assigning a name to the state
inNameString	if inNamePolicy is set to kBaseNameOnString, then this parameter is used as the string to base the name on

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::DeleteAppearance	(	const UIDList &	inAppearanceItems,
		Form::AppearanceState	inState
	)		const

pure virtual

Deletes a contents of a state on one or more page items.

Parameters

inAppearanceItems	the page items whose states to delete
inState	the state to delete on the items

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::DeleteState	(	const UIDList &	inAppearanceItems,
		Form::AppearanceState	inState
	)		const

pure virtual

Deletes a state on one or more page items.

Parameters

inAppearanceItems	the page items whose states to delete
inState	the state to delete on the items

Returns: ErrorCode

virtual Form::AppearanceState Facade::IAppearanceItemFacade::GetActiveState ( const UIDRef & inAppearanceItem ) const

pure virtual

Gets the currently active state of the appearance item.

Parameters

inAppearanceItem the appearance item in question

Returns: the active state of inAppearanceItem

virtual bool16 Facade::IAppearanceItemFacade::GetIsInitiallyHidden ( const UIDRef & inItem ) const

pure virtual

Gets whether a appearance item is hidden when exported to SWF/PDF.

Parameters

inItem the appearance item

Returns: whether this item is hidden when exported to SWF

virtual Form::AppearanceState Facade::IAppearanceItemFacade::GetNextAvailableState ( const UIDRef & inAppearanceItem ) const

pure virtual

Gets next valid state that can be added to the page item.

Parameters

inAppearanceItem the appearance item in question

Returns: if one the appearance item has valid states available, then the next valid state; otherwise kStateInvalid

virtual Form::AppearanceState Facade::IAppearanceItemFacade::GetNthState	(	const UIDRef &	inAppearanceItem,
		int32	inStateIndex
	)		const

pure virtual

Gets the nth state of the appearance item.

Parameters

inAppearanceItem	the appearance item in question
inStateIndex	the index of the state to be retrieved

Returns: the nth state of inAppearanceItem

virtual int32 Facade::IAppearanceItemFacade::GetNumStates ( const UIDRef & inAppearanceItem ) const

pure virtual

Gets the number of states that an appearance item has.

Parameters

inAppearanceItem the appearance item in question

Returns: the number of states that inAppearanceItem has

virtual PMString Facade::IAppearanceItemFacade::GetStateName	(	const UIDRef &	inAppearanceItem,
		Form::AppearanceState	inState
	)		const

pure virtual

Gets the name of a state on an appearance item.

Parameters

inAppearanceItem	the appearance item that owns the state
inState	the state whose name to get

Returns: the name of the state, if it exists; otherwise an empty string

virtual int32 Facade::IAppearanceItemFacade::GetStatePosition	(	const UIDRef &	inAppearanceItem,
		Form::AppearanceState	inState
	)		const

pure virtual

Gets the the position of a state in an appearance item's state ordering.

Parameters

inAppearanceItem	the appearance item in question
inState	the state whose position to get

Returns: the index of the state in the state ordering, or kInvalidIndex

virtual bool16 Facade::IAppearanceItemFacade::HasState	(	const UIDRef &	inAppearanceItem,
		Form::AppearanceState	inState
	)		const

pure virtual

Determines if an appearance item has a specific state defined.

Parameters

inAppearanceItem	the appearance item in question
inState	the state in question

Returns: whether inAppearanceItem has a state identified by inState

virtual ErrorCode Facade::IAppearanceItemFacade::MoveState	(	const UIDList &	inAppearanceItems,
		Form::AppearanceState	inState,
		int32	inPosition
	)		const

pure virtual

Move a state to a new position in the state ordering on its parent page item. Can be used on multiple page items, simultaneously.

Parameters

inAppearanceItems	the page items whose states to move
inState	the state to move
inPosition	the new position for the state

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::PasteIntoState	(	const UIDRef &	inAppearanceItem,
		Form::AppearanceState	inState,
		UIDList *	outPastedItems = `nil`
	)		const

pure virtual

Paste the currently copied item(s) into the specified state of the specified appearance item

Parameters

inAppearanceItem	the appearance item to paste into
inState	the state to paste into
outPastedItems	an optional list to fill with the UIDs of the newly pasted items

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::ReleaseAllAppearancesAsObjects ( const UIDList & inAppearanceItems ) const

pure virtual

Deletes the appearance item and places all of the objects that made up the appearances of that item's states onto the spread.

Parameters

inAppearanceItem	the appearance item whose state is to be released
inState	the state to release to the spread

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::ReleaseAppearanceAsObject	(	const UIDList &	inAppearanceItems,
		Form::AppearanceState	inState
	)		const

pure virtual

Deletes a state and places the objects that made up that state's appearance onto the spread.

Parameters

inAppearanceItem	the appearance item whose state is to be released
inState	the state to release to the spread

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::SetActiveState	(	const UIDList &	inAppearanceItems,
		Form::AppearanceState	inState
	)		const

pure virtual

Changes the active state of one or more appearance items.

Parameters

inAppearanceItems	the appearance items to change
inState	the new state to set as active

Returns: ErrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::SetIsInitiallyHidden	(	const UIDRef &	inItem,
		bool16	inHidden
	)		const

pure virtual

Sets whether an appearance item is hidden when exported to SWF/PDF.

Parameters

inItem	the appearance item
inHidden	whether or not this object should be hidden

Returns: ErrrorCode

virtual ErrorCode Facade::IAppearanceItemFacade::SetStateName	(	const UIDRef &	inAppearanceItem,
		Form::AppearanceState	inState,
		const PMString &	inName
	)		const

pure virtual

Sets the name of a state on an appearance item.

Parameters

inAppearanceItem	the appearance item that owns the state
inState	the state whose name to modify
inName	the new name for the state

Returns: ErrorCode

Public Types

Public Member Functions

Member Function Documentation