#include <IStoryManager.h>
|
| enum | { kDefaultIID = IID_ISTORYMANAGER } |
| |
Provides multiple story management of TextLines data for story/galley views.
- Author
- Kevin Van Wiel
- See Also
- ITextLines, ITextRuns
| virtual void IStoryManager::AddToUncomposedRange | ( | int32 | storyIndex, | | | int32 | composeID, | | | int32 | lineIndexHint = -1 | | ) | | |
| pure virtual |
All text in story or galley view is not necessary composed to a window bounds at a given moment if it is composed the range of the composed text is stored. If text is not composed this routine is used to track the non-composed range. Normally this is only used internally.
- Parameters
| storyIndex | Is the index of the story to mark the range in. |
| start | start text index of range to mark composed |
| length | length of range to add to the start text index |
| virtual bool16 IStoryManager::ComposeUncomposed | ( | int32 | storyIndex, | | | IdleTimer * | timeCheck | | ) | | |
| pure virtual |
Compose a section of psuedo lines.
- Parameters
| storyIndex | to start composing at. |
| timeCheck | determines the maximum of time that the routine will compose until it quits. |
| virtual bool16 IStoryManager::DeleteStory | ( | UID | storyUID | ) | |
| pure virtual |
Delete a story from the view. Returns true if the story was removed.
- Parameters
| storyUID | IN uid of the story (textmodel uid) to remove from the view |
- Returns
- kTrue if successful in deleted story from the view.
| virtual int32 IStoryManager::GetOversetLineIndex | ( | int32 | storyIndex | ) | |
| pure virtual |
Get the line that overset text starts on.
- Parameters
| storyIndex | Is the index of the story to set the index in. |
| lineIndex | index of the line to mark as story of overset. |
| virtual void IStoryManager::RemoveFromUncomposedRange | ( | int32 | storyIndex, | | | int32 | composeID | | ) | | |
| pure virtual |
All text in story or galley view is not necessary composed to a window bounds at a given moment if it is composed the range of the composed text is stored. If more text is composed the composed range is added to here. Note simply adding a range to the composed range doesn't actually cause it to be composed rather this method is called when text has been composed. Normally this is only used internally
- Parameters
| storyIndex | Is the index of the story to mark the range in. |
| start | start text index of range to mark composed |
| length | length of range to add to the start text index |
| virtual void IStoryManager::SetOversetLineIndex | ( | int32 | storyIndex, | | | int32 | lineIndex | | ) | | |
| pure virtual |
Set where an overset divider line is placed in the story view. Used as reference to refind this line quickly. once the index is set it is kept current when lines are deleted or inserted. Internal use only
- Parameters
| storyIndex | Is the index of the story to set the index in. |
| lineIndex | index of the line to mark as story of overset. |
| virtual void IStoryManager::SetStoryDisplayOrder | ( | const UIDList & | storiesInDisplayOrder, | | | bool16 | redraw = kTrue | | ) | | |
| pure virtual |
Should not call this directly normally. The general way this is called is by processing a kReorderStoriesCmdBoss which will trigger a call to this method for each active story/galley view. Set the display order of the stories in the galley or story views. Unlike calling InitializeLines this does not cause any recomposition. Use is restricted to re-arranging existing stories that already exist in the view. That is stories may not be added or deleted from the view with this method.
- Precondition
- stories must already exist in the view
- Parameters
| storiesInDisplayOrder | IN list of text model uids in the order they should be display in the view. |
| redraw | IN should the view be invaled after rearranging the stories (default is true that it should be invaled) |
- Precondition
- the stories in the storiesInDisplayOrder must already exist in the view otherwise the caller should call InitializeLines in ITextLines to add them first.
| virtual bool16 IStoryManager::StoryHasPsuedoLines | ( | int32 | storyIndex | ) | |
| pure virtual |
A psuedo line is created as a temporary line before lines are really composed. This routine reports if there are any psuedo lines in a specific story
- Parameters
| storyIndex | to check if it has psuedo lines. |
| virtual void IStoryManager::SyncStoriesToManaged | ( | | ) | |
| pure virtual |
Sync view stories to the incopystorylist.
Public Member Functions inherited from IPMUnknown
1.8.3.1 
