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