#94968# IDL reviews merged

1 files changed, 49 insertions, 45 deletions

diff --git a/offapi/com/sun/star/sheet/XSheetOutline.idl b/offapi/com/sun/star/sheet/XSheetOutline.idl
index bd34c3669266..08320c9cd6c4 100644
--- a/offapi/com/sun/star/sheet/XSheetOutline.idl
+++ b/offapi/com/sun/star/sheet/XSheetOutline.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XSheetOutline.idl,v $
  *
- *  $Revision: 1.4 $
+ *  $Revision: 1.5 $
  *
- *  last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $
+ *  last change: $Author: mi $ $Date: 2002-10-03 13:08:27 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -58,6 +58,7 @@
  *
  *
  ************************************************************************/
+
 #ifndef __com_sun_star_sheet_XSheetOutline_idl__
 #define __com_sun_star_sheet_XSheetOutline_idl__
 
@@ -73,74 +74,96 @@
 #include <com/sun/star/table/TableOrientation.idl>
 #endif
 
-
 //=============================================================================
 
- module com {  module sun {  module star {  module sheet {
+module com {  module sun {  module star {  module sheet {
 
 //=============================================================================
 
-// DocMerge from xml: interface com::sun::star::sheet::XSheetOutline
-/** represents outlining functions of a sheet.
+/** provides methods to access the outlines of a sheet.
  */
 interface XSheetOutline: com::sun::star::uno::XInterface
 {
     //-------------------------------------------------------------------------
 
-    // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::group
     /** creates an outline group.
+
+        @param aRange
+            contains the range of rows or columns, depending on
+            the parameter nOrientation.
+
+        @param nOrientation
+            the orientation of the new outline (columns or rows).
      */
-    void group( [in] com::sun::star::table::CellRangeAddress aRange,
-             [in] com::sun::star::table::TableOrientation nOrientation );
+    void group(
+            [in] com::sun::star::table::CellRangeAddress aRange,
+            [in] com::sun::star::table::TableOrientation nOrientation );
 
     //-------------------------------------------------------------------------
 
-    // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::ungroup
     /** removes outline groups.
 
+        <p>In the specified range, all outline groups on the innermost
+        level are removed.</p>
 
+        @param aRange
+            contains the range of rows or columns, depending on
+            the parameter nOrientation.
 
-        <p>In the specified range, all outline groups on the innermost level
-        are removed.</p>
+        @param nOrientation
+            the orientation of the outlines to remove (columns or rows).
      */
-    void ungroup( [in] com::sun::star::table::CellRangeAddress aRange,
-             [in] com::sun::star::table::TableOrientation nOrientation );
+    void ungroup(
+            [in] com::sun::star::table::CellRangeAddress aRange,
+            [in] com::sun::star::table::TableOrientation nOrientation );
 
     //-------------------------------------------------------------------------
 
-    // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::autoOutline
     /** creates outline groups from formula references in a range.
+
+        @param aRange
+            the cell range for which outlines are generated.
      */
     void autoOutline( [in] com::sun::star::table::CellRangeAddress aRange );
 
     //-------------------------------------------------------------------------
 
-    // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::clearOutline
-    /** removes all outline groups on the sheet.
+    /** removes all outline groups from the sheet.
      */
     void clearOutline();
 
     //-------------------------------------------------------------------------
 
-    // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::hideDetail
-    /** hides an outline group.
+    /** collapses an outline group.
+
+        @param aRange
+            the cell range for which the outlines are collapsed.
      */
     void hideDetail( [in] com::sun::star::table::CellRangeAddress aRange );
 
     //-------------------------------------------------------------------------
 
-    // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::showDetail
-    /** shows an outline group.
+    /** reopens an outline group.
+
+        @param aRange
+            the cell range for which the outlines are reopened.
      */
     void showDetail( [in] com::sun::star::table::CellRangeAddress aRange );
 
     //-------------------------------------------------------------------------
 
-    // DocMerge from xml: method com::sun::star::sheet::XSheetOutline::showLevel
-    /** shows all outlined groups below a specified level.
+    /** shows all outlined groups below a specific level.
+
+        @param nLevel
+            all outline levels from 1 to this value will be opened and
+            the higher levels will be closed.
+
+        @param nOrientation
+            the orientation of the outlines (columns or rows).
      */
-    void showLevel( [in] short nLevel,
-             [in] com::sun::star::table::TableOrientation nOrientation );
+    void showLevel(
+            [in] short nLevel,
+            [in] com::sun::star::table::TableOrientation nOrientation );
 
 };
 
@@ -148,24 +171,5 @@ interface XSheetOutline: com::sun::star::uno::XInterface
 
 }; }; }; };
 
-/*=============================================================================
-
-    $Log: not supported by cvs2svn $
-    Revision 1.3  2000/11/08 12:43:47  mi
-    moved from api
-
-    Revision 1.1.1.1  2000/09/18 23:35:52  hjs
-    initial import
-
-    Revision 1.4  2000/09/11 11:52:52  mi
-    documentation merged from XML
-
-    Revision 1.2  2000/02/07 11:24:56  mi
-    zu #70728# missing documentation marked
-
-    Revision 1.1.1.1  1999/11/11 09:48:45  jsc
-    new
-
-
-=============================================================================*/
 #endif
+