offapi/com/sun/star/awt/grid/XGridColumnModel.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: XListBox.idl,v $
  10  * $Revision: 1.8 $
  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_awt_grid_XGridColumnModel_idl__
  31 #define __com_sun_star_awt_grid_XGridColumnModel_idl__
  32
  33 #include <com/sun/star/uno/XInterface.idl>
  34
  35 #include <com/sun/star/awt/grid/XGridColumn.idl>
  36 #include <com/sun/star/awt/grid/XGridColumnListener.idl>
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module awt { module grid {
  41
  42 //=============================================================================
  43
  44 /** An instance of this interface is used by the <type>UnoControlGrid</type> to
  45     retrieve the column structure that is displayed in the actual control.
  46
  47     If you do not need your own model implementation, you can also use the <type>DefaultGridColumnModel</type>.
  48 */
  49 interface XGridColumnModel: com::sun::star::uno::XInterface
  50 {
  51     /** Specifies whether column selection is allowed
  52     */
  53     [attribute] boolean ColumnSelectionAllowed;
  54
  55     /** Returns the number of columns.
  56         @returns
  57                 the number of columns.
  58     */
  59     long getColumnCount();
  60
  61     /** Adds a column to the model.
  62         @param column
  63             the column to add to the model.
  64
  65         @returns
  66                 the index of new created column.
  67     */
  68     long addColumn( [in] XGridColumn column );
  69
  70     /*
  71     long getSelectedCount();
  72
  73     sequence<XGridColumn> getSelectedColumns();
  74
  75     sequence<long> getSelectedIndex();
  76
  77     */
  78
  79     /** Returns all columns of the model.
  80         @returns
  81                  all columns associated with the model in a sequence of <type>XGridColumn</type>.
  82     */
  83     sequence<XGridColumn> getColumns();
  84
  85     /** Returns a specific column.
  86         @param index
  87                 the position of the reuquested column.
  88         @returns
  89                  the requested column.
  90     */
  91     XGridColumn getColumn( [in] long index);
  92
  93     /*
  94     long getTotalColumnWidth();
  95     */
  96
  97     /** Adds a listener for the <type>GridColumnEvent</type> posted after the grid changes.
  98         @param Listener
  99             the listener to add.
 100     */
 101     [oneway] void addColumnListener( [in] XGridColumnListener  listener);
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** Removes a listener previously added with <method>addColumnListener()</method>.
 106         @param Listener
 107             the listener to remove.
 108     */
 109     [oneway] void removeColumnListener( [in] XGridColumnListener listener);
 110 };
 111
 112 //=============================================================================
 113
 114 }; }; }; }; };
 115
 116 #endif