From b28ad987327d89ec393168d68d044be0405081c3 Mon Sep 17 00:00:00 2001
From: "Frank Schoenheit [fs]" <frank.schoenheit@sun.com>
Date: Mon, 25 Oct 2010 13:53:25 +0200
Subject: undoapi: renamings, API docs

---
 offapi/com/sun/star/document/UndoManagerEvent.idl  |  2 +-
 offapi/com/sun/star/document/XUndoManager.idl      | 44 +++++++++++-----------
 .../com/sun/star/document/XUndoManagerListener.idl | 28 +++++++-------
 3 files changed, 36 insertions(+), 38 deletions(-)

(limited to 'offapi/com/sun/star/document')

diff --git a/offapi/com/sun/star/document/UndoManagerEvent.idl b/offapi/com/sun/star/document/UndoManagerEvent.idl
index a95c0707ba33..e587669e4fbd 100755
--- a/offapi/com/sun/star/document/UndoManagerEvent.idl
+++ b/offapi/com/sun/star/document/UndoManagerEvent.idl
@@ -43,7 +43,7 @@ module com { module sun { module star { module document {
  */
 struct UndoManagerEvent : ::com::sun::star::lang::EventObject
 {
-    /** the title of the Undo action which is described by the event
+    /** the title of the undo action which is described by the event
         @see XUndoAction::Title
     */
     string  UndoActionTitle;
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 >
diff --git a/offapi/com/sun/star/document/XUndoManagerListener.idl b/offapi/com/sun/star/document/XUndoManagerListener.idl
index 4917bd83d645..e08846035087 100755
--- a/offapi/com/sun/star/document/XUndoManagerListener.idl
+++ b/offapi/com/sun/star/document/XUndoManagerListener.idl
@@ -42,7 +42,7 @@ module com { module sun { module star { module document {
  */
 interface XUndoManagerListener : ::com::sun::star::lang::XEventListener
 {
-    /** is called when an Undo action is added to the Undo stack.
+    /** is called when an undo action is added to the undo stack.
 
         <p>Note that the action must not necessarily be the new top element of the stack: In case there's an
         open Undo context, <member>UndoManagerEvent::UndoContextDepth</member> will be greater <code>0</code>,
@@ -52,13 +52,13 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener
     */
     void    undoActionAdded( [in] UndoManagerEvent i_event );
 
-    /** is called when the top-most action of the Undo stack has been undone.
+    /** is called when the top-most action of the undo stack has been undone.
 
         @see XUndoManager::undo
     */
     void    actionUndone( [in] UndoManagerEvent i_event );
 
-    /** is called when the top-most action of the Redo stack has been redone.
+    /** is called when the top-most action of the Redo stack has been re-applied.
 
         @see XUndoManager::redo
     */
@@ -84,7 +84,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener
 
         @see XUndoManager::enterUndoContext
     */
-    void    enteredUndoContext( [in] UndoManagerEvent i_event );
+    void    enteredContext( [in] UndoManagerEvent i_event );
 
     /** is called when a new hidden Undo context has been entered.
 
@@ -94,7 +94,7 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener
 
         @see XUndoManager::enterUndoContext
     */
-    void    enteredHiddenUndoContext( [in] UndoManagerEvent i_event );
+    void    enteredHiddenContext( [in] UndoManagerEvent i_event );
 
     /** is called when an Undo context has been left.
 
@@ -104,9 +104,9 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener
 
         @see XUndoManager::leaveUndoContext
         @see leftHiddenUndocontext
-        @see cancelledUndoContext
+        @see cancelledContext
     */
-    void    leftUndoContext( [in] UndoManagerEvent i_event );
+    void    leftContext( [in] UndoManagerEvent i_event );
 
     /** is calledn when a hidden Undo context has been left.
 
@@ -114,21 +114,21 @@ interface XUndoManagerListener : ::com::sun::star::lang::XEventListener
         a title.</p>
 
         @see XUndoManager::leaveHiddenUndoContext
-        @see leftUndoContext
-        @see cancelledUndoContext
+        @see leftContext
+        @see cancelledContext
     */
-    void    leftHiddenUndoContext( [in] UndoManagerEvent i_event );
+    void    leftHiddenContext( [in] UndoManagerEvent i_event );
 
     /** is called when an Undo context has been left, but no actions have been added within this context.
 
-        <p>In such a case, the context which has just been left will not contribute to the Undo stack, but instead
+        <p>In such a case, the context which has just been left will not contribute to the undo stack, but instead
         be silently removed.</p>
 
         @see XUndoManager::leaveUndoContext
-        @see leftUndoContext
-        @see leftHiddenUndocontext
+        @see leftContext
+        @see leftHiddenContext
     */
-    void    cancelledUndoContext( [in] UndoManagerEvent i_event );
+    void    cancelledContext( [in] UndoManagerEvent i_event );
 };
 
 //==================================================================================================================
-- 
cgit