hdi::core::TextStorySet Class Reference

Public Types
typedef std::vector< std::shared_ptr< TextPara > >	TextParaVector
typedef std::vector< std::shared_ptr< TextRange > >	TextRangeVector
typedef std::vector< std::shared_ptr< TextWord > >	TextWordVector

Public Member Functions
	TextStorySet ()
	Creates a new TextStorySet object.
	TextStorySet (const TextStorySet &ss_)
	TextStorySet copy constructor.
virtual	~TextStorySet ()
	Destructs a TextStorySet object.
virtual TextStorySet &	operator= (const TextStorySet &rhs_)
	Overloaded assignment operator for TextStorySet objects.
virtual bool	operator== (const TextStorySet &rhs_) const
	Tests whether a given TextStorySet object is the same as another.
virtual bool	operator!= (const TextStorySet &rhs_) const
	Tests whether a given TextStorySet object is not the same as another.
virtual std::unique_ptr< ATE::IStories >	ateStorySet () const
	Gets the ATE story set ref around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target TextStorySet object is empty.
virtual int32_t	size () const
	Retrieves the number of members of this set.
virtual bool	hasFocus () const
	Reports whether a member story has the input focus.
virtual std::unique_ptr< TextStory >	focusedStory () const
	Retrieves the member story that has input focus.
virtual void	setFocusedStory (const TextStory &story_)
	Sets the input focus to a member story, deselecting everything in the document.
virtual void	loseFocus ()
	Removes input focus from the story currently being edited, deselecting everything in the document.
virtual std::unique_ptr< TextRangeSet >	textRanges () const
	Retrieves the set of text ranges in these stories.
virtual std::unique_ptr< TextRangeSet >	selections () const
	Retrieves the set of text ranges for selected text in these stories.
virtual TextParaVector	paragraphs () const
	Retrieves a vector of paragraphs contained by the member stories.
virtual TextWordVector	words () const
	Retrieves a vector of words contained by the member stories.
virtual TextRangeVector	runs () const
	Retrieves a vector of runs (ranges) contained by the member stories.
virtual std::unique_ptr< TextStory >	story (const int32_t index_) const
	Retrieves a member of this set by position index.
virtual void	suspendReflow ()
	Suspends reflow calculation for the target stories. Speeds up calls that cause reflow, such as TextRange insertion methods.
virtual void	resumeReflow ()
	Resumes normal reflow calculation after a call to suspendReflow()

Friends
aip::TextStorySet *	__accessImpl (const TextStorySet &)
TextStorySet	__accessCtor (const aip::TextStorySet &)

Constructor & Destructor Documentation

TextStorySet() [1/2]

hdi::core::TextStorySet::TextStorySet

(

)

Creates a new TextStorySet object.

Author

GW

Date

08/2014

Note

New TextStorySet objects do not relate to any text story set on the Illustrator artboard; they are designed to be "receivers" of some other TextStorySet object via the overloaded assignment operator or assigned to some other existent text art.

TextStorySet() [2/2]

hdi::core::TextStorySet::TextStorySet

(

const TextStorySet &

ss_

)

TextStorySet copy constructor.

Author

GW

Date

08/2014

Parameters

ss_	TextStorySet object to copy values from

~TextStorySet()

virtual hdi::core::TextStorySet::~TextStorySet ( )

virtual

Destructs a TextStorySet object.

Author

GW

Date

08/2014

Member Function Documentation

ateStorySet()

virtual std::unique_ptr< ATE::IStories > hdi::core::TextStorySet::ateStorySet ( ) const

virtual

Gets the ATE story set ref around which the target object is wrapped.

Author

GW

Date

08/2014

Returns

ATE::IStoriesRef for the target object

Note

Generally, you shouldn't need to call this method. Only use it if you know what you're doing. If a specific piece of functionality provided by Illustrator is not handled by this class (or related classes), then it should probably be added to the hdi_core library.

focusedStory()

virtual std::unique_ptr< TextStory > hdi::core::TextStorySet::focusedStory ( ) const

virtual

Retrieves the member story that has input focus.

Author

GW

Date

08/2014

Returns

