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

#include <IStoryLabel.h>

Inheritance diagram for IStoryLabel:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISTORYLABEL }
 

Public Member Functions

virtual PMString GetLabel ()=0
 
virtual ErrorCode SetLabel (const PMString &label)=0
 
virtual void ReadWrite (IPMStream *s, ImplementationID prop)=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

This class is used to get/set a label (name) for a story so that we know which story we are working on

Member Function Documentation

virtual PMString IStoryLabel::GetLabel ()
pure virtual

Returns the name of the story so it can be differenciated from others.

Returns
- non-empty string containing the name of the story. The name of the story is one of the following (in this order):
  1. The label from the story metadata (XML data)
  2. The filename from the datalink
  3. "Untitled Story" + story list index (if more than one user accessible story)
virtual void IStoryLabel::ReadWrite (IPMStream * s,
ImplementationID prop 
)
pure virtual

General method for reading from or writing to a stream

Parameters
*s- The stream to use
prop- The implementation ID
virtual ErrorCode IStoryLabel::SetLabel (const PMString & label)
pure virtual

Set the label (name) of this story

Parameters
&label- New name to use for this story
Returns
- kSuccess if everything went OK