InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextOnPathSelectionSuite Class Referenceabstract

#include <ITextOnPathSelectionSuite.h>

Inheritance diagram for ITextOnPathSelectionSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTONPATHSELECTIONSUITE }
 

Public Member Functions

virtual void SetOptionValues (EffectType typeEffect, TextAlignType textAlign, PathAlignType pathAlign, int16 overlapOffset, int16 flip)=0
 
virtual void GetOptionValues (EffectType &typeEffect, TextAlignType &textAlign, PathAlignType &pathAlign, int16 &overlapOffset, int16 &flip, int16 &verticality)=0
 
virtual bool16 CanModifyTextOnPathOptions () const =0
 
virtual bool16 CanDeleteTextOnPath () const =0
 
virtual ErrorCode DeleteTextOnPath ()=0
 
virtual void FreezeSelectionForModalDialog ()=0
 
virtual void ThawSelectionForModalDialog ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Provides access through a selection to the Text on a Path settings

Author
Bryce Morsello

Member Function Documentation

virtual bool16 ITextOnPathSelectionSuite::CanDeleteTextOnPath () const
pure virtual

Identifies whether all Text on Path can be removed from all objects in the selection

Returns
kTrue if all objects can have Text on Path removed from them
virtual bool16 ITextOnPathSelectionSuite::CanModifyTextOnPathOptions () const
pure virtual

Identifies whether the Text on Path can be configured

Returns
kTrue if SetOptionValues can be executed
virtual ErrorCode ITextOnPathSelectionSuite::DeleteTextOnPath ()
pure virtual

Remove Text on Path from all objects in the selection

virtual void ITextOnPathSelectionSuite::FreezeSelectionForModalDialog ()
pure virtual
 FreezeSelectionForModalDialog is used to freeze the selection when a modal dialog is about to be invoked.

This allows the modal dialog to operate on the same items regardless of how the changes affect the selection over time. (For example, if you have a caret and increase the columns, such that the caret moves to the next frame, the dialog will still operate on the original text frame). THIS CALL MUST BE PAIRED WITH A CALL TO ThawSelectionForModalDialog()

virtual void ITextOnPathSelectionSuite::SetOptionValues (EffectType typeEffect,
TextAlignType textAlign,
PathAlignType pathAlign,
int16 overlapOffset,
int16 flip 
)
pure virtual

Retrieves the configured Text on Path parameters for the object(s) in a given selection

Parameters
typeEffectIN the algorithm used to place glyphs on a spline, from TOPOptionsType.h
textAlignIN the line on the glyph to which the characters are aligned
pathAlignIN the top, center, or bottom edge of the spline to which to align the characters
overlapOffsetIN the distance, in points, by which a ghost spline is projected from the actual spline for the purpose of changing the spacing
flipIN whether the characters are placed upside-down and backwards along the spline: constants in TOPOptionsData.h
verticality-1 for a mixed selection, 1 for vertical, 0 for horizontal only
virtual void ITextOnPathSelectionSuite::ThawSelectionForModalDialog ()
pure virtual
 ThawSelectionForModalDialog is used to thaw the selection when a modal dialog has been closed.

see FreezeSelectionForModalDialog for more details. THIS CALL MUST BE PAIRED WITH A CALL TO FreezeSelectionForModalDialog()