The story currently being edited, or a NULL object if no text is being edited

hasFocus()

virtual bool hdi::core::TextStorySet::hasFocus ( ) const

virtual

Reports whether a member story has the input focus.

Author

GW

Date

08/2014

Returns

true if a story in this collection is currently being edited

Note

Only one story can have the focus. It can lose focus if the user selects text outside it, or clicks outside the text of the story.

isEmpty()

virtual bool hdi::core::TextStorySet::isEmpty ( ) const

virtual

Gets whether the target TextStorySet object is empty.

Author

GW

Date

08/2014

Returns

true if the target TextStorySet object is empty, false otherwise

loseFocus()

virtual void hdi::core::TextStorySet::loseFocus ( )

virtual

Removes input focus from the story currently being edited, deselecting everything in the document.

Author

GW

Date

08/2014

operator!=()

virtual bool hdi::core::TextStorySet::operator!= ( const TextStorySet &  rhs_ ) const

virtual

Tests whether a given TextStorySet object is not the same as another.

Author

GW

Date

08/2014

Parameters

rhs_	TextStorySet to compare against (righthand side of inequality operator)

Returns

true for the target and rhs_ being different text story sets, false otherwise

operator=()

virtual TextStorySet & hdi::core::TextStorySet::operator= ( const TextStorySet &  rhs_ )

virtual

Overloaded assignment operator for TextStorySet objects.

Author

GW

Date

08/2014

operator==()

virtual bool hdi::core::TextStorySet::operator== ( const TextStorySet &  rhs_ ) const

virtual

Tests whether a given TextStorySet object is the same as another.

Author

GW

Date

08/2014

Parameters

rhs_	TextStorySet to compare against (righthand side of equality operator)

Returns

true for the target and rhs_ being the same text story set, false otherwise

paragraphs()

virtual TextParaVector hdi::core::TextStorySet::paragraphs ( ) const

virtual

Retrieves a vector of paragraphs contained by the member stories.

Author

GW

Date

08/2014

Returns

The paragraph vector object

resumeReflow()

virtual void hdi::core::TextStorySet::resumeReflow ( )

virtual

Resumes normal reflow calculation after a call to suspendReflow()

Author

GW

Date

08/2014

runs()

virtual TextRangeVector hdi::core::TextStorySet::runs ( ) const

virtual

Retrieves a vector of runs (ranges) contained by the member stories.

Author

GW

Date

08/2014

Returns

The ranges vector object

selections()

virtual std::unique_ptr< TextRangeSet > hdi::core::TextStorySet::selections ( ) const

virtual

Retrieves the set of text ranges for selected text in these stories.

Author

GW

Date

08/2014

Returns

The text range set object

setFocusedStory()

virtual void hdi::core::TextStorySet::setFocusedStory ( const TextStory &  story_ )

virtual

Sets the input focus to a member story, deselecting everything in the document.

Author

GW

Date

08/2014

Parameters

story_

Story to focus

size()

virtual int32_t hdi::core::TextStorySet::size ( ) const

virtual

Retrieves the number of members of this set.

Author

GW

Date

08/2014

Returns

The number of members, or -1 for error

story()

virtual std::unique_ptr< TextStory > hdi::core::TextStorySet::story ( const int32_t  index_ ) const

virtual

Retrieves a member of this set by position index.

Author

GW

Date

08/2014

Parameters

index_

The 0-based position index

Returns

The member story, or NULL for error

suspendReflow()

virtual void hdi::core::TextStorySet::suspendReflow ( )

virtual

Suspends reflow calculation for the target stories. Speeds up calls that cause reflow, such as TextRange insertion methods.

Author

GW

Date

08/2014

Note

Use resumeReflow() to restore normal reflow calculation

textRanges()

virtual std::unique_ptr< TextRangeSet > hdi::core::TextStorySet::textRanges ( ) const

virtual

Retrieves the set of text ranges in these stories.

Author

GW

Date

08/2014

Returns

The text range set object

words()

virtual TextWordVector hdi::core::TextStorySet::words ( ) const

virtual

Retrieves a vector of words contained by the member stories.

Author

GW

Date

08/2014

Returns

The words vector object