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

#include <ITextAttributeSuite.h>

Inheritance diagram for ITextAttributeSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTATTRIBUTE_ISUITE }
 
enum  FeatureState {
  kOff, kOn, kMixed, kUnavailable,
  kUninitialized
}
 
enum  CharStyleParam { kIgnoreCharacterStyles, kRemoveCharacterStyles }
 
enum  NextStyleParam { kApplySingleStyle, kAutoApplyNextStyle }
 
enum  StyleToAttrParam { kRemoveOldStyle, kMaintainOldStyleAttrs }
 

Public Member Functions

virtual int32 CountAttributes (ClassID attr)=0
 
virtual const IPMUnknownQueryAttributeN (int32 which, ClassID attr, PMIID interfaceID)=0
 
virtual ErrorCode ApplyAttributes (const AttributeBossList *applied, ClassID strandID)=0
 
virtual void CopyToAttributeLists (AttributeBossList *attrList, AttributeBossList *mixedList=nil)=0
 
virtual int32 CountParagraphStyles ()=0
 
virtual UID GetNthParagraphStyle (int32 n)=0
 
virtual int32 CountCharacterStyles ()=0
 
virtual UID GetNthCharacterStyle (int32 n)=0
 
virtual int32 CountRunInCharacterStyles ()=0
 
virtual UID GetNthRunInCharacterStyle (int32 n)=0
 
virtual bool16 IsStyleOverridden (UID style)=0
 
virtual int32 CountSelectedRuns ()=0
 
virtual int32 CountFonts (ClassID fontUIDBoss=kTextAttrFontUIDBoss)=0
 
virtual PMString GetNthFont (int32 n, bool16 *incorrectFace=nil, ClassID fontUIDBoss=kTextAttrFontUIDBoss, ClassID fontStyleBoss=kTextAttrFontStyleBoss)=0
 
virtual UID GetNthFamilyUIDAndFace (int32 n, PMString *faceName, ClassID fontUIDBoss=kTextAttrFontUIDBoss, ClassID fontStyleBoss=kTextAttrFontStyleBoss)=0
 
virtual const Fixed * GetNthMMAxes (int32 n, int32 *numaxes)=0
 
virtual bool16 CanApplyAttributes () const =0
 
virtual bool16 CanQueryAttributes () const =0
 
virtual ErrorCode ApplyAttribute (const IPMUnknown *attribute)=0
 
virtual ErrorCode ToggleBooleanAttribute (ClassID attributeClass)=0
 
virtual ErrorCode SetBooleanAttribute (ClassID attributeClass, bool16 theValue)=0
 
virtual FeatureState GetBooleanAttributeState (ClassID attributeClass)=0
 
virtual ErrorCode ToggleInt16Attribute (ClassID attributeClass, int16 onValue, int16 offValue)=0
 
virtual ErrorCode SetInt16Attribute (ClassID attributeClass, int16 theValue)=0
 
virtual FeatureState GetInt16AttributeState (ClassID attributeClass, int16 theValue)=0
 
virtual ErrorCode SetRealNumberAttribute (ClassID attributeClass, PMReal theValue)=0
 
virtual bool16 GetRealNumberAttributeValue (ClassID attributeClass, PMReal *pValue)=0
 
virtual ErrorCode ClearTypeStyleAttributes ()=0
 
virtual ErrorCode ToggleBold ()=0
 
virtual ErrorCode ToggleItalic ()=0
 
virtual ErrorCode ToggleBaselineGrid ()=0
 
virtual FeatureState GetBaselineGridState ()=0
 
virtual ErrorCode ToggleUnderline ()=0
 
virtual FeatureState GetUnderlineState ()=0
 
virtual ErrorCode ToggleCapsMode (IDrawingStyle::CapitalizeMode theMode)=0
 
virtual FeatureState GetCapsModeState (IDrawingStyle::CapitalizeMode theMode)=0
 
virtual ErrorCode TogglePositionMode (IDrawingStyle::PositionMode positionMode)=0
 
virtual FeatureState GetPositionModeState (IDrawingStyle::PositionMode positionMode)=0
 
virtual ErrorCode ToggleHyphenationMethod (IHyphenationStyle::HyphenationMethod hyphenationMethod)=0
 
virtual
ITextAttributeSuite::FeatureState 
GetHyphenationMethodState (IHyphenationStyle::HyphenationMethod hyphenationMethod)=0
 
virtual ErrorCode SetFigureStyle (ITextAttrFigureStyle::FigureStyle figureStyle)=0
 
virtual FeatureState GetFigureStyleState (ITextAttrFigureStyle::FigureStyle figureStyle)=0
 
