InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IWritingStoryList Class Referenceabstract

#include <IWritingStoryList.h>

Inheritance diagram for IWritingStoryList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IWRITINGSTORYLIST }
 

Public Member Functions

virtual void GetStoryList (IDocument *doc, UIDList &stories) 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
 

Detailed Description

IWritingStoryList (on kWritingModeWidgetBoss) a simple interface that will give a list of the stories displayed in a story or galley view panel. Note this is not used in the current internal code and there are other ways of getting this information. The most common and recommended method would be to get an ITextLines interface and ask it for the list of stories via the GetStoryRefList() method. The IWritingStoryList interface should be equivalent but it goes through a different mechanism to get the information.

Member Function Documentation

virtual void IWritingStoryList::GetStoryList (IDocument * doc,
UIDList & stories 
) const
pure virtual

Get a list of stories displayed in the story/galley window

Parameters
doc- document this panel belongs to. Can get from IDocRef
stories- list of stories displayed in the window is returned in this paramater
Returns
none