#include <ITrackChangeSuite.h>
|
| enum | { kDefaultIID = IID_ITRACKCHANGESUITE } |
| |
ITrackChangeSuite
This is a suite for getting a setting track changes settings.
| virtual bool16 ITrackChangeSuite::Accept | ( | | ) | |
| pure virtual |
Accept the selected change(s)
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::AcceptAll | ( | | ) | |
| pure virtual |
Accept all changes in the active story
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::AcceptAllByUser | ( | | ) | |
| pure virtual |
Accept all changes by the user of the active change in the active story
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::AcceptAllStories | ( | | ) | |
| pure virtual |
Accept all changes in all the stories in the document
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::AcceptAllStoriesByUser | ( | | ) | |
| pure virtual |
Accept all changes in all the stories by the user of the active change in the document
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::AcceptAndNext | ( | | ) | |
| pure virtual |
Accept the selected change(s) and go to next change
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::CanAccept | ( | | ) | const |
| pure virtual |
Can accept the change(s) if story is unlocked and user has permissions (see ITrackChangesSettings.h)
- Parameters
- Returns
- bool16
| virtual bool16 ITrackChangeSuite::CanReject | ( | | ) | const |
| pure virtual |
Can reject the change(s) if story is unlocked and user has permissions (see ITrackChangesSettings.h)
- Parameters
- Returns
- bool16
| virtual bool16 ITrackChangeSuite::DeletedTextSelectionToPrimaryIndex | ( | bool16 | onlyWhenDeletedTextIsHidden = kTrue | ) | |
| pure virtual |
Moves the deleted text selection (if any) to that deletion's anchor index in the primary story - caller can specify if selection should be moved only when deleted text is hidden.
- Parameters
| onlyWhenDeletedTextIsHidden | kTrue to prevent moving selection when deletes are showing |
- Returns
- bool16 indicating if action was taken
| virtual bool16 ITrackChangeSuite::FindNextChange | ( | RedlineIterator * | iterator | ) | |
| pure virtual |
Finds the next track change (if any) given a redline iterator (this iterates change objects, a track change may be represented by one or more change objects which this util takes into account) and positions the iterator at the next track change (if any). It does not consider the change type visibility.
- Parameters
| redline | iterator; positioned at next change (if any) upon return to caller |
- Returns
- bool16 indicating if there is next change
Finds the next track change in the story (if any) given a redline iterator (this iterates change objects, a track change may be represented by one or more change objects which this util takes into account) and positions the iterator at the next track change (if any). It does not consider the change type visibility.
- Parameters
| redline | iterator; positioned at next change (if any) upon return to caller |
| model | story to find the next change |
| range | the range to start looking for next change |
- Returns
- bool16 indicating if there is next change
| virtual bool16 ITrackChangeSuite::FindPreviousChange | ( | RedlineIterator * | iterator | ) | |
| pure virtual |
Finds the previous track change (if any) given a redline iterator (this iterates change objects, a track change may be represented by one or more change objects which this util takes into account) and positions the iterator at the previous track change (if any). It does not consider the change type visibility.
- Parameters
| redline | iterator; positioned at previous change (if any) upon return to caller |
- Returns
- bool16 indicating if there is previous change
| virtual bool16 ITrackChangeSuite::GotoNextChange | ( | | ) | |
| pure virtual |
Scroll to (if necessary) and hilite the next change
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::GotoPreviousChange | ( | | ) | |
| pure virtual |
Scroll to (if necessary) and hilite the previous change
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::Reject | ( | | ) | |
| pure virtual |
Reject the selected change(s)
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::RejectAll | ( | | ) | |
| pure virtual |
Reject all changes in the active story
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::RejectAllByUser | ( | | ) | |
| pure virtual |
Reject all changes by the user of the active change in the active story
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::RejectAllStories | ( | | ) | |
| pure virtual |
Reject all changes in all the stories in the document
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::RejectAllStoriesByUser | ( | | ) | |
| pure virtual |
Reject all changes in all the stories by the user of the active change in the document
- Parameters
- Returns
- bool16 indicating if action was handled or not
| virtual bool16 ITrackChangeSuite::RejectAndNext | ( | | ) | |
| pure virtual |
Reject the selected change(s) and go to next change
- Parameters
- Returns
- bool16 indicating if action was handled or not