IGalleySwitch Class Reference

#include <IGalleySwitch.h>

Inheritance diagram for IGalleySwitch:

Public Types
enum	{ kDefaultIID = IID_IGALLEYSWITCH }
enum	{ kInvalidUniqueID = 0 }

Public Member Functions
virtual ErrorCode	OpenNewGalleyWindow (const UIDList &stories)=0
virtual bool	IsInGalley ()=0
virtual void	SetGalleyStoryIndex (int32 index)=0
virtual int32	GetGalleyStoryIndex ()=0
virtual UIDRef	GetCurrentStoryRef ()=0
virtual IControlView *	GetGalleyView ()=0
virtual uint32	GetUniqueSessionID ()=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

Don't recommend using this interface now. IGalleyUtils provides everything available in this interface and more. Some of this plain won't work in this interface

Member Enumeration Documentation

anonymous enum

Used as a invalid id number in ILayoutViewLineData

Member Function Documentation

virtual UIDRef IGalleySwitch::GetCurrentStoryRef ( )

pure virtual

Obsolete don't use.

Returns

current active story index

virtual int32 IGalleySwitch::GetGalleyStoryIndex ( )

pure virtual

Obsolete don't use.

Returns

-1

virtual IControlView* IGalleySwitch::GetGalleyView ( )

pure virtual

Best to use Galley Utils now.

Returns

control view of galley or story view for the front window

virtual uint32 IGalleySwitch::GetUniqueSessionID ( )

pure virtual

Just a unique number everytime you ask. Simply increments a number

Returns

id

virtual bool IGalleySwitch::IsInGalley ( )

pure virtual

Obsolete don't use.

Returns

kFalse

virtual ErrorCode IGalleySwitch::OpenNewGalleyWindow ( const UIDList &  stories )

pure virtual

Obsolete don't use.

Parameters

stories

- don't use

Returns

don't use

virtual void IGalleySwitch::SetGalleyStoryIndex ( int32  index )

pure virtual

Obsolete don't use.

Parameters

index

- dont use

Returns

none