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

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