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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module text {
  23
  24 /** manages columns within the object.
  25
  26
  27
  28     <p>The values used are relative. So it is not necessary to know the
  29     width of the object. The sum of the relative width values depends on
  30     the object and is defined in "ReferenceValue."
  31
  32     </p>
  33  */
  34 published interface XTextColumns: com::sun::star::uno::XInterface
  35 {
  36     /** @returns
  37                 the sum of all values.
  38
  39                 <p>As described above, the width values are relative.
  40      */
  41     long getReferenceValue();
  42
  43     /** @returns
  44                 the number of columns.
  45      */
  46     short getColumnCount();
  47
  48     /** sets the number of columns.
  49
  50
  51
  52         <p>The minimum is 1 column.</p>
  53      */
  54     void setColumnCount( [in] short nColumns );
  55
  56     /** returns the column description of the object.
  57                 @see TextColumn
  58      */
  59     sequence<com::sun::star::text::TextColumn> getColumns();
  60
  61     /** sets the descriptors of all columns.
  62
  63
  64
  65         <p>The number of members in the sequence must be the same as the
  66         number of columns of the object.
  67
  68         </p>@see TextColumn
  69      */
  70     void setColumns( [in] sequence<com::sun::star::text::TextColumn> Columns );
  71
  72 };
  73
  74
  75 }; }; }; };
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */