offapi/com/sun/star/table/TableColumn.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
  28 #ifndef __com_sun_star_table_TableColumn_idl__
  29 #define __com_sun_star_table_TableColumn_idl__
  30
  31 #ifndef __com_sun_star_table_XCellRange_idl__
  32 #include <com/sun/star/table/XCellRange.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_beans_XPropertySet_idl__
  36 #include <com/sun/star/beans/XPropertySet.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_container_XNamed_idl__
  40 #include <com/sun/star/container/XNamed.idl>
  41 #endif
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module table {
  46
  47 //=============================================================================
  48
  49 /** represents a special cell range containing all cells of a single
  50     specific column in a table or spreadsheet.
  51  */
  52 published service TableColumn
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** provides access to the cells of this column.
  57
  58         @see com::sun::star::table::CellRange
  59      */
  60     interface com::sun::star::table::XCellRange;
  61
  62     //-------------------------------------------------------------------------
  63
  64 //!published service PropertySet
  65     /** provides access to the cell properties of all cells of this column.
  66      */
  67     interface com::sun::star::beans::XPropertySet;
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** provides methods to access the name of the column.
  72
  73         <p>In spreadsheets, the name of a column cannot be changed.<p/>
  74      */
  75     interface com::sun::star::container::XNamed;
  76
  77     //=========================================================================
  78
  79     /** contains the width of the column (in 1/100th mm).
  80
  81         <p>When hidden, it returns the width which the column would have,
  82         if it were visible. </p>
  83      */
  84     [property] long Width;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** is <TRUE/>, if the column always keeps its optimal width.
  89      */
  90     [property] boolean OptimalWidth;
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** is <TRUE/>, if the column is visible.
  95      */
  96     [property] boolean IsVisible;
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** is <TRUE/>, if there is a manual horizontal page break attached
 101         to the column.
 102      */
 103     [property] boolean IsStartOfNewPage;
 104
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 #endif
 112