offapi/com/sun/star/text/XTextColumns.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XTextColumns_idl__
  28 #define __com_sun_star_text_XTextColumns_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_text_TextColumn_idl__
  35 #include <com/sun/star/text/TextColumn.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module text {
  42
  43 //=============================================================================
  44
  45 // DocMerge from xml: interface com::sun::star::text::XTextColumns
  46 /** manages columns within the object.
  47
  48
  49
  50     <p>The values used are relative. So it is not necessary to know the
  51     width of the object. The sum of the relative width values depends on
  52     the object and is defined in "ReferenceValue."
  53
  54     </p>
  55  */
  56 published interface XTextColumns: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     // DocMerge from idl: method com::sun::star::text::XTextColumns::getReferenceValue
  61     /** @returns
  62                 the sum of all values.
  63
  64                 <p>As described above, the width values are relative.
  65      */
  66     long getReferenceValue();
  67
  68     //-------------------------------------------------------------------------
  69
  70     // DocMerge from idl: method com::sun::star::text::XTextColumns::getColumnCount
  71     /** @returns
  72                 the number of columns.
  73      */
  74     short getColumnCount();
  75
  76     //-------------------------------------------------------------------------
  77
  78     // DocMerge from xml: method com::sun::star::text::XTextColumns::setColumnCount
  79     /** sets the number of columns.
  80
  81
  82
  83         <p>The minimum is 1 column.</p>
  84      */
  85     void setColumnCount( [in] short nColumns );
  86
  87     //-------------------------------------------------------------------------
  88
  89     // DocMerge from idl: method com::sun::star::text::XTextColumns::getColumns
  90     /** returns the column description of the object.
  91                 @see TextColumn
  92      */
  93     sequence<com::sun::star::text::TextColumn> getColumns();
  94
  95     //-------------------------------------------------------------------------
  96
  97     // DocMerge from xml: method com::sun::star::text::XTextColumns::setColumns
  98     /** sets the descriptors of all columns.
  99
 100
 101
 102         <p>The number of members in the sequence must be the same as the
 103         number of columns of the object.
 104
 105         </p>@see TextColumn
 106      */
 107     void setColumns( [in] sequence<com::sun::star::text::TextColumn> Columns );
 108
 109 };
 110
 111 //=============================================================================
 112
 113 }; }; }; };
 114
 115 #endif