virtual ErrorCode ToggleStylisticSet (int32 whichSet)=0
 
virtual FeatureState GetOTStylisticSetState (int32 whichSet)=0
 
virtual ErrorCode SetAlignment (ICompositionStyle::TextAlignment align)=0
 
virtual ErrorCode IncrementRealNumberAttribute (ClassID attributeClass, PMReal incrementAmt, const PMString &undoIncreaseString, const PMString &undoDecreaseString)=0
 
virtual ErrorCode IncrementPointSize (PMReal amount)=0
 
virtual ErrorCode IncrementLeading (PMReal amount)=0
 
virtual ErrorCode IncrementTracking (PMReal amount)=0
 
virtual ErrorCode IncrementBaselineShift (PMReal amount)=0
 
virtual ErrorCode IncrementWordSpace (PMReal amount)=0
 
virtual ErrorCode ApplyStyle (UID styleUID, bool16 clearOverrides=kFalse, CharStyleParam removeCharacterStyles=kIgnoreCharacterStyles, NextStyleParam autoNextStyle=kApplySingleStyle, StyleToAttrParam oldStyleAttrs=kMaintainOldStyleAttrs)=0
 
virtual ErrorCode ClearCharacterOverrides ()=0
 
virtual ErrorCode ClearParagraphOverrides ()=0
 
virtual ErrorCode ClearIndentOverrides ()=0
 
virtual bool16 CanClearIndentOverrides ()=0
 
virtual ErrorCode ClearAllOverrides ()=0
 
virtual ErrorCode SetCharAlignment (IDrawingStyle::CharacterHang theMode)=0
 
virtual FeatureState GetCharAlignmentState (IDrawingStyle::CharacterHang theMode)=0
 
virtual ErrorCode SetKinsokuType (IMojikumiStyle::KinsokuType theMode)=0
 
virtual FeatureState GetKinsokuTypeState (IMojikumiStyle::KinsokuType theMode)=0
 
virtual ErrorCode ToggleKinsokuHangType (IMojikumiStyle::KinsokuHangType theMode)=0
 
virtual FeatureState GetKinsokuHangTypeState (IMojikumiStyle::KinsokuHangType theMode)=0
 
virtual ErrorCode ToggleGridAlignmentMetric (Text::GridAlignmentMetric theMode)=0
 
virtual FeatureState GetGridAlignmentMetricState (Text::GridAlignmentMetric theMode)=0
 
virtual ErrorCode SetLeadingModel (Text::LeadingModel theMode)=0
 
virtual FeatureState GetLeadingModelState (Text::LeadingModel theMode)=0
 
virtual bool16 CanRemoveFormatting () const =0
 
virtual ErrorCode RemoveFormatting ()=0
 
virtual bool16 AdjacentParagraphsSelected () const =0
 
virtual bool16 ContainsParagraphStyleOverrides () const =0
 
virtual bool16 SelectedParagraphsIncludeOverrides () const =0
 
virtual bool16 SelectedParagraphsIncludeCharStyles () const =0
 
virtual bool16 CheckSelectionForRuby ()=0
 
virtual ErrorCode SetRubyNone ()=0
 
virtual ErrorCode AdjustSelectionForBoolAttribute (ITextSelectionSuite *textSelectionSuite, ClassID attrClass)=0
 
virtual ErrorCode SynchRubyAttrToRubyStrand ()=0
 
virtual bool16 FillStringListWithOverrides (K2Vector< PMString > &overrideStrings, bool16 useParaStyle) const =0
 
virtual ErrorCode SetPositionalForm (IDrawingStyle::OTPositioningForm form)=0
 
virtual FeatureState CheckPositionalForm (IDrawingStyle::OTPositioningForm check) const =0
 
virtual ErrorCode ChangeParagraphDirection (ICompositionStyle::ParagraphDirection paraDir)=0
 
virtual ErrorCode ApplyAttributes (const AttributeBossList *applied, ClassID strandID, ICommand::Undoability undoabilityFlag)=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

This interface is implemented by the abstract selection boss and by the concrete selection bosses for text and tables. It will be called from a replacement for TextFocusTarget.

Member Function Documentation

virtual ErrorCode ITextAttributeSuite::ApplyStyle (UID styleUID,
bool16 clearOverrides = kFalse,
CharStyleParam removeCharacterStyles = kIgnoreCharacterStyles,
NextStyleParam autoNextStyle = kApplySingleStyle,
StyleToAttrParam oldStyleAttrs = kMaintainOldStyleAttrs 
)
pure virtual
Parameters
oldStyleAttrsIN whether to apply the old style as overrides before setting new style. This variable is only used if styleUID is the root style.