diff options
Diffstat (limited to 'offapi/com/sun/star/document/XUndoManager.idl')
| -rwxr-xr-x | offapi/com/sun/star/document/XUndoManager.idl | 44 |
1 files changed, 21 insertions, 23 deletions
diff --git a/offapi/com/sun/star/document/XUndoManager.idl b/offapi/com/sun/star/document/XUndoManager.idl index c30049fc520d..1c8b29083f94 100755 --- a/offapi/com/sun/star/document/XUndoManager.idl +++ b/offapi/com/sun/star/document/XUndoManager.idl @@ -44,7 +44,7 @@ interface XUndoManagerListener; <h3>Undo</h3> <p>Changes to a document usually result in recording of information how to undo those changes, if desired. A so-called - Undo action records the information how to undo a single change. Undo actions are maintained in a stack, so that + undo action records the information how to undo a single change. Undo actions are maintained in a stack, so that the changes they represent can be undo in the reverse order they have originally been applied.</p> <h3>Redo</h3> @@ -52,15 +52,15 @@ interface XUndoManagerListener; stack, so it is possible to re-apply the changes to the document.</p> <h3>Undo contexts</h3> - <p>For collecting multiple changes in a single Undo action, so-called Undo contexts are provided. When an Undo - context is entered, all subsequently added Undo actions are not pushed onto the Undo stack directly, but considered - a sub action of the Undo context. Once the Undo context is left, a single Undo action is pushed onto the Undo stack, + <p>For collecting multiple changes in a single undo action, so-called Undo contexts are provided. When an Undo + context is entered, all subsequently added Undo actions are not pushed onto the undo stack directly, but considered + a sub action of the Undo context. Once the Undo context is left, a single undo action is pushed onto the undo stack, which comprises all those single Undo actions.<br/> Undo contexts can be arbitrarily nested.</p> <h3>Hidden Undo actions</h3> - <p>Hidden Undo actions are those which in no observable way contribute to the Undo stack. That is, - any method retrieving information about the stack will behave as if the Undo action does not exist. Nonetheless, + <p>Hidden Undo actions are those which in no observable way contribute to the undo stack. That is, + any method retrieving information about the stack will behave as if the undo action does not exist. Nonetheless, calling <member>undo</member> respectively <member>redo</member> will include those actions.<br/> Hidden Undo actions can be created by calling <member>enterHiddenUndoContext</member>, following by <member>leaveUndoContext</member>.</p> @@ -68,7 +68,7 @@ interface XUndoManagerListener; <a name="locking"></a> <h3>Locking</h3> <p>An Undo manager can be locked and unlocked, using the <member>lock</member> and <member>unlock</member> methods. - When it is locked, then every attempt to add an Undo action, or to enter or leave an Undo context, will be silently + When it is locked, then every attempt to add an undo action, or to enter or leave an Undo context, will be silently ignored.</p> */ interface XUndoManager @@ -94,11 +94,11 @@ interface XUndoManager [in] string i_title ); - /** enters a new undo context, creating a hidden Undo action. + /** enters a new undo context, creating a hidden undo action. - <p>A hidden Undo action does not, in any visible way, contribute to the Undo stack. This means + <p>A hidden undo action does not, in any visible way, contribute to the undo stack. This means that - <ul><li>Calling <member>undo</member> when the top-element is a hidden Undo action will transparently + <ul><li>Calling <member>undo</member> when the top-element is a hidden undo action will transparently undo this action, and also undo the new top element of the stack.</li> <li>Calling <member>redo</member> when the top-element is a hidden action will transparently redo this action, and also redo the new top element of the stack.</li> @@ -119,7 +119,7 @@ interface XUndoManager <p>The redo stack is cleared when a new hidden Undo context is entered.</p> @throws ::com::sun::star::util::InvalidStateException - if the Undo stack is currently empty, in which case it is impossible to push a hidden Undo action onto + if the undo stack is currently empty, in which case it is impossible to push a hidden undo action onto it. @see emterUndoContext @@ -131,10 +131,10 @@ interface XUndoManager /** leaves the undo context previously opened via <member>enterUndoContext</member> respectively <member>enterHiddenUndoContext</member>. - <p>If no Undo action has been added since the context has been opened, the context is not only left, - but silently removed, and does not contribute to the Undo stack at all. In this case, possible - listeners will be notified via <member>XUndoManagerListener::cancelledUndoContext</member>, - instead of <member>XUndoManagerListener::leftUndoContext</member>.</p> + <p>If no undo action has been added since the context has been opened, the context is not only left, + but silently removed, and does not contribute to the undo stack at all. In this case, possible + listeners will be notified via <member>XUndoManagerListener::cancelledContext</member>, + instead of <member>XUndoManagerListener::leftContext</member>.</p> @throws ::com::sun::star::util::InvalidStateException if no undo context is currently open. @@ -154,7 +154,7 @@ interface XUndoManager <member>clearRedo</member>), it will be disposed, as long as it supports the <member scope="com::sun::star::lang">XComponent</member> interface.</p> - <p>If the Undo manager is <a href="#locking">locked</a> at the moment the method is called, the call will be ignored, and the Undo action + <p>If the Undo manager is <a href="#locking">locked</a> at the moment the method is called, the call will be ignored, and the undo action will immediately be disposed, if applicable.</p> @throws ::com::sun::star::lang::IllegalArgumentException @@ -173,10 +173,8 @@ interface XUndoManager <li>move this undo action from the undo stack to the redo stack</li> </ul></p> - <p>If one or more undo contexts are currently open, those will be implicit - @throws ::com::sun::star::util::InvalidStateException - when the Undo stack is currently empty + when the undo stack is currently empty @throws ::com::sun::star::lang::WrappedTargetException if the invocation of <member>XUndoAction::undo</member> raises an exception other than a <member scope="com::sun::star::uno">RuntimeException</member> @@ -207,7 +205,7 @@ interface XUndoManager raises( ::com::sun::star::util::InvalidStateException, ::com::sun::star::lang::WrappedTargetException ); - /** determines whether the Undo stack is currently non-empty. + /** determines whether the undo stack is currently non-empty. */ boolean isUndoPossible(); @@ -215,10 +213,10 @@ interface XUndoManager */ boolean isRedoPossible(); - /** returns the title of the top-most action on the Undo stack + /** returns the title of the top-most action on the undo stack @throws ::com::sun::star::util::InvalidStateException - when the Undo stack is currently empty + when the undo stack is currently empty @see XUndoAction::Title */ @@ -234,7 +232,7 @@ interface XUndoManager string getCurrentRedoActionTitle() raises( ::com::sun::star::util::InvalidStateException ); - /** returns the titles of all actions currently on the Undo stack, from top to bottom + /** returns the titles of all actions currently on the undo stack, from top to bottom @see XUndoAction::Title */ sequence< string > |